Skip to main content

OdspClientProps Interface

This API is provided as a beta preview and may change without notice.

To use, import via @fluidframework/odsp-client/beta.

For more information about our API support guarantees, see here.

Signature​

export interface OdspClientProps

Properties​

PropertyAlertsModifiersTypeDescription
configProviderBetaoptional, readonlyIConfigProviderBaseBase interface for providing configurations to control experimental features. If unsure, leave this undefined.
connectionBetareadonlyOdspConnectionConfigConfiguration for establishing a connection with the ODSP Fluid Service (Push).
loggerBetaoptional, readonlyITelemetryBaseLoggerOptional. A logger instance to receive diagnostic messages.

Property Details​

configProvider​

Base interface for providing configurations to control experimental features. If unsure, leave this undefined.

This API is provided as a beta preview and may change without notice.

For more information about our API support guarantees, see here.

Signature​

readonly configProvider?: IConfigProviderBase;

Type: IConfigProviderBase

connection​

Configuration for establishing a connection with the ODSP Fluid Service (Push).

This API is provided as a beta preview and may change without notice.

For more information about our API support guarantees, see here.

Signature​

readonly connection: OdspConnectionConfig;

Type: OdspConnectionConfig

logger​

Optional. A logger instance to receive diagnostic messages.

This API is provided as a beta preview and may change without notice.

For more information about our API support guarantees, see here.

Signature​

readonly logger?: ITelemetryBaseLogger;

Type: ITelemetryBaseLogger