RecordType

Public Class

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

Signature

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

References

UnknownRecord, Omit

Constructor

Public Constructor

Constructs a new instance of the RecordType class

Parameters

R['typeName']

{
  readonly createDefaultProperties: () => Exclude<
    OmitMeta<R>,
    RequiredProperties
  >
  readonly migrations: Migrations
  readonly validator?:
    | {
        validate: (r: unknown) => R
      }
    | StoreValidator<R>
  readonly scope?: RecordScope
}

References

Exclude, OmitMeta, Migrations, StoreValidator, RecordScope

Properties

createDefaultProperties

Public Readonly Property

Signature

readonly createDefaultProperties: () => Exclude<
  OmitMeta<R>,
  RequiredProperties
>

References

Exclude, OmitMeta

isInstance

Public Property

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

Example

const result = recordType.isInstance(someRecord)

Parameters

Signature

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

References

UnknownRecord, record

migrations

Public Readonly Property

Signature

readonly migrations: Migrations

References

Migrations

scope

Public Readonly Property

Signature

readonly scope: RecordScope

References

RecordScope

typeName

Public Readonly Property

The unique type associated with this record.

Signature

readonly typeName: R['typeName']

validator

Public Readonly Property

Signature

readonly validator:
  | {
      validate: (r: unknown) => R
    }
  | StoreValidator<R>

References

StoreValidator

Methods

clone()

Public Method

Clone a record of this type.

Parameters

R

Returns

R

The cloned record.

create()

Public Method

Create a new record of this type.

Parameters

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

Returns

R

The new record.

References

Pick, Omit, Partial

createCustomId()

Public Method

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

Example

const id = recordType.createCustomId('myId')

Parameters

string

Returns

IdOf<R>

The new ID.

References

IdOf

createId()

Public Method

Create a new ID for this record type.

Example

const id = recordType.createId()

Parameters

string

Returns

IdOf<R>

The new ID.

References

IdOf

isId()

Public Method

Check whether an id is an id of this type.

Example

const result = recordType.isIn('someId')

Parameters

string

Returns

id is IdOf<R>

Whether the id is an id of this type.

References

id, IdOf

parseId()

Public Method

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

Parameters

IdOf<R>

Returns

string

References

IdOf

validate()

Public Method

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.

Parameters

unknown

Returns

R

withDefaultProperties()

Public Method

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

Example

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

Parameters

() => DefaultProps

Returns

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

The new RecordType.

References

Omit, Partial, RecordType, Exclude