claritype

1.0.1 • Public • Published

It's not always clear what does number or string type mean.

Let's imagine you are describing setTimeout

declare function setTimeout(handler: TimerHandler, timeout?: number, ...arguments: any[]): number;

In't not clear what number to pass in timeout. Let's refactor it

type Milliseconds = number;
declare function setTimeout(handler: TimerHandler, timeout?: Milliseconds, ...arguments: any[]): number;

Now it's much more clear, and user will see hints when typing this function in IDE.

So this library is just a set of such aliases. For now it contains

export type Milliseconds = number;
export type Seconds = number;
export type Minutes = number;
export type Hours = number;
export type Days = number;
export type Months = number;
export type Years = number;
export type Centuries = number;

So use it to clarify your inputs!

Readme

Keywords

Package Sidebar

Install

npm i claritype

Weekly Downloads

0

Version

1.0.1

License

ISC

Unpacked Size

1.69 kB

Total Files

3

Last publish

Collaborators

  • dilame