Skip to content

Documentation / @warp-drive/core / types/record / TypedRecordInstance

Interface: TypedRecordInstance

Defined in: core/src/types/record.ts:14

Records may be anything, They don't even have to be objects.

Whatever they are, if they have a Type property, that property will be used by WarpDrive and WarpDrive to provide better type safety and intellisense.

TypedRecordInstance

Properties

___(unique) Symbol($type)

ts
___(unique) Symbol($type): string;

Defined in: core/src/types/record.ts:30

The type of the resource.

This is an optional feature that can be used by record implementations to provide a typescript hint for the type of the resource.

When used, WarpDrive APIs can take advantage of this to provide better type safety and intellisense.

Released under the MIT License.