@fluidframework/tree Package
Interfaces
Interface | Alerts | Modifiers | Description |
---|---|---|---|
AllowedTypeMetadata | Alpha |
Annotations that apply to an individual allowed type. | |
AllowedTypesMetadata | Alpha |
Annotations that apply to a set of allowed types. | |
AnnotatedAllowedType | Alpha |
sealed |
Stores annotations for an individual allowed type. |
AnnotatedAllowedTypes | Alpha |
sealed |
Stores annotations for a set of allowed types. |
ArrayNodeCustomizableSchema | System |
sealed |
A schema for customizable TreeArrayNodes. |
ArrayNodeCustomizableSchemaUnsafe | System |
sealed |
Unenforced version of ArrayNodeCustomizableSchemas. |
ArrayNodePojoEmulationSchema | System |
sealed |
A schema for POJO emulation mode TreeArrayNodes. |
BranchableTree | Alpha |
sealed |
A "version control"-style branch of a SharedTree. |
CodecWriteOptions | Alpha |
Options relating to encoding of persisted data. | |
CommitMetadata | sealed |
Information about a commit that has been applied. |
|
FieldProps | Additional information to provide to a FieldSchema. | ||
FieldPropsAlpha | Alpha |
FieldProps extended with additional alpha options. |
|
FieldSchemaAlphaUnsafe | System |
sealed |
Unenforced version of FieldSchemaAlpha. |
FieldSchemaMetadata | sealed |
Metadata associated with a FieldSchema. | |
ForestOptions | Alpha |
Configuration options for SharedTree's internal tree storage. | |
ForestType | Alpha |
sealed |
Used to distinguish between different forest types. |
ICodecOptions | Alpha |
Options relating to handling of persisted data. | |
InternalTreeNode | sealed |
A node type internal to @fluidframework/tree . |
|
ITree | sealed |
Channel for a Fluid Tree DDS. | |
ITreeAlpha | Alpha |
sealed |
ITree extended with some alpha APIs. |
ITreeConfigurationOptions | Options when constructing a tree view. | ||
ITreeViewConfiguration | Property-bag configuration for TreeViewConfiguration construction. | ||
JsonArrayNodeSchema | Alpha |
sealed |
JSON Schema for an array node. |
JsonLeafNodeSchema | Alpha |
sealed |
JSON Schema for a leaf node. |
JsonMapNodeSchema | Alpha |
sealed |
JSON Schema for a map node. |
JsonNodeSchemaBase | Alpha |
sealed |
Base interface for node schemas represented in JSON Schema format. |
JsonObjectNodeSchema | Alpha |
sealed |
JSON Schema for an object node. |
JsonRecordNodeSchema | Alpha |
sealed |
JSON Schema for a record node. |
JsonSchemaRef | Alpha |
sealed |
Type entry containing a reference to a definition in the schema. |
JsonStringKeyPatternProperties | Alpha |
sealed |
Types allowed in map / record nodes. |
JsonValidator | Alpha |
JSON schema validator compliant with draft 6 schema. See https://json-schema.org. |
|
LeafSchema | System |
sealed |
A TreeNodeSchema for a TreeLeafValue. |
MakeNominal | sealed |
Use this as the type of a protected field to cause a type to use nominal typing instead of structural. | |
MapNodeCustomizableSchema | System |
sealed |
A schema for customizable TreeMapNodes. |
MapNodeCustomizableSchemaUnsafe | System |
sealed |
Unenforced version of MapNodeCustomizableSchemas. |
MapNodePojoEmulationSchema | System |
sealed |
A schema for POJO emulation mode TreeMapNodes. |
NodeChangedData | Beta |
sealed |
Data included for nodeChanged. |
NodeInDocumentConstraint | A transaction constraint which requires that the given node exists in the tree. | ||
NodeSchemaMetadata | sealed |
Metadata associated with a Node Schema. | |
NodeSchemaOptions | sealed |
Additional information to provide to Node Schema creation. | |
NodeSchemaOptionsAlpha | Alpha |
Additional information to provide to Node Schema creation. Includes fields for alpha features. | |
NormalizedAnnotatedAllowedTypes | Alpha |
sealed |
AnnotatedAllowedTypes but with the lazy schema references eagerly evaluated. |
ObjectNodeSchema | Alpha |
sealed |
A schema for TreeObjectNodes. |
ReadonlyArrayNode | System |
sealed |
A covariant base type for TreeArrayNode. This provides the readonly subset of TreeArrayNode functionality, and is used as the source interface for moves since that needs to be covariant. |
RecordNodeCustomizableSchema | System |
sealed |
A schema for customizable TreeMapNodes. |
RecordNodePojoEmulationSchema | System |
sealed |
A schema for POJO emulation mode TreeMapNodes. |
Revertible | sealed |
Allows reversion of a change made to SharedTree. | |
RevertibleAlpha | Alpha |
sealed |
A Revertible with features that are not yet stable. |
RunTransaction | sealed |
A function which runs a transaction in a SharedTree. |
|
RunTransactionParams | Alpha |
The parameters for the RunTransaction API. | |
SchemaCompatibilityStatus | sealed |
Information about a view schema's compatibility with the document's stored schema. See SharedTree's README for more information about choosing a compatibility policy. |
|
SchemaFactoryObjectOptions | Alpha |
Options when declaring an object node's schema | |
SchemaStatics | System |
sealed |
Stateless APIs exposed via SchemaFactory as both instance properties and as statics. |
SchemaStaticsAlpha | System |
sealed |
Stateless APIs exposed via SchemaFactoryAlpha as both instance properties and as statics. |
SchemaValidationFunction | Alpha |
Validates data complies with some particular schema. Implementations are typically created by a JsonValidator. |
|
SharedTreeFormatOptions | Alpha |
Options for configuring the persisted format SharedTree uses. | |
SimpleArrayNodeSchema | Alpha |
sealed |
A SimpleNodeSchema for an array node. |
SimpleFieldSchema | Alpha |
sealed |
A simple, shallow representation of a schema for a field. |
SimpleLeafNodeSchema | Alpha |
sealed |
A SimpleNodeSchema for a leaf node. |
SimpleMapNodeSchema | Alpha |
sealed |
A SimpleNodeSchema for a map node. |
SimpleNodeSchemaBase | System |
sealed |
Base interface for TreeNodeSchema and SimpleNodeSchema types. Once simple schema is stable this doesn't have a reason to be kept @system , but it could be. |
SimpleNodeSchemaBaseAlpha | System |
sealed |
A SimpleNodeSchema containing fields for alpha features. |
SimpleObjectFieldSchema | Alpha |
sealed |
A SimpleFieldSchema for an SimpleObjectNodeSchema field. |
SimpleObjectNodeSchema | Alpha |
sealed |
A SimpleNodeSchema for an object node. |
SimpleRecordNodeSchema | Alpha |
sealed |
A SimpleNodeSchema for a map node. |
SimpleTreeSchema | Alpha |
sealed |
A simplified representation of a schema for a tree. |
TransactionResultFailed | Alpha |
The result of the RunTransaction API when it failed. | |
TransactionResultSuccess | Alpha |
The result of the RunTransaction API when it was successful. | |
Tree | System |
sealed |
Provides various functions for interacting with TreeNodes. |
TreeAlpha | System |
sealed |
Extensions to Tree and TreeBeta which are not yet stable. |
TreeArrayNode | sealed |
A TreeNode which implements 'readonly T[]' and the array mutation APIs. | |
TreeBeta | System |
sealed |
Extensions to Tree which are not yet stable. |
TreeBranch | Alpha |
sealed |
A collection of functionality associated with a (version-control-style) branch of a SharedTree. |
TreeBranchEvents | Alpha |
sealed |
Events for TreeBranch. |
TreeBranchFork | Alpha |
sealed |
A branch of a SharedTree that has merged from another branch. |
TreeChangeEvents | sealed |
A collection of events that can be emitted by a TreeNode. |
|
TreeChangeEventsBeta | Beta |
sealed |
Extensions to TreeChangeEvents which are not yet stable. |
TreeEncodingOptions | Alpha |
Options for how to interpret or encode a tree when schema information is available. | |
TreeIdentifierUtils | Alpha |
sealed |
A utility interface for retrieving or converting node identifiers. |
TreeIndex | Alpha |
A index where values are keyed on TreeIndexKeys. | |
TreeMapNode | sealed |
A map of string keys to tree objects. |
|
TreeNodeApi | sealed |
Provides various functions for analyzing TreeNodes. | |
TreeNodeSchemaCore | sealed |
Data common to all tree node schema. | |
TreeRecordNode | Alpha |
A TreeNode which models a TypeScript record. | |
TreeRecordNodeUnsafe | System |
sealed |
Unenforced version of TreeRecordNode. |
TreeSchema | Alpha |
sealed |
TreeViewConfigurationAlpha |
TreeSchemaEncodingOptions | Alpha |
Options for how to interpret or encode a tree when schema information is available. | |
TreeView | sealed |
An editable view of a (version control style) branch of a shared tree based on some schema. This schema--known as the view schema--may or may not align the stored schema of the document. Information about discrepancies between the two schemas is available via compatibility. Application authors are encouraged to read [schema-evolution.md](../../docs/user-facing/schema-evolution.md) and choose a schema compatibility policy that aligns with their application's needs. |
|
TreeViewAlpha | Alpha |
sealed |
TreeView with proposed changes to the schema aware typing to allow use with UnsafeUnknownSchema . |
TreeViewEvents | sealed |
Events for TreeView. |
|
VerboseTreeNode | Alpha |
Verbose encoding of a TreeNode. | |
ViewableTree | System |
sealed |
A tree from which a TreeView can be created. |
ViewContent | Alpha |
The portion of SharedTree data typically persisted by the container. Usable with independentInitializedView(config, options, content) to create a TreeView without loading a container. | |
WithType | sealed |
Adds a type symbol to a type for stronger typing. |
Classes
Class | Alerts | Modifiers | Description |
---|---|---|---|
FieldSchema | sealed |
All policy for a specific field, including functionality that does not have to be kept consistent across versions or deterministic. This can include policy for how to use this schema for "view" purposes, and well as how to expose editing APIs. Use SchemaFactory to create the FieldSchema instances, for example optional. |
|
FieldSchemaAlpha | Alpha |
sealed |
FieldSchema including alpha APIs (currently SimpleFieldSchema). |
IterableTreeArrayContent | sealed |
Used to insert iterable content into a TreeArrayNode. Use (TreeArrayNode:variable).spread to create an instance of this type. |
|
SchemaFactory | sealed |
Creates various types of schema for TreeNodes. | |
SchemaFactoryAlpha | Alpha |
SchemaFactory with additional alpha APIs. | |
SchemaUpgrade | Alpha |
sealed |
Unique token used to upgrade schemas and determine if a particular upgrade has been completed. |
TreeNode | sealed |
A non-leaf SharedTree node. Includes objects, arrays, and maps. | |
TreeViewConfiguration | sealed |
Configuration for viewWith(config). |
|
TreeViewConfigurationAlpha | Alpha |
sealed |
TreeViewConfiguration extended with some alpha APIs. |