FieldSchemaAlpha Class
FieldSchema including alpha APIs (currently SimpleFieldSchema).
To use, import via @fluidframework/tree/alpha.
For more information about our API support guarantees, see here.
This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.
Signature
/** @sealed */
export declare class FieldSchemaAlpha<Kind extends FieldKind = FieldKind, Types extends ImplicitAllowedTypes = ImplicitAllowedTypes, TCustomMetadata = unknown> extends FieldSchema<Kind, Types, TCustomMetadata> implements SimpleFieldSchema
Extends: FieldSchema<Kind, Types, TCustomMetadata>
Implements: SimpleFieldSchema
Type Parameters
| Parameter | Constraint | Default | Description |
|---|---|---|---|
| Kind | FieldKind | FieldKind | |
| Types | ImplicitAllowedTypes | ImplicitAllowedTypes | |
| TCustomMetadata | unknown |
Remarks
This class will go away once the alpha APIs are stable and implemented by FieldSchema. \
Constructors
| Constructor | Alerts | Description |
|---|---|---|
| (constructor)(kind, types, props) | Alpha | Constructs a new instance of the FieldSchemaAlpha class |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| allowedTypesFull | Alpha | readonly | AllowedTypesFull | Normalized version of allowedTypes. |
| allowedTypesIdentifiers | Alpha | readonly | ReadonlySet<string> | |
| persistedMetadata | Alpha | readonly | JsonCompatibleReadOnlyObject | undefined | |
| simpleAllowedTypes | Alpha | readonly | ReadonlyMap<string, SimpleAllowedTypeAttributes> |
Constructor Details
(constructor)
Constructs a new instance of the FieldSchemaAlpha class
For more information about our API support guarantees, see here.
Signature
protected constructor(kind: Kind, types: Types, props?: FieldPropsAlpha<TCustomMetadata>);
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| kind | Kind | ||
| types | Types | ||
| props | optional | FieldPropsAlpha<TCustomMetadata> |
Property Details
allowedTypesFull
Normalized version of allowedTypes.
For more information about our API support guarantees, see here.
Signature
readonly allowedTypesFull: AllowedTypesFull;
Type: AllowedTypesFull
allowedTypesIdentifiers
For more information about our API support guarantees, see here.
Signature
get allowedTypesIdentifiers(): ReadonlySet<string>;
Type: ReadonlySet<string>
persistedMetadata
For more information about our API support guarantees, see here.
Signature
get persistedMetadata(): JsonCompatibleReadOnlyObject | undefined;
Type: JsonCompatibleReadOnlyObject | undefined
simpleAllowedTypes
For more information about our API support guarantees, see here.
Signature
get simpleAllowedTypes(): ReadonlyMap<string, SimpleAllowedTypeAttributes>;
Type: ReadonlyMap<string, SimpleAllowedTypeAttributes>