Class TreeContainer`Abstract`

A container for interacting with a file system. Operations such as component resolution, conversion, and packaging perform I/O against TreeContainer abstractions.

Extend this base class to implement a custom container.

Hierarchy (view full)

TreeContainer

Index

Constructors

Methods

exists find isDirectory readDirectory readFile readFileSync stream

Constructors

constructor

new TreeContainer(): TreeContainer
Returns TreeContainer

Methods

`Abstract`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
- Defined in resolve/treeContainers.ts:63

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
- Defined in resolve/treeContainers.ts:47

`Abstract`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
- Defined in resolve/treeContainers.ts:70

`Abstract`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
- Defined in resolve/treeContainers.ts:77

`Abstract`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
- Defined in resolve/treeContainers.ts:84

`Abstract`readFileSync

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

`Abstract`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
- Defined in resolve/treeContainers.ts:98