Remote / foldkit-remote-domain/imported

ReadDescription

interface · packages/remote-domain/src/imported/describe.ts:45

interface ReadDescription {
  readonly id: string
  readonly kind: 'View'
  readonly entity: string
  readonly fields: ReadonlyArray<string>
  readonly revision: string
}

One View, as the Entity it serves.

Members

ReadDescription.id

property · packages/remote-domain/src/imported/describe.ts:46

readonly id: string

ReadDescription.kind

property · packages/remote-domain/src/imported/describe.ts:47

readonly kind: 'View'

ReadDescription.entity

property · packages/remote-domain/src/imported/describe.ts:48

readonly entity: string

ReadDescription.fields

property · packages/remote-domain/src/imported/describe.ts:50

readonly fields: ReadonlyArray<string>

The Entity's fields besides its id, which keys the View.

ReadDescription.revision

property · packages/remote-domain/src/imported/describe.ts:52

readonly revision: string

The field every event moves.