Packages > @fluidframework/fluid-static

@fluidframework/fluid-static Package

Provides a simple and powerful way to consume collaborative Fluid data.

Interfaces

Interface Alerts Description
ContainerSchema ALPHA Declares the Fluid objects that will be available in the Container.
IConnection ALPHA Base interface for information for each connection made to the Fluid session.
IFluidContainer ALPHA Provides an entrypoint into the client side of collaborative Fluid data. Provides access to the data as well as status on the collaboration session.
IFluidContainerEvents ALPHA Events emitted from IFluidContainer.
IMember ALPHA Base interface to be implemented to fetch each service's member.
IServiceAudience ALPHA Base interface to be implemented to fetch each service's audience.
IServiceAudienceEvents ALPHA Events that trigger when the roster of members in the Fluid session change.

Types

TypeAlias Alerts Description
DataObjectClass ALPHA A class that has a factory that can create a DataObject and a constructor that will return the type of the DataObject.
InitialObjects ALPHA Extract the type of 'initialObjects' from the given ContainerSchema type.
LoadableObjectClass ALPHA A class object of DataObject or SharedObject.
LoadableObjectClassRecord ALPHA A mapping of string identifiers to classes that will later be used to instantiate a corresponding DataObject or SharedObject in a LoadableObjectRecord.
LoadableObjectCtor ALPHA An object with a constructor that will return an @fluidframework/core-interfaces#IFluidLoadable.
LoadableObjectRecord ALPHA A mapping of string identifiers to instantiated DataObjects or SharedObjects.
MemberChangedListener ALPHA Signature for IMember change events.
Myself ALPHA An extended member object that includes currentConnection
SharedObjectClass ALPHA A class that has a factory that can create a DDSes (SharedObjects) and a constructor that will return the type of the DataObject.

Type Details

DataObjectClass (ALPHA)

A class that has a factory that can create a DataObject and a constructor that will return the type of the DataObject.

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature 

export type DataObjectClass<T extends IFluidLoadable> = {
    readonly factory: IFluidDataStoreFactory;
} & LoadableObjectCtor<T>;

InitialObjects (ALPHA)

Extract the type of ‘initialObjects’ from the given ContainerSchema type.

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature 

export type InitialObjects<T extends ContainerSchema> = {
    [K in keyof T["initialObjects"]]: T["initialObjects"][K] extends LoadableObjectClass<infer TChannel> ? TChannel : never;
};

LoadableObjectClass (ALPHA)

A class object of DataObject or SharedObject.

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature 

export type LoadableObjectClass<T extends IFluidLoadable> = DataObjectClass<T> | SharedObjectClass<T>;

LoadableObjectClassRecord (ALPHA)

A mapping of string identifiers to classes that will later be used to instantiate a corresponding DataObject or SharedObject in a LoadableObjectRecord .

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature 

export type LoadableObjectClassRecord = Record<string, LoadableObjectClass<any>>;

LoadableObjectCtor (ALPHA)

An object with a constructor that will return an @fluidframework/core-interfaces#IFluidLoadable.

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature 

export type LoadableObjectCtor<T extends IFluidLoadable> = new (...args: any[]) => T;

LoadableObjectRecord (ALPHA)

A mapping of string identifiers to instantiated DataObjects or SharedObjects.

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature 

export type LoadableObjectRecord = Record<string, IFluidLoadable>;

MemberChangedListener (ALPHA)

Signature for IMember change events.

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature 

export type MemberChangedListener<M extends IMember> = (clientId: string, member: M) => void;

See Also

See IServiceAudienceEvents for usage details.

Myself (ALPHA)

An extended member object that includes currentConnection

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature 

export type Myself<M extends IMember = IMember> = M & {
    currentConnection: string;
};

SharedObjectClass (ALPHA)

A class that has a factory that can create a DDSes (SharedObjects) and a constructor that will return the type of the DataObject.

WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.

Signature 

export type SharedObjectClass<T extends IFluidLoadable> = {
    readonly getFactory: () => IChannelFactory;
} & LoadableObjectCtor<T>;