Skip to main content

TypeFactoryRecord Interface

Represents a record type (index signature) in the type factory system.

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

To use, import via @fluidframework/tree-agent/alpha.

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

Signature

export interface TypeFactoryRecord extends TypeFactoryType

Extends: TypeFactoryType

Properties

PropertyAlertsModifiersTypeDescription
_kindAlphareadonly"record"The kind of type this represents.
keyTypeAlphareadonlyTypeFactoryTypeThe type of the record's keys.
valueTypeAlphareadonlyTypeFactoryTypeThe type of the record's values.

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: "record";

Type: "record"

keyType

The type of the record's keys.

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 keyType: TypeFactoryType;

Type: TypeFactoryType

valueType

The type of the record's values.

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 valueType: TypeFactoryType;

Type: TypeFactoryType