@fluidframework/routerlicious-driver Package

Packages > @fluidframework/routerlicious-driver

Classes

List of classes contained in this package or namespace
Class Description
DefaultErrorTracking The default error tracking service implementation. It does not track any errors.
DefaultTokenProvider Default token provider in case the host does not provide one. It simply caches the provided jwt and returns it back.
DeltaStorageService Provides access to the underlying delta storage on the server for routerlicious driver.
DocumentDeltaStorageService Storage service limited to only being able to fetch documents for a specific document
DocumentService The DocumentService manages the Socket.IO connection and manages routing requests to connected clients
DocumentService2 The DocumentService manages the Socket.IO connection and manages routing requests to connected clients
DocumentStorageService Document access to underlying storage for routerlicious driver.
NullBlobStorageService Document access to underlying storage. It is default implementation of a storage service. Does not read/write anything.
RouterliciousDocumentServiceFactory Factory for creating the routerlicious document service. Use this if you want to use the routerlicious implementation.

Functions

List of functions contained in this package or namespace
Function Description
createDocumentService(resolvedUrl, ordererUrl, deltaStorageUrl, gitUrl, tokenProvider, tenantId, documentId, errorTracking, disableCache, historianApi, credentials, seedData, logger) Returns the document service associated with the factory.

Interfaces

List of interfaces contained in this package or namespace
Interface Description
ITokenProvider The ITokenProvider abstracts the token fetching mechanism for a host. Host will be responsible for implementing the interfaces.
ITokenResponse
ITokenService The ITokenService abstracts the discovery of claims contained within a token

Variables

List of variables contained in this package or namespace
Variable Description
createDocumentService2 Returns the document service associated with the factory.

Functions

createDocumentService

Warning: This API is now obsolete.

  • The createDocumentService of document service factory directly returns the associated document service.

Returns the document service associated with the factory.

Signature:

export declare function createDocumentService(resolvedUrl: IResolvedUrl, ordererUrl: string, deltaStorageUrl: string, gitUrl: string, tokenProvider: ITokenProvider, tenantId: string, documentId: string, errorTracking?: IErrorTrackingService, disableCache?: boolean, historianApi?: boolean, credentials?: any, seedData?: IGitCache, logger?: ITelemetryLogger): IDocumentService;

Parameters

List of parameters
Parameter Type Description
resolvedUrl IResolvedUrl
ordererUrl string
deltaStorageUrl string
gitUrl string
tokenProvider ITokenProvider
tenantId string
documentId string
errorTracking IErrorTrackingService
disableCache boolean
historianApi boolean
credentials any
seedData IGitCache
logger ITelemetryLogger

Returns:

IDocumentService

Variables

createDocumentService2

Warning: This API is now obsolete.

  • The createDocumentService of document service factory directly returns the associated document service.

Returns the document service associated with the factory.

Signature:

createDocumentService2: (resolvedUrl: IResolvedUrl, ordererUrl: string, deltaStorageUrl: string, gitUrl: string, tokenProvider: ITokenProvider, tenantId: string, documentId: string, errorTracking: IErrorTrackingService | undefined, disableCache: boolean | undefined, historianApi: boolean | undefined, logger: ITelemetryLogger, credentials?: ICredentials | undefined) => IDocumentService