Packages > @fluidframework/driver-definitions
@fluidframework/driver-definitions Package
Interfaces
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 | |
IContainerPackageInfo | Container package info handed off to resolver. |
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 |
Enumerations
Enum | 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 |
Types
TypeAlias | Description |
---|---|
DriverError | |
IResolvedUrl | |
IStreamResult |
Type Details
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;
};