Logo for jsDocs.io

@types/ncp

  • Version 2.0.8
  • Published
  • 6.49 kB
  • 1 dependency
  • MIT license

Install

npm i @types/ncp
yarn add @types/ncp
pnpm add @types/ncp

Overview

TypeScript definitions for ncp

Index

Variables

Interfaces

Variables

variable ncp

const ncp: {
    (
        source: string,
        destination: string,
        callback: (err: Error[] | null) => void
    ): void;
    (
        source: string,
        destination: string,
        options: ncp.Options & { stopOnErr: true },
        callback: (err: Error | null) => void
    ): void;
    (
        source: string,
        destination: string,
        options: ncp.Options & { errs?: undefined },
        callback: (err: Error[] | null) => void
    ): void;
    (
        source: string,
        destination: string,
        options: ncp.Options & { errs: fs.PathLike },
        callback: (err: fs.WriteStream | null) => void
    ): void;
    (
        source: string,
        destination: string,
        options: ncp.Options,
        callback: (err: Error | Error[] | fs.WriteStream | null) => void
    ): void;
    ncp: typeof ncp;
    __promisify__(
        source: string,
        destination: string,
        options?: ncp.Options
    ): Promise<void>;
};

    Interfaces

    interface File

    interface File {}

      property atime

      atime: Date;

      • Accessed time

      property mode

      mode: number;

        property mtime

        mtime: Date;

        • Modified time

        property name

        name: string;

          interface Options

          interface Options {}

            property clobber

            clobber?: boolean | undefined;

              property dereference

              dereference?: boolean | undefined;

                property errs

                errs?: fs.PathLike | undefined;

                  property filter

                  filter?: RegExp | ((filename: string) => boolean) | undefined;

                    property limit

                    limit?: number | undefined;

                      property stopOnErr

                      stopOnErr?: boolean | undefined;

                        property transform

                        transform?:
                            | ((
                                  read: NodeJS.ReadableStream,
                                  write: NodeJS.WritableStream,
                                  file: File
                              ) => void)
                            | undefined;

                          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/ncp.

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