index.d.ts

import {GlobbyOptions} from 'globby';
import {Options as CpFileOptions} from 'cp-file';

declare namespace cpy {
	interface SourceFile {
		/**
		Resolved path to file.
		@example `/tmp/dir/foo.bar`
		*/
		readonly path: string,

		/**
		Relative path to file from `cwd`.
		@example 'dir/foo.bar' if `cwd` was '/tmp'
		*/
		readonly relativePath: string,

		/**
		Filename.
		@example `foo.bar`
		*/
		readonly name: string,

		/**
		Filename without extension.
		@example `foo`
		*/
		readonly nameWithoutExtension: string,

		/**
		File extension.
		@example `.bar`
		*/
		readonly extension: string,
	}

	interface Options extends Readonly<GlobbyOptions>, CpFileOptions {
		/**
		Working directory to find source files.

		@default process.cwd()
		*/
		readonly cwd?: string;

		/**
		Preserve path structure.

		@default false
		*/
		readonly parents?: boolean;

		/**
		Filename or function returning a filename used to rename every file in `source`.

		@example
		```
		import cpy = require('cpy');

		(async () => {
			await cpy('foo.js', 'destination', {
				rename: basename => `prefix-${basename}`
			});
		})();
		```
		*/
		readonly rename?: string | ((basename: string) => string);

		/**
		Number of files being copied concurrently.

		@default (os.cpus().length || 1) * 2
		*/
		readonly concurrency?: number;

		/**
		Ignore junk files.

		@default true
		*/
		readonly ignoreJunk?: boolean;

		/**
		Function to filter files to copy. Should accept source file object as argument.
		Return true to include, false to exclude. Can also return a Promise that resolves to true or false.

		@example
		```
		import cpy = require('cpy');

		(async () => {
			await cpy('foo', 'destination', {
				filter: file => file.extension !== '.nocopy'
			});
		})();
		```
		*/
		readonly filter?: (file: SourceFile) => (boolean | Promise<boolean>);
	}

	interface ProgressData {
		/**
		Copied file count.
		*/
		completedFiles: number;

		/**
		Overall file count.
		*/
		totalFiles: number;

		/**
		Completed size in bytes.
		*/
		completedSize: number;

		/**
		Completed percentage. A value between `0` and `1`.
		*/
		percent: number;
	}

	interface ProgressEmitter {
		on(
			event: 'progress',
			handler: (progress: ProgressData) => void
		): Promise<string[]>;
	}
}

/**
Copy files.

@param source - Files to copy. If any of the files do not exist, an error will be thrown (does not apply to globs).
@param destination - Destination directory.
@param options - In addition to the options defined here, options are passed to [globby](https://github.com/sindresorhus/globby#options).

@example
```
import cpy = require('cpy');

(async () => {
	await cpy(['source/*.png', '!source/goat.png'], 'destination');
	console.log('Files copied!');
})();
```
*/
declare function cpy(
	source: string | ReadonlyArray<string>,
	destination: string,
	options?: cpy.Options
): Promise<string[]> & cpy.ProgressEmitter;

export = cpy;