PropertyDef Class
A property definition class that describes the structure of the property
To use, import via @fluidframework/tree-agent/alpha.
For more information about our API support guarantees, see here.
Signature
export declare class PropertyDef
Constructors
| Constructor | Alerts | Description |
|---|---|---|
| (constructor)(name, description, schema, readOnly) | Alpha | Constructs a new instance of the PropertyDef class |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| description | Alpha | readonly | string | undefined | Optional description of the property. |
| name | Alpha | readonly | string | The name of the property. |
| readOnly | Alpha | readonly | boolean | Whether the property is readonly. |
| schema | Alpha | readonly | TypeFactoryType | The schema defining the property's type. |
Constructor Details
(constructor)
Constructs a new instance of the PropertyDef class
For more information about our API support guarantees, see here.
Signature
constructor(
name: string,
description: string | undefined,
schema: TypeFactoryType,
readOnly: boolean);
Parameters
| Parameter | Type | Description |
|---|---|---|
| name | string | |
| description | string | undefined | |
| schema | TypeFactoryType | |
| readOnly | boolean |
Property Details
description
Optional description of the property.
For more information about our API support guarantees, see here.
Signature
readonly description: string | undefined;
Type: string | undefined
name
The name of the property.
For more information about our API support guarantees, see here.
Signature
readonly name: string;
Type: string
readOnly
Whether the property is readonly.
For more information about our API support guarantees, see here.
Signature
readonly readOnly: boolean;
Type: boolean
schema
The schema defining the property's type.
For more information about our API support guarantees, see here.
Signature
readonly schema: TypeFactoryType;
Type: TypeFactoryType