Logo for jsDocs.io

@types/copyfiles

  • Version 2.4.4
  • Published
  • 5.06 kB
  • No dependencies
  • MIT license

Install

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

Overview

TypeScript definitions for copyfiles

Index

Functions

Interfaces

Type Aliases

Functions

function copyfiles

copyfiles: {
    (
        paths: string[],
        options: copyfiles.Options | number,
        callback: copyfiles.Callback
    ): void;
    (paths: string[], callback: copyfiles.Callback): void;
};

    Interfaces

    interface Options

    interface Options {}

      property all

      all?: boolean | undefined;

      • include files & directories beginning with a dot (.)

      property error

      error?: boolean | undefined;

      • throw error if nothing is copied

      property exclude

      exclude?: string | readonly string[] | undefined;

      • pattern or glob to exclude

      property flat

      flat?: boolean | undefined;

      • flatten the output

      property follow

      follow?: boolean | undefined;

      • follow symbolink links false

      property soft

      soft?: boolean | undefined;

      • do not overwrite destination files if they exist

      property up

      up?: number | true | undefined;

      • slice a path off the bottom of the paths 0

      property verbose

      verbose?: boolean | undefined;

      • print more information to console

      Type Aliases

      type Callback

      type Callback = (error?: Error) => void;

        Package Files (1)

        Dependencies (0)

        No dependencies.

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

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