UNPKG

1.81 kBMarkdownView Raw
1# Installation
2> `npm install --save @types/copyfiles`
3
4# Summary
5This package contains type definitions for copyfiles (https://github.com/calvinmetcalf/copyfiles#readme).
6
7# Details
8Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/copyfiles.
9## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/copyfiles/index.d.ts)
10````ts
11declare namespace copyfiles {
12 interface Options {
13 /** include files & directories beginning with a dot (.) */
14 all?: boolean | undefined;
15 /** throw error if nothing is copied */
16 error?: boolean | undefined;
17 /** pattern or glob to exclude */
18 exclude?: string | readonly string[] | undefined;
19 /** flatten the output */
20 flat?: boolean | undefined;
21 /**
22 * follow symbolink links
23 * @default false
24 */
25 follow?: boolean | undefined;
26 /** do not overwrite destination files if they exist */
27 soft?: boolean | undefined;
28 /**
29 * slice a path off the bottom of the paths
30 * @default 0
31 */
32 up?: number | true | undefined;
33 /** print more information to console */
34 verbose?: boolean | undefined;
35 }
36
37 type Callback = (error?: Error) => void;
38}
39
40declare function copyfiles(paths: string[], options: copyfiles.Options | number, callback: copyfiles.Callback): void;
41declare function copyfiles(paths: string[], callback: copyfiles.Callback): void;
42
43export = copyfiles;
44
45````
46
47### Additional Details
48 * Last updated: Mon, 20 Nov 2023 23:36:24 GMT
49 * Dependencies: none
50
51# Credits
52These definitions were written by [Florian Keller](https://github.com/ffflorian), and [Piotr Błażejewicz](https://github.com/peterblazejewicz).
53
\No newline at end of file