Remote / foldkit-remote-server

ReadPlan

interface · packages/remote-server/src/index.ts:135

interface ReadPlan {
  readonly fields: readonly string[]
  readonly apply: (record: EntityRecord) => EntityRecord
}

What EntitySource.filter decides for one read.

Members

ReadPlan.fields

property · packages/remote-server/src/index.ts:137

readonly fields: readonly string[]

The fields to read: those allowed, and any the decision itself needs.

ReadPlan.apply

property · packages/remote-server/src/index.ts:139

readonly apply: (record: EntityRecord) => EntityRecord

One record as the principal sees it: a member dropped, or its value replaced.