@fluidframework/driver-definitions Package

Enumerations

List of enums contained in this package or namespace
Enumeration	Description
CreateNewHeader
DriverErrorType	Driver Error types Lists types that are likely to be used by all drivers

List of interfaces contained in this package or namespace
Interface	Description
IAuthorizationError
ICreateNewHeader
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
IDocumentStorageService	Interface to provide access to snapshots saved for a shared object
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
IFluidResolvedUrl
IGenericNetworkError
IResolvedUrlBase
ISummaryContext	Context for uploading a summary to storage. Indicates the previously acked summary.
IThrottlingWarning
IUrlResolver
IWebResolvedUrl

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

Signature:

export declare enum CreateNewHeader

List of members in use in this enum
Member	Value	Description
createNew	`"createNew"`

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

Signature:

export declare enum DriverErrorType

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
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
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.

Signature:

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

Signature:

export declare type IResolvedUrl = IWebResolvedUrl | IFluidResolvedUrl;