TypeFactoryTuple Interface
Represents a tuple type with fixed-length items and optional rest elements in the type factory system.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/type-factory/alpha.
For more information about our API support guarantees, see here.
Signature
export interface TypeFactoryTuple extends TypeFactoryType
Extends: TypeFactoryType
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| _kind | Alpha | readonly | "tuple" | The kind of type this represents. |
| items | Alpha | readonly | readonly TypeFactoryType[] | The fixed-length items in the tuple. |
| rest | Alpha | optional, readonly | TypeFactoryType | Optional rest element type for variable-length tuples. |
Property Details
_kind
The kind of type this represents.
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
readonly _kind: "tuple";
Type: "tuple"
items
The fixed-length items in the tuple.
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
readonly items: readonly TypeFactoryType[];
Type: readonly TypeFactoryType[]
rest
Optional rest element type for variable-length tuples.
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
readonly rest?: TypeFactoryType;
Type: TypeFactoryType