API reference@effx/compilerlift
collect
API reference for @effx/compiler/lift/collect
collect.ts overview
Exports Grouped by Category
utils
ChosenInput (interface)
Signature
export interface ChosenInput {
readonly channel: InputChannel
readonly ref: SchemaRef
/** Static field keys of the input schema, when the model records them. */
readonly fields: ReadonlyArray<string> | undefined
/** The other request channels the endpoint declares. */
readonly others: ReadonlyArray<string>
}GroupParts (interface)
Signature
export interface GroupParts {
readonly module: string
readonly exportName: string
readonly facts: GroupFacts
}InputChannel (type alias)
The request channel that serves as Operation.input (spec 0019 §2.3): payload, query, headers, params.
Signature
type InputChannel = "payload" | "query" | "headers" | "params" | "emptyInput"OperationParts (interface)
Signature
export interface OperationParts {
readonly module: string
readonly exportName: string
readonly rootId: string
readonly groupId: string
readonly recognized: Recognized
readonly input: ChosenInput
}chooseInput
The one request schema; with several the priority order decides; none uses the configured emptyInput.
Signature
declare const chooseInput: (recognized: Recognized, emptyInput: SchemaUse | undefined) => Option.Option<ChosenInput>groupDeclaration
Http.group({ root, group, title, description, displayName }).
Signature
declare const groupDeclaration: (parts: GroupParts) => DeclarationisQuery
Signature
declare const isQuery: (recognized: Recognized) => booleanoperationDeclaration
The annotations of one endpoint, or none when its access data has no argument form (a JSON null).
Signature
declare const operationDeclaration: (parts: OperationParts) => Option.Option<Declaration>