@fluidframework/core-interfaces Package
Interfaces
| Interface | Alerts | Description |
|---|---|---|
| IFluidCodeDetails | Deprecated | |
| IFluidCodeDetailsComparer | Deprecated | |
| IFluidCodeDetailsConfig | Deprecated | |
| IFluidHandle | Handle to a shared FluidObject | |
| IFluidHandleContext | An IFluidHandleContext describes a routing context from which other IFluidHandleContexts are defined | |
| IFluidLoadable | A shared FluidObject has a URL from which it can be referenced | |
| IFluidObject | Deprecated | |
| IFluidPackage | Deprecated | |
| IFluidPackageEnvironment | Deprecated | |
| IFluidRouter | ||
| IFluidRunnable | ||
| IProvideFluidCodeDetailsComparer | Deprecated | |
| IProvideFluidHandle | ||
| IProvideFluidHandleContext | ||
| IProvideFluidLoadable | ||
| IProvideFluidRouter | Request routing | |
| IProvideFluidRunnable | ||
| IRequest | ||
| IRequestHeader | ||
| IResponse |
Types
| TypeAlias | Description |
|---|---|
| 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. |
| FluidObjectKeys | This utility type creates a type that is the union of all keys on the generic type which implement the FluidObject pattern. See FluidObject For example |
Variables
| Variable | Alerts | Type | Description |
|---|---|---|---|
| IFluidCodeDetailsComparer | Deprecated | keyof IProvideFluidCodeDetailsComparer | |
| IFluidHandle | keyof IProvideFluidHandle | ||
| IFluidHandleContext | keyof IProvideFluidHandleContext | ||
| IFluidLoadable | keyof IProvideFluidLoadable | ||
| IFluidRouter | keyof IProvideFluidRouter | ||
| IFluidRunnable | keyof IProvideFluidRunnable | ||
| isFluidCodeDetails | Deprecated | (details: unknown) => details is Readonly<IFluidCodeDetails> | |
| isFluidPackage | Deprecated | (pkg: any) => pkg is Readonly<IFluidPackage> |
Variable Details
IFluidCodeDetailsComparer
in favor of @fluidframework/container-definitions/fluidPackage.ts#IFluidCodeDetailsComparer to have code loading modules in same package.
Signature
IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer
Type: keyof IProvideFluidCodeDetailsComparer
IFluidHandle
Signature
IFluidHandle: keyof IProvideFluidHandle
Type: keyof IProvideFluidHandle
IFluidHandleContext
Signature
IFluidHandleContext: keyof IProvideFluidHandleContext
Type: keyof IProvideFluidHandleContext
IFluidLoadable
Signature
IFluidLoadable: keyof IProvideFluidLoadable
Type: keyof IProvideFluidLoadable
IFluidRouter
Signature
IFluidRouter: keyof IProvideFluidRouter
Type: keyof IProvideFluidRouter
IFluidRunnable
Signature
IFluidRunnable: keyof IProvideFluidRunnable
Type: keyof IProvideFluidRunnable
isFluidCodeDetails
in favor of @fluidframework/container-definitions/fluidPackage.ts#isFluidCodeDetails to have code loading modules in same package
Signature
isFluidCodeDetails: (details: unknown) => details is Readonly<IFluidCodeDetails>
Type: (details: unknown) => details is Readonly<IFluidCodeDetails>
isFluidPackage
in favor of @fluidframework/container-definitions/fluidPackage.ts#isFluidPackage to have code loading modules in same package. Check if the package.json defines a Fluid package
Signature
isFluidPackage: (pkg: any) => pkg is Readonly<IFluidPackage>
Type: (pkg: any) => pkg is Readonly<IFluidPackage>