FluidFetchReader Class

Document storage service for the file driver.

Signature:

export declare class FluidFetchReader extends ReadDocumentStorageServiceBase implements IDocumentStorageService

Extends: ReadDocumentStorageServiceBase

Implements: IDocumentStorageService

Constructors

List of constructors for this class
Constructor	Modifiers	Description
(constructor)(path, versionName)		Constructs a new instance of the `FluidFetchReader` class

List of properties for this class
Property	Modifiers	Type	Description
docTree		api.ISnapshotTree \| null

List of methods on this class
Method	Modifiers	Description
getSnapshotTree(version)		Read the file and returns the snapshot tree.
getVersions(versionId, count)		Gets the path of the snapshot tree to be read.
read(sha)		Finds if a file exists and returns the contents of the blob file.
readBlob(sha)

Constructs a new instance of the FluidFetchReader class

Signature:

constructor(path: string, versionName?: string | undefined);

List of parameters
Parameter	Type	Description
path	string
versionName	string \| undefined

Signature:

protected docTree: api.ISnapshotTree | null;

Read the file and returns the snapshot tree.

Signature:

getSnapshotTree(version?: api.IVersion): Promise<api.ISnapshotTree | null>;

List of parameters
Parameter	Type	Description
version	api.IVersion	The version contains the path of the file which contains the snapshot tree.

Returns:

Promise<api.ISnapshotTree | null>

Gets the path of the snapshot tree to be read.

Signature:

getVersions(versionId: string, count: number): Promise<api.IVersion[]>;

List of parameters
Parameter	Type	Description
versionId	string	version ID.
count	number	Number of versions to be returned.

Returns:

Promise<api.IVersion[]>

Finds if a file exists and returns the contents of the blob file.

Signature:

read(sha: string): Promise<string>;

List of parameters
Parameter	Type	Description
sha	string	Name of the file to be read for blobs.

Returns:

Promise<string>

Signature:

readBlob(sha: string): Promise<ArrayBufferLike>;

List of parameters
Parameter	Type	Description
sha	string

Returns:

Promise<ArrayBufferLike>