Interface IZFileRepository

Represents a repository for the file system.

interface IZFileRepository {
    count(request: IZDataRequest): Promise<number>;
    get(path: string): Promise<IZFileSystemNode | null>;
    retrieve(request: IZDataRequest): Promise<IZFileSystemNode[]>;
}

Hierarchy

IZDataSource<IZFileSystemNode>
- IZFileRepository

Implemented by

ZFileRepository

Index

Methods

count get retrieve

Methods

count

count(request: IZDataRequest): Promise<number>
Retrieves the total count of data items before pagination.
Parameters
- request: IZDataRequest
  The data request being made. The page and size fields are ignored in this instance.
Returns Promise<number>
The total number of items across pages that the request data set will represent.
Inherited from IZDataSource.count
- Defined in node_modules/@zthun/helpful-query/dist/source/data-source.d.mts:20

get

get(path: string): Promise<IZFileSystemNode | null>
Retrieves a single file from the repository.
Parameters
- path: string
  The fully qualified path to the file.
Returns Promise<IZFileSystemNode | null>
The node that represents the file. Returns null if no such file exists.
- Defined in packages/crumbtrail-fs/src/file-repository/file-repository.mts:32

retrieve

retrieve(request: IZDataRequest): Promise<IZFileSystemNode[]>
Retrieves a single page of data.
Parameters
- request: IZDataRequest
  The data request that contains the sorting, filtering, search, and pagination info to construct a data view.
Returns Promise<IZFileSystemNode[]>
A single page of data elements.
Inherited from IZDataSource.retrieve
- Defined in node_modules/@zthun/helpful-query/dist/source/data-source.d.mts:31

Interface IZFileRepository

Hierarchy

Implemented by

Index

Methods

Methods

count

Parameters

Returns Promise<number>

get

Parameters

Returns Promise<IZFileSystemNode | null>

retrieve

Parameters

Returns Promise<IZFileSystemNode[]>

Settings

On This Page