StringTextAtomStatics Interface

Static factory functions for StringTextAtom.

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 StringTextAtomStatics

Methods

Method	Alerts	Return Type	Description
fromCharacter(value)	Alpha	StringTextAtom	Creates an atom from exactly one Unicode code point.
fromString(value)	Alpha	StringTextAtom[]	Creates one atom for each Unicode code point in value.

Method Details

fromCharacter

Creates an atom from exactly one Unicode code point.

This API is provided as an alpha preview and may change without notice.

For more information about our API support guarantees, see here.

Signature

fromCharacter(value: string): StringTextAtom;

Parameters

Parameter	Type	Description
value	string

Returns

Return type: StringTextAtom

Error Handling

A @fluidframework/telemetry-utils#UsageError if value does not contain exactly one Unicode code character.

fromString

Creates one atom for each Unicode code point in value.

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): StringTextAtom[];

Parameters

Parameter	Type	Description
value	string

Returns

Return type: StringTextAtom[]