AnnotatedAllowedTypes Interface
Stores annotations for a set of allowed types.
To use, import via @fluidframework/tree/beta.
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 interface AnnotatedAllowedTypes<T = readonly AnnotatedAllowedType[]> extends ErasedBaseType<"tree.AnnotatedAllowedTypes">
Extends: ErasedBaseType<"tree.AnnotatedAllowedTypes">
Type Parameters
| Parameter | Default | Description |
|---|---|---|
| T | readonly AnnotatedAllowedType[] |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| metadata | Beta | readonly | AllowedTypesMetadata | Annotations that apply to a set of allowed types. |
| types | Beta | readonly | T | All the allowed types that the annotations apply to. The types themselves may also have individual annotations. |
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| evaluate() | Beta | AllowedTypesFullEvaluated | Get this AnnotatedAllowedTypes but with any lazy schema references eagerly evaluated. |
| evaluateIdentifiers() | Beta | ReadonlySet<string> | Get the allowed types as a set of identifiers with any lazy schema references eagerly evaluated. |
| evaluateSet() | Beta | ReadonlySet<TreeNodeSchema> | Get the allowed types as a set with any lazy schema references eagerly evaluated. |
Property Details
metadata
Annotations that apply to a set of allowed types.
For more information about our API support guarantees, see here.
Signature
readonly metadata: AllowedTypesMetadata;
Type: AllowedTypesMetadata
types
All the allowed types that the annotations apply to. The types themselves may also have individual annotations.
For more information about our API support guarantees, see here.
Signature
readonly types: T;
Type: T
Method Details
evaluate
Get this AnnotatedAllowedTypes but with any lazy schema references eagerly evaluated.
For more information about our API support guarantees, see here.
Signature
evaluate(): AllowedTypesFullEvaluated;
Remarks
See evaluateLazySchema(value) the implications of evaluating lazy schema references.
Returns
Return type: AllowedTypesFullEvaluated
evaluateIdentifiers
Get the allowed types as a set of identifiers with any lazy schema references eagerly evaluated.
For more information about our API support guarantees, see here.
Signature
evaluateIdentifiers(): ReadonlySet<string>;
Remarks
See evaluateLazySchema(value) the implications of evaluating lazy schema references.
It is recommend to work in terms of TreeNodeSchema rather than identifiers where possible since its more type safe and it is possible that two schema with the same identifier exist.
Returns
Return type: ReadonlySet<string>
evaluateSet
Get the allowed types as a set with any lazy schema references eagerly evaluated.
For more information about our API support guarantees, see here.
Signature
evaluateSet(): ReadonlySet<TreeNodeSchema>;
Remarks
See evaluateLazySchema(value) the implications of evaluating lazy schema references.
Returns
Return type: ReadonlySet<TreeNodeSchema>