Logo for jsDocs.io

@types/child-process-promise

  • Version 2.2.6
  • Published
  • 5.87 kB
  • 1 dependency
  • MIT license

Install

npm i @types/child-process-promise
yarn add @types/child-process-promise
pnpm add @types/child-process-promise

Overview

TypeScript definitions for child-process-promise

Index

Functions

Interfaces

Functions

function exec

exec: {
    (
        command: Readonly<string>,
        options: Readonly<Options & { encoding: 'buffer' | null } & ExecOptions>
    ): ChildProcessPromise<PromiseResult<Buffer>>;
    (command: string, options: Readonly<any>): ChildProcessPromise<
        PromiseResult<string>
    >;
    (command: string, options: Readonly<any>): ChildProcessPromise<
        PromiseResult<any>
    >;
    (command: string, options?: Readonly<any>): ChildProcessPromise<
        PromiseResult<string>
    >;
};

    function execFile

    execFile: {
        (
            file: Readonly<string>,
            options: Readonly<Options & ExecFileOptionsWithBufferEncoding>
        ): ChildProcessPromise<PromiseResult<Buffer>>;
        (
            file: string,
            args: readonly string[],
            options: Readonly<any>
        ): ChildProcessPromise<PromiseResult<Buffer>>;
        (file: string, options: Readonly<any>): ChildProcessPromise<
            PromiseResult<string>
        >;
        (file: string, options: Readonly<any>): ChildProcessPromise<PromiseResult<any>>;
        (
            file: string,
            args: readonly string[],
            options: Readonly<any>
        ): ChildProcessPromise<PromiseResult<any>>;
        (
            file: string,
            args?: readonly string[],
            options?: Readonly<any>
        ): ChildProcessPromise<PromiseResult<string>>;
    };

      function fork

      fork: (
          modulePath: string,
          args?: readonly string[],
          options?: Readonly<Options & ForkOptions>
      ) => ChildProcessPromise<SpawnPromiseResult>;

        function spawn

        spawn: (
            command: Readonly<string>,
            args?: readonly string[] | null,
            options?: Readonly<Options & SpawnOptions>
        ) => ChildProcessPromise<SpawnPromiseResult>;

          Interfaces

          interface ChildProcessPromise

          interface ChildProcessPromise<T> extends Promise<T> {}

            property childProcess

            childProcess: ChildProcess;

              interface Options

              interface Options {}

                property capture

                capture?:
                    | []
                    | ['stdout' | 'stderr']
                    | ['stdout', 'stderr']
                    | ['stderr', 'stdout']
                    | undefined;

                • Pass an additional capture option to buffer the result of stdout and/or stderr Default: []

                property successfulExitCodes

                successfulExitCodes?: number[] | undefined;

                • Array of the numbers that should be interpreted as successful execution codes Default: [0]

                interface PromiseResult

                interface PromiseResult<Enc extends string | Buffer> {}

                • Simple wrapper around the child_process module that makes use of promises

                property childProcess

                childProcess: ChildProcess;

                  property stderr

                  stderr: Enc;

                    property stdout

                    stdout: Enc;

                      interface SpawnPromiseResult

                      interface SpawnPromiseResult extends PromiseResult<string> {}

                        property code

                        code: number;

                          Package Files (1)

                          Dependencies (1)

                          Dev Dependencies (0)

                          No dev dependencies.

                          Peer Dependencies (0)

                          No peer dependencies.

                          Badge

                          To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                          You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/child-process-promise.

                          • Markdown
                            [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/child-process-promise)
                          • HTML
                            <a href="https://www.jsdocs.io/package/@types/child-process-promise"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>