TinyliciousConnectionConfig Interface

Parameters for establishing a connection with the a Tinylicious service.

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

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.

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

readonly domain?: string;

Type: string

port

Optional. Override of the port.

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

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.

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

readonly tokenProvider?: ITokenProvider;

Type: ITokenProvider