@fluidframework/driver-definitions Package

Packages > @fluidframework/driver-definitions

Enumerations

List of enums contained in this package or namespace
Enumeration Description
DriverErrorType Driver Error types Lists types that are likely to be used by all drivers
DriverHeader Additional key in the loader request header
LoaderCachingPolicy

Interfaces

List of interfaces contained in this package or namespace
Interface Description
DriverPreCheckInfo Information that can be returned by a lightweight, seperately exported driver function. Used to preanalyze a URL for driver compatibility and preload information.
IAuthorizationError
IDeltasFetchResult
IDeltaStorageService Interface to provide access to stored deltas for a shared object
IDocumentDeltaConnection
IDocumentDeltaConnectionEvents
IDocumentDeltaStorageService Interface to provide access to stored deltas for a shared object
IDocumentService
IDocumentServiceFactory
IDocumentServicePolicies
IDocumentStorageService Interface to provide access to snapshots saved for a shared object
IDocumentStorageServicePolicies
IDriverBasicError Having this uber interface without types that have their own interfaces allows compiler to differentiate interfaces based on error type
IDriverErrorBase Base interface for all errors and warnings
IDriverHeader
IFluidResolvedUrl
IGenericNetworkError
IResolvedUrlBase
IStream Read interface for the Queue
ISummaryContext Context for uploading a summary to storage. Indicates the previously acked summary.
IThrottlingWarning
IUrlResolver
IWebResolvedUrl

Type Aliases

List of type aliases contained in this package or namespace
Type Alias Description
DriverError
IResolvedUrl
IStreamResult

Enumerations

DriverErrorType enum

Driver Error types Lists types that are likely to be used by all drivers

Signature:

export declare enum DriverErrorType 

Enumeration Members

List of members in use in this enum
Member Value Description
authorizationError "authorizationError" Access denied - user does not have enough privileges to open a file, or continue to operate on a file
deltaStreamConnectionForbidden "deltaStreamConnectionForbidden" The document is read-only and delta stream connection is forbidden.
fetchFailure "fetchFailure" Generic fetch failure. Most of such failures are due to client being offline, or DNS is not reachable, such errors map to DriverErrorType.offlineError. Anything else that can't be diagnose as likely offline maps to this error. This can also indicate no response from server.
fileNotFoundOrAccessDeniedError "fileNotFoundOrAccessDeniedError" File not found, or file deleted during session
fileOverwrittenInStorage "fileOverwrittenInStorage" This error occurs when the file is modified externally (not through Fluid protocol) in storage. It will occur in cases where client has some state or cache that is based on old content (identity) of a file, and storage / driver / loader detects such mismatch. When it's hit, client needs to forget all the knowlege about this file and start over.
genericError "genericError" Some error, most likely an exception caught by runtime and propagated to container as critical error
genericNetworkError "genericNetworkError" Some non-categorized (below) networking error Include errors like fatal server error (usually 500).
incorrectServerResponse "incorrectServerResponse" Unexpected response from server. Either JSON is malformed, or some required properties are missing
offlineError "offlineError" We can not reach server due to computer being offline.
throttlingError "throttlingError" Throttling error from server. Server is busy and is asking not to reconnect for some time
unsupportedClientProtocolVersion "unsupportedClientProtocolVersion"
writeError "writeError" User does not have write permissions to a file, but is changing content of a file. That might be indication of some data store error - data stores should not generate ops in readonly mode.

DriverHeader enum

Additional key in the loader request header

Signature:

export declare enum DriverHeader 

Enumeration Members

List of members in use in this enum
Member Value Description
createNew "createNew"
summarizingClient "fluid-client-summarizer"

LoaderCachingPolicy enum

Signature:

export declare enum LoaderCachingPolicy 

Enumeration Members

List of members in use in this enum
Member Value Description
NoCaching 0 The loader should not implement any prefetching or caching policy.
Prefetch 1 The loader should implement prefetching policy, i.e. it should prefetch resources from the latest snapshot.

Type Aliases

DriverError

Signature:

export declare type DriverError = IThrottlingWarning | IGenericNetworkError | IAuthorizationError | IDriverBasicError;

IResolvedUrl

Signature:

export declare type IResolvedUrl = IWebResolvedUrl | IFluidResolvedUrl;

IStreamResult

Signature:

export declare type IStreamResult<T> = {
    done: true;
} | {
    done: false;
    value: T;
};