@fluidframework/core-interfaces Package

Packages > @fluidframework/core-interfaces

Interfaces

List of interfaces contained in this package or namespace
Interface Description
IFluidCodeDetails Data structure used to describe the code to load on the Fluid document
IFluidCodeDetailsComparer Provides capability to compare Fluid code details.
IFluidCodeDetailsConfig Package manager configuration. Provides a key value mapping of config values
IFluidConfiguration
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
IFluidPackage Fluid-specific properties expected on a package to be loaded by the code loader. While compatible with the npm package format it is not necessary that that package is an npm package: https://stackoverflow.com/questions/10065564/add-custom-metadata-or-config-to-package-json-is-it-valid
IFluidPackageEnvironment Specifies an environment on Fluid property of a IFluidPackage
IFluidRouter
IFluidRunnable
IFluidSerializer
IProvideFluidCodeDetailsComparer
IProvideFluidConfiguration
IProvideFluidHandle
IProvideFluidHandleContext
IProvideFluidLoadable
IProvideFluidRouter Request routing
IProvideFluidRunnable
IProvideFluidSerializer
IRequest
IRequestHeader
IResponse
ISerializedHandle JSON serialized form of an IFluidHandle

Variables

List of variables contained in this package or namespace
Variable Description
IFluidCodeDetailsComparer
IFluidConfiguration
IFluidHandle
IFluidHandleContext
IFluidLoadable
IFluidRouter
IFluidRunnable
IFluidSerializer
isFluidCodeDetails
isFluidPackage Check if the package.json defines a Fluid package

Variables

IFluidCodeDetailsComparer

Signature:

IFluidCodeDetailsComparer: keyof IProvideFluidCodeDetailsComparer

IFluidConfiguration

Signature:

IFluidConfiguration: keyof IProvideFluidConfiguration

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

IFluidSerializer

Signature:

IFluidSerializer: keyof IProvideFluidSerializer

isFluidCodeDetails

Signature:

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

isFluidPackage

Check if the package.json defines a Fluid package

Signature:

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