NullBlobStorageService Class

Packages > @fluidframework/routerlicious-driver > NullBlobStorageService

Document access to underlying storage. It is default implementation of a storage service. Does not read/write anything.

Signature:

export declare class NullBlobStorageService implements IDocumentStorageService 

Implements: IDocumentStorageService

Properties

List of properties for this class
Property Modifiers Type Description
repositoryUrl string

Methods

List of methods on this class
Method Modifiers Description
createBlob(file)
downloadSummary(handle)
getSnapshotTree(version)
getVersions(versionId, count)
read(blobId)
readBlob(blobId)
uploadSummaryWithContext(summary, context)
write(tree, parents, message, ref)

Properties

repositoryUrl

Signature:

get repositoryUrl(): string;

Methods

createBlob

Signature:

createBlob(file: ArrayBufferLike): Promise<api.ICreateBlobResponse>;

Parameters

List of parameters
Parameter Type Description
file ArrayBufferLike

Returns:

Promise<api.ICreateBlobResponse>

downloadSummary

Signature:

downloadSummary(handle: api.ISummaryHandle): Promise<api.ISummaryTree>;

Parameters

List of parameters
Parameter Type Description
handle api.ISummaryHandle

Returns:

Promise<api.ISummaryTree>

getSnapshotTree

Signature:

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

Parameters

List of parameters
Parameter Type Description
version api.IVersion

Returns:

Promise<api.ISnapshotTree | null>

getVersions

Signature:

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

Parameters

List of parameters
Parameter Type Description
versionId string
count number

Returns:

Promise<api.IVersion[]>

read

Signature:

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

Parameters

List of parameters
Parameter Type Description
blobId string

Returns:

Promise<string>

readBlob

Signature:

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

Parameters

List of parameters
Parameter Type Description
blobId string

Returns:

Promise<ArrayBufferLike>

uploadSummaryWithContext

Signature:

uploadSummaryWithContext(summary: api.ISummaryTree, context: ISummaryContext): Promise<string>;

Parameters

List of parameters
Parameter Type Description
summary api.ISummaryTree
context ISummaryContext

Returns:

Promise<string>

write

Signature:

write(tree: api.ITree, parents: string[], message: string, ref: string): Promise<api.IVersion>;

Parameters

List of parameters
Parameter Type Description
tree api.ITree
parents string[]
message string
ref string

Returns:

Promise<api.IVersion>