External module "inspect"

Index

Variables

Functions

Variables

Q

Q: any = require('q')

promisedLstat

promisedLstat: function = denodeify(lstat)

Type declaration

- (a: A): Promise<R>
- Parameters
  - a: A
  Returns Promise<R>

promisedReadlink

promisedReadlink: function = denodeify(readlink)

Type declaration

- (a: A): Promise<R>
- Parameters
  - a: A
  Returns Promise<R>

promisedStat

promisedStat: function = denodeify(stat)

Type declaration

- (a: A): Promise<R>
- Parameters
  - a: A
  Returns Promise<R>

supportedChecksumAlgorithms

supportedChecksumAlgorithms: string[] = ['md5', 'sha1', 'sha256', 'sha512']

Functions

DefaultInspectOptions

DefaultInspectOptions(): IInspectOptions

- Defined in inspect.ts:100
Returns IInspectOptions

addExtraFieldsAsync

addExtraFieldsAsync(path: string, inspectObj: INode, options: IInspectOptions): any

- Defined in inspect.ts:222
Parameters
- path: string
- inspectObj: INode
- options: IInspectOptions
Returns any

addExtraFieldsSync

addExtraFieldsSync(path: string, inspectObj: any, options: IInspectOptions): INode

- Defined in inspect.ts:184
Parameters
- path: string
- inspectObj: any
- options: IInspectOptions
Returns INode

async

async(path: string, options?: IInspectOptions): Promise<INode>

- Defined in inspect.ts:239
Parameters
- path: string
- Optional options: IInspectOptions
Returns Promise<INode>

createInspectObj

createInspectObj(path: string, options: IInspectOptions, stat: Stats): INode

- Defined in inspect.ts:126
Parameters
- path: string
- options: IInspectOptions
- stat: Stats
Returns INode

createItem

createItem(path: string, options?: IInspectOptions): INode

- Defined in inspect.ts:169
Parameters
- path: string
- Optional options: IInspectOptions
Returns INode

fileChecksum

fileChecksum(path: string, algo: string): string

- Defined in inspect.ts:177
Parameters
- path: string
- algo: string
Returns string

fileChecksumAsync

fileChecksumAsync(path: string, algo: string): Promise<string>

- Defined in inspect.ts:212
Parameters
- path: string
- algo: string
Returns Promise<string>

sync

sync(path: string, options?: IInspectOptions): INode

- Defined in inspect.ts:193
Parameters
- path: string
- Optional options: IInspectOptions
Returns INode

validateInput

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

- Defined in inspect.ts:106
Parameters
- methodName: string
- path: string
- Optional options: IInspectOptions
Returns void

Generated using TypeDoc