Install

1# use pnpm
2$ pnpm install -D @node-kit/extra.cp
3
4# use yarn
5$ yarn add -D @node-kit/extra.cp
6
7# use npm
8$ npm install -D @node-kit/extra.cp

Usage

use import

1import { execa, execaSync } from '@node-kit/extra.cp'
2
3execa().then(() => {})

use require

1const { execa, execaSync } = require('@node-kit/extra.cp')
2
3execa().then(() => {})

API reference

1. execa & execaSync

make exec behave like execa

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

• Types:

1import type {
2  ExecFileOptions,
3  ExecFileOptionsWithBufferEncoding,
4  ExecFileOptionsWithStringEncoding,
5  ExecFileSyncOptions,
6  ExecFileSyncOptionsWithBufferEncoding,
7  ExecFileSyncOptionsWithStringEncoding
8} from 'node:child_process'
9import type { ObjectEncodingOptions } from 'node:fs'
10
11declare function execa(
12  file: string,
13  args?: ReadonlyArray<string> | undefined | null,
14  options?:
15    | ExecFileOptions
16    | ((ObjectEncodingOptions & ExecFileOptions) | undefined | null)
17    | ExecFileOptionsWithBufferEncoding
18    | ExecFileOptionsWithStringEncoding
19): Promise<{
20  stdout: string | Buffer
21  stderr: string | Buffer
22}>
23
24declare function execaSync(
25  file: string,
26  args?: ReadonlyArray<string>,
27  options?:
28    | ExecFileSyncOptions
29    | ExecFileSyncOptionsWithBufferEncoding
30    | ExecFileSyncOptionsWithStringEncoding
31): string | Buffer

• Demos:

1. simple use

1import { execa, execaSync } from '@node-kit/extra.cp'
2
3execa().then(() => {})

Issues & Support

Please open an issue here.

License

MIT