API reference@effx/compiler
request-channels
API reference for @effx/compiler/request-channels
request-channels.ts overview
Exports Grouped by Category
utils
Rewrite (interface)
What one step of the 0013 pre-pass leaves of a declaration, and the diagnostics it found.
Signature
export interface Rewrite {
readonly declaration: Declaration
readonly diagnostics: ReadonlyArray<Diagnostic>
}deriveRequestChannels
Derives the request channels an operation input implies into its Http.Contract (spec 0024 §2). Pure
source sugar for the 0013 pre-pass: the channel is written into the annotation arguments, so the
interpreted contract, IR, hash and generated files equal the explicit spelling. An explicit channel always
wins: a derived channel never replaces one, and an ambiguous input is a diagnostic only while nothing that
resolves it is explicit.
Signature
declare const deriveRequestChannels: (declaration: Declaration) => RewriteisAnnotationOptions
Signature
declare const isAnnotationOptions: (value: AnnotationArg | undefined) => value is OptionsmapsInput
Is candidate the very Schema input names (same SchemaRef)?
Signature
declare const mapsInput: (candidate: AnnotationArg | undefined, input: Input) => booleanoptionsOf
The single options object an annotation was written with, when it was.
Signature
declare const optionsOf: (annotation: Annotation) => Options | undefined