Skip to main content
Version: v1

@fluidframework/routerlicious-driver Package

Interfaces

InterfaceDescription
IRouterliciousDriverPolicies
ITokenProviderAbstracts the token fetching mechanism for a hosting application. The hosting application is responsible for providing an implementation.
ITokenResponse
ITokenServiceThe ITokenService abstracts the discovery of claims contained within a token

Classes

ClassDescription
DefaultTokenProviderDefault token provider in case the host does not provide one. It simply caches the provided jwt and returns it back.
DeltaStorageServiceProvides access to the underlying delta storage on the server for routerlicious driver.
DocumentDeltaStorageServiceStorage service limited to only being able to fetch documents for a specific document
DocumentPostCreateErrorError returned by createContainer(createNewSummary, resolvedUrl, logger, clientIsSummarizer) when an error is thrown in documentPostCreateCallback(documentId, creationToken). It is the consumer's responsibility to ensure that any state related to container creation is appropriately cleaned up in the event of failure. This includes the document itself, which will have been created by the time this error was thrown.
DocumentServiceThe DocumentService manages the Socket.IO connection and manages routing requests to connected clients.
DocumentStorageService
NullBlobStorageServiceDocument access to underlying storage. It is default implementation of a storage service. Does not read/write anything.
RouterliciousDocumentServiceFactoryFactory for creating the routerlicious document service. Use this if you want to use the routerlicious implementation.