zeelib

Node utility library.

Usage

zeelib is a collection of utility functions. Think Lodash, but for Node. See the docs for details.

Example usage:

import * as z from 'zeelib'

if (!module.parent) {
  z.termPrompt('do the thing?')
    .then((yes) => {
      if (yes) {
        console.log(z.colorize.blue('said yes!'))
      }
    })
}

If you're using Node require, you'll need to access default:

const zeelib = require('zeelib')

zeelib.getArgs.default()

Index

Type aliases

Variables

Functions

Type aliases

NodeError

NodeError: object & Error

Res

Res: object

Type declaration

address: string
family: number

Variables

Const SEPARATOR

SEPARATOR: ";" | ":" = process.platform === 'win32' ? ';' : ':'

Const env

env: ProcessEnv = (typeof process !== 'undefined' && process.env) || {}

Const file

file: WriteStream = createWriteStream(`${__dirname}/${fn}`, { flags: 'w' })

Const fn

fn: string = process.argv[2] || process.env.ERR_FILE || 'err.log'

Functions

Const atob

atob(str: string): string

- Defined in atob.ts:7
window.atob for node and browser

Parameters
- str: string
Returns string

Const average

average(xs: number[]): number

- Defined in get-load-average.ts:3
Parameters
- xs: number[]
Returns number

Const btoa

btoa(str: string): string

- Defined in btoa.ts:7
window.btoa for node and browser

Parameters
- str: string
Returns string

Const colorize

colorize(): __type

- Defined in colorize.ts:19
Returns __type

Const cols

cols(color: string, text: string): string

- Defined in colorize.ts:14
Basic set of fns to add colors to console output in Node.

Options:

bold, italic, underline, inverse, white, grey, black, blue, cyan, green, magenta, red, yellow

Parameters
- color: string
- text: string
Returns string

Const consoleClear

consoleClear(): void

- Defined in console-clear.ts:7
console.clear for Node and browser

Returns void

Const dir

dir(obj: any): void

- Defined in dir.ts:7
console.dir with colors by default in Node

Parameters
- obj: any
Returns void

Const execute

execute(cmd: string): void

- Defined in execute.ts:15
Like a standalone npm run that obeys npm bin

Parameters
- cmd: string
Returns void

Const fileExists

fileExists(filePath: string): boolean

- Defined in file-exists.ts:10
Returns bool based on if passed path exists

Parameters
- filePath: string
Returns boolean

Const findPort

findPort(port: number, cb: function): void

- Defined in find-port.ts:13
Find next open port

Parameters
- port: number
- cb: function
  - - (x: Error | null, y?: number): void
    - Parameters
      - x: Error | null
      - Optional y: number
      Returns void
Returns void

Const getArgs

getArgs(): string[]

- Defined in get-args.ts:7
Like Haskell's getArgs, but for Node

Returns string[]

Const getBasename

getBasename(str?: string): string

- Defined in basename.ts:9
basename for Node

Parameters
- Default value str: string = ""
Returns string

Const getFileExt

getFileExt(str: string): string

- Defined in get-file-ext.ts:9
Get the file extension for a given file

Parameters
- str: string
Returns string

Const getFreeDisk

getFreeDisk(): number

- Defined in get-free-disk.ts:9
Get free disk space

Returns number

Const getFreeMemory

getFreeMemory(): number

- Defined in get-free-memory.ts:9
Get free memory

Returns number

Const getGlobal

getGlobal(): __type

- Defined in get-global.ts:9
Gets the global for your current context.

Returns __type

Const getLoadAverage

getLoadAverage(): number

- Defined in get-load-average.ts:14
Get load average

Returns number

Const getLocalIp

getLocalIp(): Promise<string>

- Defined in get-local-ip.ts:12
Returns Promise<string>

Const getMemoryUsage

getMemoryUsage(): number

- Defined in get-memory-usage.ts:9
Get memory usage

Returns number

Const getNodeModules

getNodeModules(): string[]

- Defined in get-node-modules.ts:10
Returns array of all locally installed Node modules

Returns string[]

Const getStdin

getStdin(f: function): void

