Statics Interface
Statics for formatted text nodes.
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Sealed
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 */
interface Statics<TTree, FormatSchema extends ImplicitAllowedTypes>
Type Parameters
| Parameter | Constraint | Description |
|---|---|---|
| TTree | ||
| FormatSchema | ImplicitAllowedTypes |
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| fromString(value, format) | Alpha | TTree | Construct a node of this schema from a string, where each character (as defined by iterating over the string) becomes a single character in the text node. |
Method Details
fromString
Construct a node of this schema from a string, where each character (as defined by iterating over the string) becomes a single character in the text node.
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
fromString(value: string, format?: InsertableTreeFieldFromImplicitField<FormatSchema>): TTree;
Remarks
This combines pairs of utf-16 surrogate code units into single characters as appropriate.
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| value | string | ||
| format | optional | InsertableTreeFieldFromImplicitField<FormatSchema> |
Returns
Return type: TTree