Packages > @fluidframework/odsp-driver

@fluidframework/odsp-driver Package

Interfaces

Interface Alerts Description
ICacheAndTracker ALPHA
INonPersistentCache ALPHA Internal cache interface used within driver only
IOdspCache ALPHA Internal cache interface used within driver only
IOdspResponse ALPHA
IPersistedFileCache ALPHA Similar to IPersistedCache, but exposes cache interface for single file
IPrefetchSnapshotContents ALPHA
ISnapshotContents ALPHA

Classes

Class Alerts Description
EpochTracker ALPHA

In ODSP, the concept of "epoch" refers to binary updates to files. For example, this might include using version restore, or if the user downloads a Fluid file and then uploads it again. These result in the epoch value being incremented.

The implications of these binary updates is that the Fluid state is disrupted: the sequence number might go backwards, the data might be inconsistent with the latest state of collaboration, etc. As a result, it's not safe to continue collaboration across an epoch change. We need to detect these epoch changes and error out from the collaboration.

This class is a wrapper around fetch calls. It adds epoch to the request made so that the server can match it with its epoch value in order to match the version. It also validates the epoch value received in response of fetch calls. If the epoch does not match, then it also clears all the cached entries for the given container.

OdspDocumentServiceFactory ALPHA Factory for creating the sharepoint document service. Use this if you want to use the sharepoint implementation.
OdspDocumentServiceFactoryCore ALPHA

Factory for creating the sharepoint document service. Use this if you want to use the sharepoint implementation.

This constructor should be used by environments that support dynamic imports and that wish to leverage code splitting as a means to keep bundles as small as possible.

OdspDriverUrlResolver ALPHA Resolver to resolve urls like the ones created by createOdspUrl which is driver inner url format. Ex: ${siteUrl}?driveId=${driveId}&itemId=${itemId}&path=${path}

Types

TypeAlias Alerts Description
FetchType ALPHA
FetchTypeInternal ALPHA

Type Details

FetchType (ALPHA)

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature

export type FetchType = "blob" | "createBlob" | "createFile" | "joinSession" | "ops" | "test" | "snapshotTree" | "treesLatest" | "uploadSummary" | "push" | "versions";

FetchTypeInternal (ALPHA)

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature

export type FetchTypeInternal = FetchType | "cache";