Interface IJetpack

Hierarchy

IJetpack

Index

Methods

Methods

append

append(path: string, data: string | Buffer | Object, options?: AppendOptions): void

- Defined in jetpack.ts:33
Parameters
- path: string
- data: string | Buffer | Object
- Optional options: AppendOptions
Returns void

appendAsync

appendAsync(path: string, data: string | Buffer | Object, options?: AppendOptions): Promise<null>

- Defined in jetpack.ts:34
Parameters
- path: string
- data: string | Buffer | Object
- Optional options: AppendOptions
Returns Promise<null>

copy

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

- Defined in jetpack.ts:35
Parameters
- from: string
- to: string
- Optional options: ICopyOptions
Returns void

copyAsync

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

- Defined in jetpack.ts:36
Parameters
- from: string
- to: string
- Optional options: ICopyOptions
Returns Promise<void>

createReadStream

createReadStream(path: string, options?: object): any

- Defined in jetpack.ts:45
Parameters
- path: string
- Optional options: object
  - Optional autoClose?: boolean
  - Optional encoding?: string
  - Optional end?: number
  - Optional fd?: number
  - Optional flags?: string
  - Optional mode?: number
  - Optional start?: number
Returns any

createWriteStream

createWriteStream(path: string, options?: object): any

- Defined in jetpack.ts:37
Parameters
- path: string
- Optional options: object
  - Optional autoClose?: boolean
  - Optional encoding?: string
  - Optional fd?: number
  - Optional flags?: string
  - Optional mode?: number
  - Optional start?: number
Returns any

cwd

cwd(w?: any): IJetpack | string

- Defined in jetpack.ts:31
Parameters
- Optional w: any
Returns IJetpack | string

dir

dir(path: string, criteria?: DirOptions): IJetpack

- Defined in jetpack.ts:54
Parameters
- path: string
- Optional criteria: DirOptions
Returns IJetpack

dirAsync

dirAsync(path: string, criteria?: DirOptions): Promise<IJetpack>

- Defined in jetpack.ts:55
Parameters
- path: string
- Optional criteria: DirOptions
Returns Promise<IJetpack>

exists

exists(path: string): boolean | string

- Defined in jetpack.ts:56
Parameters
- path: string
Returns boolean | string

existsAsync

existsAsync(path: string): Promise<boolean | string>

- Defined in jetpack.ts:57
Parameters
- path: string
Returns Promise<boolean | string>

file

file(path: string, criteria?: FileOptions): void

- Defined in jetpack.ts:58
Parameters
- path: string
- Optional criteria: FileOptions
Returns void

fileAsync

fileAsync(path: string, criteria?: FileOptions): Promise<null>

- Defined in jetpack.ts:59
Parameters
- path: string
- Optional criteria: FileOptions
Returns Promise<null>

find

find(startPath: string, options: FindOptions): string[]

- Defined in jetpack.ts:60
Parameters
- startPath: string
- options: FindOptions
Returns string[]

findAsync

findAsync(startPath: string, options: FindOptions): Promise<string[]>

- Defined in jetpack.ts:61
Parameters
- startPath: string
- options: FindOptions
Returns Promise<string[]>

inspect

inspect(path: string, fieldsToInclude: IInspectOptions): INode

- Defined in jetpack.ts:62
Parameters
- path: string
- fieldsToInclude: IInspectOptions
Returns INode

inspectAsync

inspectAsync(path: string, fieldsToInclude: IInspectOptions): Promise<INode>

- Defined in jetpack.ts:63
Parameters
- path: string
- fieldsToInclude: IInspectOptions
Returns Promise<INode>

inspectTree

inspectTree(path: string, options?: InspectTreeOptions): INode

- Defined in jetpack.ts:64
Parameters
- path: string
- Optional options: InspectTreeOptions
Returns INode

inspectTreeAsync

inspectTreeAsync(path: string, options?: InspectTreeOptions): Promise<INode>

- Defined in jetpack.ts:65
Parameters
- path: string
- Optional options: InspectTreeOptions
Returns Promise<INode>

list

list(path: string): string[]

- Defined in jetpack.ts:66
Parameters
- path: string
Returns string[]

listAsync

listAsync(path: string): Promise<string[]>

- Defined in jetpack.ts:67
Parameters
- path: string
Returns Promise<string[]>

move

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

- Defined in jetpack.ts:68
Parameters
- from: string
- to: string
Returns void

moveAsync

moveAsync(from: string, to: string): Promise<null>

- Defined in jetpack.ts:69
Parameters
- from: string
- to: string
Returns Promise<null>

path

path(): string

- Defined in jetpack.ts:32
Returns string

read

read(path: string, returnAs?: string): ReadWriteDataType

- Defined in jetpack.ts:70
Parameters
- path: string
- Optional returnAs: string
Returns ReadWriteDataType

readAsync

readAsync(path: string, returnAs?: string): Promise<ReadWriteDataType>

- Defined in jetpack.ts:71
Parameters
- path: string
- Optional returnAs: string
Returns Promise<ReadWriteDataType>

remove

remove(path: string): void

- Defined in jetpack.ts:72
Parameters
- path: string
Returns void

removeAsync

removeAsync(path: string): Promise<null>

- Defined in jetpack.ts:73
Parameters
- path: string
Returns Promise<null>

rename

rename(path: string, newName: string): void

- Defined in jetpack.ts:74
Parameters
- path: string
- newName: string
Returns void

renameAsync

renameAsync(path: string, newName: string): Promise<null>

- Defined in jetpack.ts:75
Parameters
- path: string
- newName: string
Returns Promise<null>

symlink

symlink(symlinkValue: string, path: string): void

- Defined in jetpack.ts:76
Parameters
- symlinkValue: string
- path: string
Returns void

symlinkAsync

symlinkAsync(symlinkValue: string, path: string): Promise<null>

- Defined in jetpack.ts:77
Parameters
- symlinkValue: string
- path: string
Returns Promise<null>

write

write(path: string, data: string | Buffer | Object, options?: IWriteOptions): void

- Defined in jetpack.ts:78
Parameters
- path: string
- data: string | Buffer | Object
- Optional options: IWriteOptions
Returns void

writeAsync

writeAsync(path: string, data: string | Buffer | Object, options?: IWriteOptions): Promise<null>

- Defined in jetpack.ts:79
Parameters
- path: string
- data: string | Buffer | Object
- Optional options: IWriteOptions
Returns Promise<null>

Generated using TypeDoc