@alttiri/util-js

util-js

Some JavaScript util functions.

Mostly it's a draft version for personal use.

declare function sleep(ms?: number): Promise<void>;

declare function dateToDayDateString(dateValue?: Date | string | number, utc?: boolean): string;

declare function dateToDayDateTimeString(dateValue?: Date | string | number, utc?: boolean): string;

declare function formatDate(dateValue?: Date | string | number, pattern?: string, utc?: boolean): string;

declare function formatSizeWinLike(bytes: number): string; // aka `bytesToSizeWinLike`

declare class Semaphore {
  constructor(max: number);
  acquire(): Promise<void>;
  release(): void;
}

declare class CountLatch {
  constructor(count?);
  countDown(): void;
  countUp(): void;
  then(resolve: VoidFunc, reject: VoidFunc): Promise<void>
}

Installation

From NPM

npm install @alttiri/util-js

From GitHub repository

npm install git+https://github.com/alttiri/util-js.git

More ways

From GitHub repository (a specific version):

• Based on SemVer:

  npm install git+https://github.com/alttiri/util-js.git#semver:1.3.0
  

  Or add

  "@alttiri/util-js": "github:alttiri/util-js#semver:1.3.0"
  

  as dependencies in package.json file.

  See available tags.

• Based on a commit hash:

  npm install git+https://github.com/alttiri/util-js.git#eea3068f8c70c6a500a44b69aeb0cb65ac8b80a6
  

  Or add

  "@alttiri/util-js": "github:alttiri/util-js#eea3068f8c70c6a500a44b69aeb0cb65ac8b80a6"
  

  as dependencies in package.json file.

  See available commits hashes.

From GitHub Packages:

To install you need first to create .npmrc file with @alttiri:registry=https://npm.pkg.github.com content:

echo @alttiri:registry=https://npm.pkg.github.com >> .npmrc

only then run

npm install @alttiri/util-node-js

Note, that GitHub Packages requires to have also ~/.npmrc file (.npmrc in your home dir) with //npm.pkg.github.com/:_authToken=TOKEN content, where TOKEN is a token with the read:packages permission, take it here https://github.com/settings/tokens/new.