Skip to main content
On this pageFunctions

Experimental/Query

Functions

define

functionsource

Types

KeyedQuery

typesource
/**
 * Viewless Block for fetching and retaining `AsyncData` values by cache key.
 * 
 * A KeyedQuery is one Block. Its cache entries are Model data, not keyed Block
 * instances. The final two parameters describe the Query's Effects Layer and
 * unresolved host handlers. Their defaults describe a host-provided Query.
 * 
 *  Ships from `foldkit/experimental/query`; expect breaking changes while the API settles.
 */
type KeyedQuery = Omit<KeyedQueryBlockBase<Name, A, AI, E, EI, Fields, EffectsLayer, HostHandlers>, "replaceEffectsLayer" | "provideHandlers"> & KeyedQueryConveniences<Name, A, AI, E, EI, Fields> & Readonly<{
  provideHandlers: HostHandlers extends readonly [KeyedQueryFetchDefinition<Name, A, AI, E, EI, Fields>]
    ? (HandlersLayer: Layer.Layer<KeyedQueryFetchHandler<Name, A, AI, E, EI, Fields>, HandlerError, HandlerRequirements>) => KeyedQuery<Name, A, AI, E, EI, Fields, MergeLayers<EffectsLayer, Layer.Layer<KeyedQueryFetchHandler<Name, A, AI, E, EI, Fields>, HandlerError, HandlerRequirements>>, readonly []>
    : never
  replaceEffectsLayer: (EffectsLayer: SelectedEffectsLayer & NoInfer<Block.ValidateConcreteComposition<KeyedQueryBlockBase<Name, A, AI, E, EI, Fields, SelectedEffectsLayer, HostHandlers>>>) => KeyedQuery<Name, A, AI, E, EI, Fields, SelectedEffectsLayer, HostHandlers>
}>

KeyedQueryConfig

typesource
/** Schemas, identity, and cache-key policy used to define a KeyedQuery. */
type KeyedQueryConfig = Readonly<{
  args: Fields
  data: Schema.Codec<A, AI, never, never>
  error: Schema.Codec<E, EI, never, never>
  execute: never
  name: Name
  toKey: (args: Schema.Schema.Type<Schema.Struct<Fields>>) => string
}>

LayeredKeyedQuery

typesource
/** A KeyedQuery whose fetch definition can be supplied through Block handler assembly. */
type LayeredKeyedQuery = KeyedQuery<Name, A, AI, E, EI, Fields>

LayeredQuery

typesource
/** A Query whose fetch definition can be supplied through Block handler assembly. */
type LayeredQuery = Query<Name, A, AI, E, EI>

Query

typesource
/**
 * Viewless Block for fetching and retaining one `AsyncData` value.
 * 
 * The final two parameters describe the Query's Effects Layer and unresolved
 * host handlers. Their defaults describe a host-provided Query.
 * 
 *  Ships from `foldkit/experimental/query`; expect breaking changes while the API settles.
 */
type Query = Omit<QueryBlockBase<Name, A, AI, E, EI, EffectsLayer, HostHandlers>, "replaceEffectsLayer" | "provideHandlers"> & QueryConveniences<Name, A, AI, E, EI> & Readonly<{
  provideHandlers: HostHandlers extends readonly [QueryFetchDefinition<Name, A, AI, E, EI>]
    ? (HandlersLayer: Layer.Layer<QueryFetchHandler<Name, A, AI, E, EI>, HandlerError, HandlerRequirements>) => Query<Name, A, AI, E, EI, MergeLayers<EffectsLayer, Layer.Layer<QueryFetchHandler<Name, A, AI, E, EI>, HandlerError, HandlerRequirements>>, readonly []>
    : never
  replaceEffectsLayer: (EffectsLayer: SelectedEffectsLayer & NoInfer<Block.ValidateConcreteComposition<QueryBlockBase<Name, A, AI, E, EI, SelectedEffectsLayer, HostHandlers>>>) => Query<Name, A, AI, E, EI, SelectedEffectsLayer, HostHandlers>
}>

QueryConfig

typesource
/** Schemas and identity used to define an unkeyed Query. */
type QueryConfig = Readonly<{
  data: Schema.Codec<A, AI, never, never>
  error: Schema.Codec<E, EI, never, never>
  execute: never
  name: Name
}>

SyncFields

typesource
/** Schema fields whose encoding and decoding require no services. */
type SyncFields = {}

Interfaces

KeyedQueryToLayer

interfacesource
/** Builds a KeyedQuery fetch handler Layer from an Effect that constructs a fetch. */
interface KeyedQueryToLayer unknown

QueryToLayer

interfacesource
/** Builds a Query fetch handler Layer from an Effect that constructs a fetch. */
interface QueryToLayer unknown