- Defined in get-stdin.ts:9
Get stdin and do something with it.

Parameters
- f: function
  - - (a: string): void
    - Parameters
      - a: string
      Returns void
Returns void

Const getTerminalColumns

getTerminalColumns(): number

- Defined in get-terminal-columns.ts:8
Get columns of current terminal

Returns number

columns

Const getTerminalRows

getTerminalRows(): number

- Defined in get-terminal-rows.ts:8
Get current terminal rows

Returns number

rows

Const getTerminalSize

getTerminalSize(): object

- Defined in get-terminal-size.ts:8
Returns size of the current terminal

Returns object

columns, rows
- columns: number
- rows: number

Const getUserHome

getUserHome(): string

- Defined in get-user-home.ts:11
Get current user's home directory

Returns string

Const getUserShell

getUserShell(): string

- Defined in get-user-shell.ts:8
Get the current user's shell, or an empty string on shell-less platforms

Returns string

Const hasColor

hasColor(): boolean

- Defined in has-color.ts:14
Returns true if the current terminal supports color

Returns boolean

Const id

id<A>(a: A): A

- Defined in id.ts:8
id

Type parameters
- A
Parameters
- a: A
Returns A

Const isColor

isColor(): boolean

- Defined in has-color.ts:3
Returns boolean

Const isDirectory

isDirectory(filePath: string): boolean

- Defined in is-directory.ts:10
Returns true if the path is a directory

Parameters
- filePath: string
Returns boolean

Const isFile

isFile(filePath: string): boolean

- Defined in is-file.ts:10
Returns true if the path is a file

Parameters
- filePath: string
Returns boolean

Const isHiddenFile

isHiddenFile(file: string): boolean

- Defined in is-hidden-file.ts:7
Parameters
- file: string
Returns boolean

Const isInstalled

isInstalled(pkgName: string): boolean

- Defined in is-installed.ts:7
Returns true if the passed node_module name is installed

Parameters
- pkgName: string
Returns boolean

Const isJson

isJson(str: string): boolean

- Defined in is-json.ts:7
Returns true if the string is valid JSON

Parameters
- str: string
Returns boolean

Const isRoot

isRoot(): boolean

- Defined in is-root.ts:7
Check if current process is running as root.

Returns boolean

Const isSymLink

isSymLink(filePath: string): boolean

- Defined in is-sym-link.ts:9
Returns true if path is a symlink

Parameters
- filePath: string
Returns boolean

Const isWin

isWin(): boolean

- Defined in has-color.ts:1
Returns boolean

Const logWithInfo

logWithInfo(str?: string): void

- Defined in log-with-info.ts:12
console.log with hostname and PID info

Parameters
- Default value str: string = ""
Returns void

Const mv

mv(oldPath: string, newPath: string, cb: function): void

- Defined in mv.ts:7
Parameters
- oldPath: string
- newPath: string
- cb: function
  - - (x?: any): any
    - Parameters
      - Optional x: any
      Returns any
Returns void

Const noop

noop(): void

- Defined in noop.ts:7
noop

Returns void

Const open

open(args: string, opts: __type, cb: Function): void

- Defined in open.ts:9
Opens things. Works on Linux, Mac, and Windows

Parameters
- args: string
- opts: __type
- cb: Function
Returns void

Const readFileSync

readFileSync(str: string): string | void

- Defined in read-file-sync.ts:11
Safe readFileSync

Parameters
- str: string
Returns string | void

Const readJson

readJson<A>(file: string, cb: function): void

- Defined in read-json.ts:9
Read json file, parse it, call cb with obj or err

Type parameters
- A
Parameters
- file: string
- cb: function
  - - (x?: Error, y?: A): void
    - Parameters
      - Optional x: Error
      - Optional y: A
      Returns void
Returns void

Const readJsonSync

readJsonSync(file: string): string

- Defined in read-json-sync.ts:9
Read and parse JSON

Parameters
- file: string
Returns string

Const removeBOM

removeBOM(content: string): string

- Defined in remove-bom.ts:10
The same as what's in Node's module (see lib/internal/module). Remove byte order marker. This catches EF BB BF (the UTF-8 BOM) because the buffer-to-string conversion in fs.readFileSync() translates it to FEFF, the UTF-16 BOM.

