RecordType

A record type is a type that can be stored in a record store. It is created with createRecordType.

class RecordType<
  R extends UnknownRecord,
  RequiredProperties extends keyof Omit<R, 'id' | 'typeName'>,
> {}

Constructs a new instance of the RecordType class

R['typeName']

{
  readonly createDefaultProperties: () => Exclude<
    Omit<R, 'id' | 'typeName'>,
    RequiredProperties
  >
  readonly ephemeralKeys?: {
    readonly [K in Exclude<
      keyof R,
      'id' | 'typeName'
    >]: boolean
  }
  readonly scope?: RecordScope
  readonly validator?: StoreValidator<R>
}

Properties

readonly createDefaultProperties: () => Exclude<
  Omit<R, 'id' | 'typeName'>,
  RequiredProperties
>

readonly ephemeralKeys?: {
  readonly [K in Exclude<keyof R, 'id' | 'typeName'>]: boolean
}

readonly ephemeralKeySet: ReadonlySet<string>

Check whether a record is an instance of this record type.

isInstance: (record?: UnknownRecord) => record is R

const result = recordType.isInstance(someRecord)

readonly scope: RecordScope

The unique type associated with this record.

readonly typeName: R['typeName']

readonly validator: StoreValidator<R>

Methods

Clone a record of this type.

clone(record: R): R

R

R

The cloned record.

Create a new record of this type.

create(
  properties: Pick<R, RequiredProperties> &
    Omit<Partial<R>, RequiredProperties>
): R

Pick<R, RequiredProperties> &
  Omit<Partial<R>, RequiredProperties>

R

The new record.

Create a new ID for this record type based on the given ID.

createCustomId(id: string): IdOf<R>

const id = recordType.createCustomId('myId')

string

IdOf<R>

The new ID.

Create a new ID for this record type.

createId(customUniquePart?: string): IdOf<R>

const id = recordType.createId()

string

IdOf<R>

The new ID.

Check whether an id is an id of this type.

isId(id?: string): id is IdOf<R>

const result = recordType.isIn('someId')

string

id is IdOf<R>

Whether the id is an id of this type.

Takes an id like user:123 and returns the part after the colon 123

parseId(id: IdOf<R>): string

IdOf<R>

string

Check that the passed in record passes the validations for this type. Returns its input correctly typed if it does, but throws an error otherwise.

validate(record: unknown, recordBefore?: R): R

unknown

R

R

Create a new RecordType that has the same type name as this RecordType and includes the given default properties.

withDefaultProperties<
  DefaultProps extends Omit<Partial<R>, 'id' | 'typeName'>,
>(
  createDefaultProperties: () => DefaultProps
): RecordType<R, Exclude<RequiredProperties, keyof DefaultProps>>

const authorType = createRecordType('author', () => ({ living: true }))
const deadAuthorType = authorType.withDefaultProperties({ living: false })

() => DefaultProps

RecordType<R, Exclude<RequiredProperties, keyof DefaultProps>>

The new RecordType.