@eljs/utils

Collection of nodejs utility.

Installation

``bash
$ pnpm add @eljs/utils
// or
$ yarn add @eljs/utils
// or
$ npm i @eljs/utils -S
`

Usage

`ts
import utils from '@eljs/utils'
`

API

$3

#### readFile(file: string, encoding?: BufferEncoding): Promise

Read a single file content asynchronously.

#### readFileSync(file: string, encoding?: BufferEncoding): string

Read a single file content synchronously.

#### readJson(file: string): Promise

Read a single json file asynchronously.

#### readJsonSync(file: string): T

Read a single json file synchronously.

#### writeFile(file: string, content: string, encoding?: BufferEncoding): Promise

Write content to a single file asynchronously.

#### writeFileSync(file: string, content: string, encoding?: BufferEncoding): void

Write content to a single file synchronously.

#### safeWriteFile(file: string, content: string, encoding?: BufferEncoding): Promise

Safe write content to a single file asynchronously.

#### safeWriteFileSync(file: string, content: string, encoding?: BufferEncoding): void

Safe write content to a single file synchronously.

#### writeJsonFile(file: string, content: string): Promise

Write json to a single file asynchronously.

#### writeJsonFileSync(file: string, content: string): void

Write json to a single file synchronously.

#### safeWriteJson(file: string, content: string): Promise

Safe write json to a single file asynchronously.

#### safeWriteJsonSync(file: string, content: string): void

Safe write json to a single file synchronously.

$3

Copy a file asynchronously.

$3

Copy a file synchronously.

$3

Copy a template asynchronously.

$3

Copy a template synchronously.

$3

Copy a directory asynchronously.

$3

Copy a directory synchronously.

$3

Move a directory or file asynchronously.

$3

Move a directory or file synchronously.

$3

Remove directory or file asynchronously.

$3

Remove directory or file synchronously.

$3

Create a directory asynchronously.

$3

Create a directory synchronously.

$3

$3

Create a temporary directory asynchronously.

$3

$3

Create a temporary directory synchronously.

$3

Whether the path is file asynchronously.

$3

Whether the path is file synchronously.

$3

Whether the path is directory asynchronously.

$3

Whether the path is directory synchronously.

$3

Whether the file is symlink asynchronously.

$3

Whether the file is symlink synchronously.

$3

Whether the path is exist asynchronously.

$3

Whether the path is exist synchronously.

$3

Load js file asynchronously.

$3

Load js file synchronously.

$3

Load ts file asynchronously.

$3

Load ts file synchronously.

$3

Load yaml file asynchronously.

$3

Load yaml file synchronously.

$3

Render template file.

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

Logger in different level。

$3

Clear the stdout.

ChildProcess

$3

Parse string command to arguments.

$3

$3

$3

Run shell command.

$3

Find executable command.

$3

Normalize the command arguments.

$3

Get the process id.

$3

#### deferred.promise: Promise

Waiting promise.

#### deferred.resolve: (value: T | PromiseLike) => void

Resolve the promise.

#### deferred.reject: (err: unknown) => void`

Reject the promise.

$3

Retrying a task.

$3

Retrying a task until value is not null.

$3

Sleep for specified milliseconds.

$3

Throw error when timeout.

String

$3

Convert to camelCase.

$3

Convert to pascalCase.

$3

Convert to kebabCase.

$3

Strip the blank lines.

Type

$3

Whether the target is promise.

$3

Whether the target is generator function.

$3

Whether the target is async function.

$3

Whether the target is es module.