createRecordType

Public function

Create a record type.

Example

const Book = createRecordType<Book>('book')

function createRecordType<R extends UnknownRecord>(
  typeName: R['typeName'],
  config: {
    migrations?: Migrations
    validator?: StoreValidator<R>
    scope: RecordScope
  }
): RecordType<R, keyof Omit<R, 'id' | 'typeName'>>

R['typeName']

{
  migrations?: Migrations
  validator?: StoreValidator<R>
  scope: RecordScope
}

RecordType<R, keyof Omit<R, 'id' | 'typeName'>>

UnknownRecord, Migrations, StoreValidator, RecordType

packages/store/src/lib/RecordType.ts