effx
API reference@effx/compilerlift

channels

API reference for @effx/compiler/lift/channels

channels.ts overview


Exports Grouped by Category


utils

Channel (type alias)

Signature

type Channel = "params" | "query" | "headers" | "payload"

ChannelRead (type alias)

Signature

type ChannelRead =
  | { readonly _tag: "Used"; readonly use: SchemaUse; readonly mediaType: string | undefined }
  | { readonly _tag: "Absent" }
  | { readonly _tag: "Failed" }

readChannel

Reads one request-channel entry of the endpoint options.

Signature

declare const readChannel: (
  scope: Scope,
  channel: Channel,
  entry: Extract<OptionEntry, { readonly _tag: "Property" }>
) => ChannelRead

On this page