External module "dir"

Index

Interfaces

IOptions

Variables

Functions

Variables

promisedChmod

promisedChmod: function = promisify<string | Buffer, string, Function>(chmod)

Type declaration

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

promisedMkdirp

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

Type declaration

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

promisedReaddir

promisedReaddir: function = promisify(readdir)

Type declaration

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

promisedRimraf

promisedRimraf: function = promisify<string, Function>(rimraf)

Type declaration

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

promisedStat

promisedStat: function = promisify(stat)

Type declaration

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

Functions

async

async(path: string, passedCriteria?: IOptions): Promise<Object>

- Defined in dir.ts:164
Parameters
- path: string
- Optional passedCriteria: IOptions
Returns Promise<Object>

checkDirAsync

checkDirAsync(path: string, stat: Stats, options: IOptions): Promise<Object>

- Defined in dir.ts:146
Parameters
- path: string
- stat: Stats
- options: IOptions
Returns Promise<Object>

checkDirSync

checkDirSync(path: string, stat: Stats, options: IOptions): void

- Defined in dir.ts:61
Parameters
- path: string
- stat: Stats
- options: IOptions
Returns void

checkMode

checkMode(criteria: IOptions, stat: Stats, path: string): Promise<null>

- Defined in dir.ts:138
Parameters
- criteria: IOptions
- stat: Stats
- path: string
Returns Promise<null>

defaults

defaults(options?: IOptions): IOptions

- Defined in dir.ts:25
Parameters
- Optional options: IOptions
Returns IOptions

dirStatAsync

dirStatAsync(path: string): Promise<Stats>

- Defined in dir.ts:102
Parameters
- path: string
Returns Promise<Stats>

dirStatsSync

dirStatsSync(path: string): Stats

- Defined in dir.ts:39
Parameters
- path: string
Returns Stats

emptyAsync

emptyAsync(path: string): Promise<Object>

- Defined in dir.ts:118
Parameters
- path: string
Returns Promise<Object>

mkdirAsync

mkdirAsync(path: string, criteria: IOptions): Promise<null>

- Defined in dir.ts:160
Parameters
- path: string
- criteria: IOptions
Returns Promise<null>

mkdirSync

mkdirSync(path: string, criteria: IOptions): void

- Defined in dir.ts:57
Parameters
- path: string
- criteria: IOptions
Returns void

sync

sync(path: string, options?: IOptions): void

- Defined in dir.ts:82
Parameters
- path: string
- Optional options: IOptions
Returns void

validateInput

validateInput(methodName: string, path: string, options?: IOptions): void

- Defined in dir.ts:16
Parameters
- methodName: string
- path: string
- Optional options: IOptions
Returns void

Generated using TypeDoc