createRecordType

Public function

Create a record type.

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

function createRecordType<R extends UnknownRecord>(
  typeName: R['typeName'],
  config: {
    ephemeralKeys?: {
      readonly [K in Exclude<keyof R, 'id' | 'typeName'>]: boolean
    }
    scope: RecordScope
    validator?: StoreValidator<R>
  }
): RecordType<R, keyof Omit<R, 'id' | 'typeName'>>

R['typeName']

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

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

UnknownRecord, StoreValidator, RecordType

packages/store/src/lib/RecordType.ts