Parameters
- content: string
Returns string

Const removeExtension

removeExtension(s?: string): string

- Defined in remove-extension.ts:3
Parameters
- Default value s: string = ""
Returns string

Const resolveFiles

resolveFiles(ls: string[]): string[]

- Defined in resolve-files.ts:9
Resolve a list of paths

Parameters
- ls: string[]
Returns string[]

Const safeDecodeURI

safeDecodeURI(str: string): string

- Defined in safe-decode-uri.ts:7
decodeURI, but safe

Parameters
- str: string
Returns string

Const safeDecodeURIComponent

safeDecodeURIComponent(str: string): string

- Defined in safe-decode-uri-component.ts:7
decodeURIComponent, but safe

Parameters
- str: string
Returns string

Const sleep

sleep(ms: number): Promise<void>

- Defined in sleep.ts:10
Simple sleep.

You can await it, or .then it

Parameters
- ms: number
Returns Promise<void>

Const tap

tap(msg: string): (Anonymous function)

- Defined in tap.ts:8
Log a value to console, and return that value

Parameters
- msg: string
Returns (Anonymous function)

Const termPrompt

termPrompt(question: string, isYesDefault?: boolean): Promise<boolean>

- Defined in term-prompt.ts:12
Create a simple y/n prompt for the terminal

Adapted from create-react-app's prompt

Parameters
- question: string
- Default value isYesDefault: boolean = false
Returns Promise<boolean>

Const touch

touch(filePath: string, contents?: string): void

- Defined in touch.ts:11
Make a file if it doesn't exist already

Parameters
- filePath: string
- Default value contents: string = ""
Returns void

Const watchFile

watchFile(filePath: string, cb: function): void

- Defined in watch.ts:10
Watch a file for changes, and call the function

Parameters
- filePath: string
- cb: function
  - - (event: string, filename: string): void
    - Parameters
      - event: string
      - filename: string
      Returns void
Returns void

Const withInfo

withInfo(str?: string): string

- Defined in log-with-info.ts:3
Parameters
- Default value str: string = ""
Returns string

Const writeError

writeError(data: string): void

- Defined in write-error.ts:15
Use instead of console.error()

Logs to file and stdout both

Parameters
- data: string
Returns void

Const writeJson

writeJson(file: string, data: any, indent?: number | function, cb?: function): void

- Defined in write-json.ts:9
Write JSON from a stringifiable value

Parameters
- file: string
- data: any
- Default value indent: number | function = 2
- Optional cb: function
  - - (y: Error | void): void
    - Parameters
      - y: Error | void
      Returns void
Returns void

Const writeJsonSync

writeJsonSync<A>(file: string, data: A, indent?: number): void

- Defined in write-json-sync.ts:10
Write JSON from a stringifiable value, sync

Type parameters
- A
Parameters
- file: string
- data: A
- Default value indent: number = 2
Returns void

Generated using TypeDoc

zeelib

Usage

Index

Type aliases

Variables

Functions

Type aliases

NodeError

Res

Type declaration

address: string

family: number

Variables

Const SEPARATOR

Const env

Const file

Const fn

Functions

Const atob

Parameters

str: string

Returns string

Const average

Parameters

xs: number[]

Returns number

Const btoa

Parameters

str: string

Returns string

Const colorize

Returns __type

Const cols

Parameters

color: string

text: string

Returns string

Const consoleClear

Returns void

Const dir

Parameters

obj: any

Returns void

Const execute

Parameters

cmd: string

Returns void

Const fileExists

Parameters

filePath: string

Returns boolean

Const findPort

Parameters

port: number

cb: function

Parameters

x: Error | null

Optional y: number

Returns void

Returns void

Const getArgs

Returns string[]

Const getBasename

Parameters

Default value str: string = ""

Returns string

Const getFileExt

Parameters

str: string

Returns string

Const getFreeDisk

Returns number

Const getFreeMemory

Returns number

Const getGlobal

Returns __type

Const getLoadAverage

Returns number

Const getLocalIp

Returns Promise<string>