Composition / foldkit-composition/surface

PageReads

interface · packages/composition/src/surface/index.ts:35

interface PageReads<AppModel> extends ActiveSurface<AppModel> {
  readonly projectionOf: (
    model: AppModel,
  ) => Option.Option<Projection<AppModel, Readonly<Record<string, unknown>>>>
  readonly data: (model: AppModel) => Readonly<Record<string, unknown>>
}

The page's reads as an active Surface, whose Projection says what it reads: each node's value.

Members

PageReads.projectionOf

property · packages/composition/src/surface/index.ts:36

readonly projectionOf: (
  model: AppModel,
) => Option.Option<Projection<AppModel, Readonly<Record<string, unknown>>>>

PageReads.data

property · packages/composition/src/surface/index.ts:43

readonly data: (model: AppModel) => Readonly<Record<string, unknown>>

Each node's value by node id, as a Renderer's data takes it: what the Model holds of the page's reads, and nothing while it is inactive.