External module "copy"

Index

Interfaces

IVisitorArgs

Variables

Functions

Variables

CPROGRESS_THRESHOLD

CPROGRESS_THRESHOLD: number = 1048576 * 5

progress

progress: any = require('progress-stream')

promisedMkdirp

promisedMkdirp: function = promisify<string, any, Function>(mkdirp)

Type declaration

- (arg: A, arg2: A2): Promise<T>
- Parameters
  - arg: A
  - arg2: A2
  Returns Promise<T>

promisedReadlink

promisedReadlink: function = promisify(fs.readlink)

Type declaration

- (arg: A): Promise<T>
- Parameters
  - arg: A
  Returns Promise<T>

promisedSymlink

promisedSymlink: function = promisify<string, string | Buffer, string, Function>(fs.symlink)

Type declaration

- (arg: A, arg2: A2, arg3: A3): Promise<T>
- Parameters
  - arg: A
  - arg2: A2
  - arg3: A3
  Returns Promise<T>

promisedUnlink

promisedUnlink: function = promisify(fs.unlink)

Type declaration

- (arg: A): Promise<T>
- Parameters
  - arg: A
  Returns Promise<T>

throttle

throttle: any = require('throttle')

Functions

async

async(from: string, to: string, options?: ICopyOptions): Promise<TCopyResult>

- Defined in copy.ts:537
Final async copy function.

export

Parameters
- from: string
- to: string
- Optional options: ICopyOptions
Returns Promise<TCopyResult>

checkAsync

checkAsync(from: string, to: string, opts: ICopyOptions): Promise<IConflictSettings | any>

- Defined in copy.ts:200
Parameters
- from: string
- to: string
- opts: ICopyOptions
Returns Promise<IConflictSettings | any>

checksBeforeCopyingSync

checksBeforeCopyingSync(from: string, to: string, options?: ICopyOptions): void

- Defined in copy.ts:70
Parameters
- from: string
- to: string
- Optional options: ICopyOptions
Returns void

copyFileAsync

copyFileAsync(from: string, to: string, mode: any, options?: ICopyOptions, retriedAttempt?: boolean): Promise<Object>

- Defined in copy.ts:228
Parameters
- from: string
- to: string
- mode: any
- Optional options: ICopyOptions
- Optional retriedAttempt: boolean
Returns Promise<Object>

copyFileSync

copyFileSync(from: string, to: string, mode: string, options?: ICopyOptions): Promise<void>

- Defined in copy.ts:112
Parameters
- from: string
- to: string
- mode: string
- Optional options: ICopyOptions
Returns Promise<void>

copyFileSyncWithProgress

copyFileSyncWithProgress(from: string, to: string, options?: ICopyOptions): Promise<Object>

- Defined in copy.ts:80
Parameters
- from: string
- to: string
- Optional options: ICopyOptions
Returns Promise<Object>

copyItemAsync

copyItemAsync(from: string, inspectData: INode, to: string, options: ICopyOptions): Promise<any>

- Defined in copy.ts:325
Parameters
- from: string
- inspectData: INode
- to: string
- options: ICopyOptions
Returns Promise<any>

copyItemSync

copyItemSync(from: string, inspectData: INode, to: string, options: ICopyOptions): Promise<void>

- Defined in copy.ts:140
Parameters
- from: string
- inspectData: INode
- to: string
- options: ICopyOptions
Returns Promise<void>

copySymlinkAsync

copySymlinkAsync(from: string, to: string): Promise<string>

- Defined in copy.ts:303
Parameters
- from: string
- to: string
Returns Promise<string>

copySymlinkSync

copySymlinkSync(from: string, to: string): void

- Defined in copy.ts:123
Parameters
- from: string
- to: string
Returns void

isDone

isDone(nodes: IProcessingNode[]): boolean

- Defined in copy.ts:386
Parameters
- nodes: IProcessingNode[]
Returns boolean

next

next(nodes: IProcessingNode[]): IProcessingNode

- Defined in copy.ts:508
Parameters
- nodes: IProcessingNode[]
Returns IProcessingNode

onConflict

onConflict(from: string, to: string, options: ICopyOptions, settings: IConflictSettings): EResolveMode | undefined

- Defined in copy.ts:338
Parameters
- from: string
- to: string
- options: ICopyOptions
- settings: IConflictSettings
Returns EResolveMode | undefined

parseOptions

parseOptions(options: any | null, from: string): ICopyOptions

- Defined in copy.ts:47
Parameters
- options: any | null
- from: string
Returns ICopyOptions

resolveConflict

resolveConflict(from: string, to: string, options: ICopyOptions, resolveMode: EResolveMode): boolean

- Defined in copy.ts:355
Parameters
- from: string
- to: string
- options: ICopyOptions
- resolveMode: EResolveMode
Returns boolean

sync

sync(from: string, to: string, options?: ICopyOptions): void

- Defined in copy.ts:150
Parameters
- from: string
- to: string
- Optional options: ICopyOptions
Returns void

validateInput

validateInput(methodName: string, from: string, to: string, options?: ICopyOptions): void

- Defined in copy.ts:31
Parameters
- methodName: string
- from: string
- to: string
- Optional options: ICopyOptions
Returns void

visitor

visitor(from: string, to: string, vars: IVisitorArgs, item: IProcessingNode): Promise<void>

- Defined in copy.ts:404
A callback for treeWalkerStream. This is called when a node has been found.

Parameters
- from: string
- to: string
- vars: IVisitorArgs
- item: IProcessingNode
Returns Promise<void>

Generated using TypeDoc