Skip to main content

OptionsWithSchemaFactory Interface

A base interface for factory input options which include an schema factory.

This API is reserved for internal system use and should not be imported directly. It may change at any time without notice.

For more information about our API support guarantees, see here.

Signature​

interface OptionsWithSchemaFactory<TSchemaFactory extends SchemaFactoryBeta>

Type Parameters​

ParameterConstraintDescription
TSchemaFactorySchemaFactoryBeta

Remarks​

This interface should not be referenced directly.

Properties​

PropertyAlertsModifiersTypeDescription
schemaFactoryBetareadonlyTSchemaFactorySchema factory with which the Column schema will be associated.

Property Details​

schemaFactory​

Schema factory with which the Column schema will be associated.

This API is reserved for internal system use and should not be imported directly. It may change at any time without notice.

For more information about our API support guarantees, see here.

Signature​

readonly schemaFactory: TSchemaFactory;

Type: TSchemaFactory

Remarks​

Can be used to associate the resulting schema with an existing scope. The resulting schema will have an identifier of the form: com.fluidframework.table<${TUserScope}>.<Column|Row|Table>.