@gilbarbara/types

 

Reusable typescript typings.

Setup

``sh
npm i @gilbarbara/types
`

For convenience, the type-fest package is re-exported.

Types

$3

`typescript
type NumberOrNull = number | null;
type StringOrNull = string | null;
type StringOrNumber = string | number;

type PlainObject = Record;

type GenericFunction = (...arguments_: any[]) => T;
type VoidFunction = () => void;
`

$3

`typescript
type AsyncStatus = 'IDLE' | 'PENDING' | 'SUCCESS' | 'ERROR';

interface AsyncFlow {
message: string;
status: AsyncStatus;
}

interface AsyncFlowWithCache extends AsyncFlow {
updatedAt: number;
}

interface AsyncFlowWithData extends AsyncFlow {
data: T;
}

interface AsyncFlowWithDataAndCache extends AsyncFlowWithData {
updatedAt: number;
}

type HttpMethods =
| 'CONNECT'
| 'DELETE'
| 'GET'
| 'HEAD'
| 'OPTIONS'
| 'PATCH'
| 'POST'
| 'PUT';

interface IdName {
id: string;
name: string;
}

interface LabelValue {
label: string;
value: string;
}
`

$3

`typescript
/**
* Narrow down a Record to a plain object.
*/
type NarrowPlainObject> = Exclude<
T,
Array | Function | Map | Set
>;
`

`typescript
/**
* An object without excluded types.
*/
type RemoveType = {
[Key in keyof TObject as TObject[Key] extends TExclude ? never : Key]: TObject[Key];
};
`

`typescript
/**
* A strict plain object with a specific set of keys.
*/
type StrictObject, TExpected> = TExpected & {
[Key in keyof TObject]: Key extends keyof TExpected ? TExpected[Key] : never;
};
``