@node-kit/extra.cp

@node-kit/extra.cp

Some shared extra utilities for nodejs build-in child_process modules

Install

# use pnpm
$ pnpm install -D @node-kit/extra.cp

# use yarn
$ yarn add -D @node-kit/extra.cp

# use npm
$ npm install -D @node-kit/extra.cp

Usage

use import

import { execa, execaSync } from '@node-kit/extra.cp'

execa().then(() => {})

use require

const { execa, execaSync } = require('@node-kit/extra.cp')

execa().then(() => {})

API reference

1. execa & execaSync

make exec behave like execa

• Usage: execa(file, args, options) & execaSync(file, args, options)
• Parameters:

Param	Description	Type	Optional value	Required	Default value
file	The name or path of the executable file to run.	string	-	true	-
args	List of string arguments.	ReadonlyArray<string>	-	false	-
options	Options for execFile	object	-	false	-

• Types:

import type {
  ExecFileOptions,
  ExecFileOptionsWithBufferEncoding,
  ExecFileOptionsWithStringEncoding,
  ExecFileSyncOptions,
  ExecFileSyncOptionsWithBufferEncoding,
  ExecFileSyncOptionsWithStringEncoding
} from 'node:child_process'
import type { ObjectEncodingOptions } from 'node:fs'

declare function execa(
  file: string,
  args?: ReadonlyArray<string> | undefined | null,
  options?:
    | ExecFileOptions
    | ((ObjectEncodingOptions & ExecFileOptions) | undefined | null)
    | ExecFileOptionsWithBufferEncoding
    | ExecFileOptionsWithStringEncoding
): Promise<{
  stdout: string | Buffer
  stderr: string | Buffer
}>

declare function execaSync(
  file: string,
  args?: ReadonlyArray<string>,
  options?:
    | ExecFileSyncOptions
    | ExecFileSyncOptionsWithBufferEncoding
    | ExecFileSyncOptionsWithStringEncoding
): string | Buffer

• Demos:

1. simple use

import { execa, execaSync } from '@node-kit/extra.cp'

execa().then(() => {})

Issues & Support

Please open an issue here.

License

MIT

Changelog

2023.07.05 v3.1.0

1. add support running in terminal from what-pm
2. external tslib package