Remote / foldkit-remote-server

QuerySource

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

interface QuerySource<P, R = never> {
  readonly query: string
  readonly Input: Schema.Codec<unknown>
  readonly run: (context: {
    readonly input: unknown
    readonly window: QueryWindow
    readonly principal: P
    readonly select?: RelationRequirement | undefined
  }) => Effect.Effect<QueryPage, RemoteServerError, R>
  readonly visible?: unknown
}

Members

QuerySource.query

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

readonly query: string

QuerySource.Input

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

readonly Input: Schema.Codec<unknown>

QuerySource.run

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

readonly run: (context: {
  readonly input: unknown
  readonly window: QueryWindow
  readonly principal: P
  readonly select?: RelationRequirement | undefined
}) => Effect.Effect<QueryPage, RemoteServerError, R>

QuerySource.visible

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

readonly visible?: unknown

The rule that decides which rows the query lists. See EntitySource.visible.