Class AbstractProject

Support for implementations of Project interface

Hierarchy

AbstractScriptedFlushable<Project>
- AbstractProject
  - InMemoryProject
  - NodeFsLocalProject

Implements

Index

Constructors

constructor

Properties

Accessors

dirty
name

Constructors

Protected constructor

new AbstractProject(id: RepoRef, shouldCache?: boolean): AbstractProject

- Defined in lib/project/support/AbstractProject.ts:24
Parameters
- id: RepoRef
- Default value shouldCache: boolean = false
Returns AbstractProject

Properties

Readonly cache

cache: Record<string, object>

Private cachedFiles

cachedFiles: Promise<File[]> | undefined

Cached paths

id

shouldCache

shouldCache: boolean

Accessors

dirty

get dirty(): boolean

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

name

get name(): string

- Defined in lib/project/support/AbstractProject.ts:22
Returns string

Methods

add

add(f: File): Promise<this>

Implementation of Project.add
- Defined in lib/project/support/AbstractProject.ts:119
Parameters
- f: File
Returns Promise<this>

Abstract addDirectory

addDirectory(path: string): Promise<this>

Implementation of Project.addDirectory
- Defined in lib/project/support/AbstractProject.ts:125
Parameters
- path: string
Returns Promise<this>

Abstract addFile

addFile(path: string, content: string): Promise<this>

Implementation of Project.addFile
- Defined in lib/project/support/AbstractProject.ts:123
Parameters
- path: string
- content: string
Returns Promise<this>

Abstract addFileSync

addFileSync(path: string, content: string): void

Implementation of Project.addFileSync
- Defined in lib/project/support/AbstractProject.ts:112
Parameters
- path: string
- content: string
Returns void

Abstract deleteDirectory

deleteDirectory(path: string): Promise<this>

Implementation of Project.deleteDirectory
- Defined in lib/project/support/AbstractProject.ts:116
Parameters
- path: string
Returns Promise<this>

Abstract deleteDirectorySync

deleteDirectorySync(path: string): void

Implementation of Project.deleteDirectorySync
- Defined in lib/project/support/AbstractProject.ts:114
Parameters
- path: string
Returns void

Abstract deleteFile

deleteFile(path: string): Promise<this>

Implementation of Project.deleteFile
- Defined in lib/project/support/AbstractProject.ts:127
Parameters
- path: string
Returns Promise<this>

Abstract deleteFileSync

deleteFileSync(path: string): void

Implementation of Project.deleteFileSync
- Defined in lib/project/support/AbstractProject.ts:129
Parameters
- path: string
Returns void

Abstract directoryExistsSync

directoryExistsSync(path: string): boolean

Implementation of Project.directoryExistsSync
- Defined in lib/project/support/AbstractProject.ts:133
Parameters
- path: string
Returns boolean

Abstract fileExistsSync

fileExistsSync(path: string): boolean

Implementation of Project.fileExistsSync
- Defined in lib/project/support/AbstractProject.ts:135
Parameters
- path: string
Returns boolean

Abstract findFile

findFile(path: string): Promise<File>

Implementation of Project.findFile
- Defined in lib/project/support/AbstractProject.ts:35
Return the file, or reject with error

Parameters
- path: string
Returns Promise<File>

Abstract findFileSync

findFileSync(path: string): File

Implementation of Project.findFileSync
- Defined in lib/project/support/AbstractProject.ts:45
Parameters
- path: string
Returns File

flush

flush(): Promise<this>

Implementation of ScriptedFlushable.flush

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

Abstract getFile

getFile(path: string): Promise<File | undefined>

Implementation of Project.getFile
- Defined in lib/project/support/AbstractProject.ts:37
Parameters
- path: string
Returns Promise<File | undefined>

getFiles

getFiles(globPatterns?: string | string[]): Promise<File[]>

Implementation of Project.getFiles
- Defined in lib/project/support/AbstractProject.ts:59
Get files matching these patterns

Parameters
- Default value globPatterns: string | string[] = []
Returns Promise<File[]>

Protected getFilesInternal

getFilesInternal(globPatterns: string[]): Promise<File[]>

- Defined in lib/project/support/AbstractProject.ts:77
Subclasses can override this to optimize if they wish

Parameters
- globPatterns: string[]
Returns Promise<File[]>

Abstract hasDirectory

hasDirectory(path: string): Promise<boolean>

Implementation of Project.hasDirectory
- Defined in lib/project/support/AbstractProject.ts:43
Parameters
- path: string
Returns Promise<boolean>

hasFile

hasFile(path: string): Promise<boolean>

Implementation of Project.hasFile
- Defined in lib/project/support/AbstractProject.ts:39
Parameters
- path: string
Returns Promise<boolean>

Protected invalidateCache

invalidateCache(): void

- Defined in lib/project/support/AbstractProject.ts:137
Returns void

Abstract makeExecutable

makeExecutable(path: string): Promise<this>

Implementation of Project.makeExecutable
- Defined in lib/project/support/AbstractProject.ts:102
Parameters
- path: string
Returns Promise<this>

Abstract makeExecutableSync

makeExecutableSync(path: string): void

Implementation of Project.makeExecutableSync
- Defined in lib/project/support/AbstractProject.ts:131
Parameters
- path: string
Returns void

moveFile

moveFile(oldPath: string, newPath: string): Promise<this>

Implementation of Project.moveFile
- Defined in lib/project/support/AbstractProject.ts:93
Parameters
- oldPath: string
- newPath: string
Returns Promise<this>

recordAction

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

Implementation of ScriptedFlushable.recordAction

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

recordAddFile

recordAddFile(path: string, content: string): this

- Defined in lib/project/support/AbstractProject.ts:104
Parameters
- path: string
- content: string
Returns this

recordDeleteFile

recordDeleteFile(path: string): this

- Defined in lib/project/support/AbstractProject.ts:108
Parameters
- path: string
Returns this

streamFiles

streamFiles(...globPatterns: string[]): FileStream

Implementation of Project.streamFiles
- Defined in lib/project/support/AbstractProject.ts:47
Parameters
- Rest ...globPatterns: string[]
Returns FileStream

Abstract streamFilesRaw

streamFilesRaw(globPatterns: string[], opts: Options): FileStream

Implementation of Project.streamFilesRaw
- Defined in lib/project/support/AbstractProject.ts:52
Parameters
- globPatterns: string[]
- opts: Options
Returns FileStream

totalFileCount

totalFileCount(): Promise<number>

Implementation of Project.totalFileCount
- Defined in lib/project/support/AbstractProject.ts:81
Returns Promise<number>

trackFile

trackFile(f: FileNonBlocking): this

- Defined in lib/project/support/AbstractProject.ts:86
Parameters
- f: FileNonBlocking
Returns this

Generated using TypeDoc