Skip to main content
Version: v1

@fluidframework/tinylicious-client Package

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/

Interfaces

InterfaceDescription
TinyliciousClientPropsProps for initializing a TinyliciousClient
TinyliciousConnectionConfigParameters for establishing a connection with the a Tinylicious service.
TinyliciousContainerServicesTinyliciousContainerServices 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.
TinyliciousMemberSince 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.
TinyliciousUserSince Tinylicious provides user names for all of its members, we extend the IUser interface to include this service-specific value.

Classes

ClassDescription
TinyliciousAudienceTinylicious-specific IServiceAudience implementation.
TinyliciousClient

Provides the ability to have a Fluid object backed by a Tinylicious service.

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

Types

TypeAliasDescription
ITinyliciousAudienceTinylicious-specific IServiceAudience implementation.