Skip to main content

TinyliciousConnectionConfig Interface

Parameters for establishing a connection with the a Tinylicious service.

Signature

/** @sealed */
export interface TinyliciousConnectionConfig

Properties

Property Modifiers Default Value Type Description
domain optional, readonly @fluidframework/tinylicious-driver#defaultTinyliciousEndpoint string Optional. Override of the domain.
port optional, readonly @fluidframework/tinylicious-driver#defaultTinyliciousPort number Optional. Override of the port.
tokenProvider optional, readonly @fluidframework/tinylicious-driver#InsecureTinyliciousTokenProvider ITokenProvider Optional. Override of tokenProvider. If a param is not provided, TinyliciousConnectionConfig will use the default tokenProvider which is InsecureTinyliciousTokenProvider with default scopes, which are document read, write and summarizer write.

Property Details

domain

Optional. Override of the domain.

Signature

readonly domain?: string;

Type: string

port

Optional. Override of the port.

Signature

readonly port?: number;

Type: number

tokenProvider

Optional. Override of tokenProvider. If a param is not provided, TinyliciousConnectionConfig will use the default tokenProvider which is InsecureTinyliciousTokenProvider with default scopes, which are document read, write and summarizer write.

Signature

readonly tokenProvider?: ITokenProvider;

Type: ITokenProvider