@fluidframework/tinylicious-client Package

Packages > @fluidframework/tinylicious-client

The **tinylicious-client** package provides a simple and powerful way to consume collaborative Fluid data with the Tinylicious service.

The Tinylicious service is a local, in-memory Fluid service intended for prototyping and development purposes.

See https://fluidframework.com/docs/testing/tinylicious/

Classes

List of classes contained in this package or namespace
Class Description
TinyliciousAudience Tinylicious-specific IServiceAudience implementation.
TinyliciousClient Provides the ability to have a Fluid object backed by a Tinylicious service.See https://fluidframework.com/docs/testing/tinylicious/

Interfaces

List of interfaces contained in this package or namespace
Interface Description
TinyliciousClientProps Props for initializing a TinyliciousClient
TinyliciousConnectionConfig Parameters for establishing a connection with the a Tinylicious service.
TinyliciousContainerServices TinyliciousContainerServices is returned by the TinyliciousClient alongside a FluidContainer. It holds the functionality specifically tied to the Tinylicious service, and how the data stored in the FluidContainer is persisted in the backend and consumed by users. Any functionality regarding how the data is handled within the FluidContainer itself, i.e. which data objects or DDSes to use, will not be included here but rather on the FluidContainer class itself.
TinyliciousMember Since Tinylicious provides user names for all of its members, we extend the IMember interface to include this service-specific value. It will be returned for all audience members connected to Tinylicious.
TinyliciousUser Since Tinylicious provides user names for all of its members, we extend the IUser interface to include this service-specific value.

Type Aliases

List of type aliases contained in this package or namespace
Type Alias Description
ITinyliciousAudience Tinylicious-specific IServiceAudience implementation.

Type Aliases

ITinyliciousAudience

Tinylicious-specific IServiceAudience implementation.

Signature:

export declare type ITinyliciousAudience = IServiceAudience<TinyliciousMember>;