Class NodeFSTreeContainer

A TreeContainer that wraps the NodeJS fs module.

Hierarchy (view full)

TreeContainer
- NodeFSTreeContainer

Index

Constructors

Methods

exists find isDirectory readDirectory readFile readFileSync stream

Constructors

constructor

new NodeFSTreeContainer(cwd?): NodeFSTreeContainer
specify a cwd to use instead of the real cwd. Useful for tests and web environments where process.cwd is undefined
Parameters
- Optionalcwd: string
Returns NodeFSTreeContainer
Inherited from TreeContainer.constructor
- Defined in resolve/treeContainers.ts:42

Methods

exists

exists(fsPath): boolean
Whether or not a file path exists in the container.
Parameters
- fsPath: string
  File path to test
Returns boolean
true if the path exists
Overrides TreeContainer.exists
- Defined in resolve/treeContainers.ts:122

find

find(fileType, name, directory): undefined | string
Searches for a metadata component file in a container directory.
Parameters
- fileType: "content" | "metadataXml"
  The type of component file
- name: string
  The name of the file without a suffix
- directory: string
  The directory to search in
Returns undefined | string
The first path that meets the criteria, or undefined if none were found
Inherited from TreeContainer.find
- Defined in resolve/treeContainers.ts:53

isDirectory

isDirectory(fsPath): boolean
Whether or not a file path is a directory in the container.
Parameters
- fsPath: string
  File path to test
Returns boolean
true if the path is to a directory
Overrides TreeContainer.isDirectory
- Defined in resolve/treeContainers.ts:117

readDirectory

readDirectory(fsPath): string[]
Reads the contents of a directory in the container.
Parameters
- fsPath: string
  Path to directory
Returns string[]
An array of file and directory names in the directory
Overrides TreeContainer.readDirectory
- Defined in resolve/treeContainers.ts:126

readFile

readFile(fsPath): Promise<Buffer<ArrayBufferLike>>
Reads the contents of a file.
Parameters
- fsPath: string
Returns Promise<Buffer<ArrayBufferLike>>
A buffer of the file contents
Overrides TreeContainer.readFile
- Defined in resolve/treeContainers.ts:130

readFileSync

readFileSync(fsPath): Buffer<ArrayBufferLike>
Reads the contents of a file synchronously.
Parameters
- fsPath: string
Returns Buffer<ArrayBufferLike>
A buffer of the file contents
Overrides TreeContainer.readFileSync
- Defined in resolve/treeContainers.ts:135

stream

stream(fsPath): Readable
Creates a readable stream of a file's contents.
Parameters
- fsPath: string
  File path to create a readable stream from
Returns Readable
A readable stream
Overrides TreeContainer.stream
- Defined in resolve/treeContainers.ts:139