@fluidframework/core-interfaces Package

Interfaces

Types

Variables

Type Details

FluidObject

This utility type take interface(s) that follow the FluidObject pattern, and produces a new type that can be used for inspection and discovery of those interfaces.

It is meant to be used with types that are known to implement the FluidObject pattern. A common way to specify a type implements the FluidObject pattern is to expose it as a FluidObject without a generic argument.

For example, if we have an interface like below

interface IProvideFoo{
 IFoo: IFoo
}
interface IFoo extends IProvideFoo{
 foobar();
}

and a function that returns a FluidObject. You would do the following

const maybeFoo: FluidObject<IFoo> = getFluidObject();

Either IFoo or IProvideFoo are valid generic arguments. In both case maybeFoo will be of type {IFoo?: IFoo}. If IFoo is not undefined, then the FluidObject provides IFoo, and it can be used.

You can inspect multiple types via a intersection. For example: FluidObject<IFoo & IBar>

Signature

export declare type FluidObject<T = unknown> = {
    [P in FluidObjectProviderKeys<T>]?: T[P];
};

FluidObjectKeys

This utility type creates a type that is the union of all keys on the generic type which implement the FluidObject pattern.

Signature

export declare type FluidObjectKeys<T> = keyof FluidObject<T>;

See Also

FluidObject

For example FluidObjectKeys<IFoo & IBar> would result in "IFoo" | "IBar"

Variable Details

IFluidCodeDetailsComparer

Signature

IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer

IFluidHandle

Signature

IFluidHandle: keyof IProvideFluidHandle

IFluidHandleContext

Signature

IFluidHandleContext: keyof IProvideFluidHandleContext

IFluidLoadable

Signature

IFluidLoadable: keyof IProvideFluidLoadable

IFluidRouter

Signature

IFluidRouter: keyof IProvideFluidRouter

IFluidRunnable

Signature

IFluidRunnable: keyof IProvideFluidRunnable

isFluidCodeDetails

Signature

isFluidCodeDetails: (details: unknown) => details is Readonly<IFluidCodeDetails>

isFluidPackage

Signature

isFluidPackage: (pkg: any) => pkg is Readonly<IFluidPackage>