Class AbstractFile

Convenient support for all File implementations

Hierarchy

AbstractScriptedFlushable<File>
- AbstractFile
  - InMemoryFile
  - NodeFsLocalFile

Implements

Index

Properties

cache
path

Accessors

Methods

Properties

Readonly cache

cache: Record<string, object>

Abstract path

path: string

Accessors

dirty

get dirty(): boolean

Inherited from AbstractScriptedFlushable.dirty
- Defined in lib/internal/common/AbstractScriptedFlushable.ts:18
Returns boolean

extension

get extension(): string

- Defined in lib/project/support/AbstractFile.ts:18
Returns string

name

get name(): string

- Defined in lib/project/support/AbstractFile.ts:14
Returns string

Methods

flush

flush(): Promise<this>

Implementation of File.flush

Inherited from AbstractScriptedFlushable.flush
- Defined in lib/internal/common/AbstractScriptedFlushable.ts:22
Returns Promise<this>

Abstract getContent

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

Implementation of File.getContent
- Defined in lib/project/support/AbstractFile.ts:28
Parameters
- Optional encoding: string
Returns Promise<string>

Abstract getContentBuffer

getContentBuffer(): Promise<Buffer>

Implementation of File.getContentBuffer
- Defined in lib/project/support/AbstractFile.ts:30
Returns Promise<Buffer>

Abstract getContentSync

getContentSync(): string

- Defined in lib/project/support/AbstractFile.ts:24
Returns string

Protected invalidateCache

invalidateCache(): this

- Defined in lib/project/support/AbstractFile.ts:60
Returns this

Abstract isBinary

isBinary(): Promise<boolean>

Implementation of File.isBinary
- Defined in lib/project/support/AbstractFile.ts:58
Returns Promise<boolean>

Abstract isExecutable

isExecutable(): Promise<boolean>

Implementation of File.isExecutable
- Defined in lib/project/support/AbstractFile.ts:54
Returns Promise<boolean>

Abstract isReadable

isReadable(): Promise<boolean>

Implementation of File.isReadable
- Defined in lib/project/support/AbstractFile.ts:56
Returns Promise<boolean>

recordAction

recordAction(action: ScriptAction<File, any>): this

Implementation of File.recordAction

Inherited from AbstractScriptedFlushable.recordAction
- Defined in lib/internal/common/AbstractScriptedFlushable.ts:13
Parameters
- action: ScriptAction<File, any>
Returns this

rename

rename(name: string): Promise<this>

Implementation of File.rename
- Defined in lib/project/support/AbstractFile.ts:34
Parameters
- name: string
Returns Promise<this>

replace

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

Implementation of File.replace
- Defined in lib/project/support/AbstractFile.ts:40
Parameters
- re: RegExp
- replacement: string
Returns Promise<this>

replaceAll

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

Implementation of File.replaceAll
- Defined in lib/project/support/AbstractFile.ts:47
Parameters
- oldLiteral: string
- newLiteral: string
Returns Promise<this>

Abstract setContent

setContent(content: string): Promise<this>

Implementation of File.setContent
- Defined in lib/project/support/AbstractFile.ts:32
Parameters
- content: string
Returns Promise<this>

Abstract setContentSync

setContentSync(content: string): this

Implementation of File.setContentSync
- Defined in lib/project/support/AbstractFile.ts:26
Parameters
- content: string
Returns this

Abstract setPath

setPath(path: string): Promise<this>

Implementation of File.setPath
- Defined in lib/project/support/AbstractFile.ts:38
Parameters
- path: string
Returns Promise<this>

Generated using TypeDoc