assertIdType • tldraw SDK

Public function

Assert whether an id correspond to a record type.

Example

assertIdType(myId, 'shape')

Signature

function assertIdType<R extends UnknownRecord>(
  id: string | undefined,
  type: RecordType<R, any>
): asserts id is IdOf<R>

Parameters

Name Description

Name	Description
`id`	`string \| undefined` The id to check.
`type`	`RecordType<R, any>` The type of the record.

id

string | undefined

The id to check.

type

RecordType<R, any>

The type of the record.

Returns

asserts id is IdOf<R>

References

Source