Interface FileAsync

Hierarchy

FileCore
- FileAsync
  - FileNonBlocking
  - File

Index

Properties

Methods

Properties

Readonly cache

cache: Record<string, object>

Use to cache arbitrary content associated with this instance. Use for smallish objects that are expensive to compute.

Readonly name

name: string

Return file name, excluding path

property: {string} name

Readonly path

path: string

Return file path, with forward slashes

property: {string} path

Methods

getContent

getContent(encoding?: string): Promise<string>

- Defined in lib/project/File.ts:33
Parameters
- Optional encoding: string
Returns Promise<string>

getContentBuffer

getContentBuffer(): Promise<Buffer>

- Defined in lib/project/File.ts:35
Returns Promise<Buffer>

isBinary

isBinary(): Promise<boolean>

- Defined in lib/project/File.ts:47
Returns Promise<boolean>

isExecutable

isExecutable(): Promise<boolean>

- Defined in lib/project/File.ts:43
Returns Promise<boolean>

isReadable

isReadable(): Promise<boolean>

- Defined in lib/project/File.ts:45
Returns Promise<boolean>

rename

rename(name: string): Promise<this>

- Defined in lib/project/File.ts:31
Parameters
- name: string
Returns Promise<this>

replace

replace(re: RegExp, replacement: string): Promise<this>

- Defined in lib/project/File.ts:37
Parameters
- re: RegExp
- replacement: string
Returns Promise<this>

replaceAll

replaceAll(oldLiteral: string, newLiteral: string): Promise<this>

- Defined in lib/project/File.ts:39
Parameters
- oldLiteral: string
- newLiteral: string
Returns Promise<this>

setContent

setContent(content: string): Promise<this>

- Defined in lib/project/File.ts:29
Parameters
- content: string
Returns Promise<this>

setPath

setPath(path: string): Promise<this>

- Defined in lib/project/File.ts:41
Parameters
- path: string
Returns Promise<this>

Generated using TypeDoc