API reference@effx/runtime
diagnostics
API reference for @effx/runtime/diagnostics
diagnostics.ts overview
Exports Grouped by Category
utils
RuntimeDiagnostics
Signature
declare const RuntimeDiagnostics: {
EFFX1301: Definition<
{
readonly code: "EFFX1301"
readonly owner: "annotation"
readonly title: "Schema argument cannot be lowered from source"
readonly severity: "error"
readonly severityPolicy: { readonly kind: "fixed" }
readonly explanation: "A.fromSchema encountered an unsupported Schema AST node. Each invalid leaf is reported with its path in the annotation argument list, including object fields, arrays, records and union cases. Definition construction remains total; the compiler reports these recorded problems before interpreting uses. Replace the unsupported node with an argument-algebra description or a Schema shape the frontend can lower; a runtime transformation cannot be evaluated during source collection."
readonly examples: readonly [
{
readonly before: "args: { value: A.fromSchema(Schema.DateTimeUtcFromString) }"
readonly after: "args: { value: A.string }"
readonly explanation: "Keep the source argument a string and perform the date conversion in the interpreter, rather than asking source lowering to run a Schema transformation."
readonly language: "ts"
}
]
},
Schema.Struct<{
readonly annotation: Schema.String
readonly path: Schema.String
readonly nodeKind: Schema.String
}>
>
}SymbolExpectations
Definition-owned defaults for symbol checks; custom expectations remain authored facts.
Signature
declare const SymbolExpectations: {
readonly callable: "metadata.annotator must be an exported callable symbol"
readonly "exported-function": "commandIdentity must be an exported callable function"
readonly "exported-value": "access symbol must be an exported value"
readonly registry: "registry must be an exported value symbol"
}annotationSchemaLowering
Definition-time data only; importing this module never evaluates an application.
Signature
declare const annotationSchemaLowering: Definition<
{
readonly code: "EFFX1301"
readonly owner: "annotation"
readonly title: "Schema argument cannot be lowered from source"
readonly severity: "error"
readonly severityPolicy: { readonly kind: "fixed" }
readonly explanation: "A.fromSchema encountered an unsupported Schema AST node. Each invalid leaf is reported with its path in the annotation argument list, including object fields, arrays, records and union cases. Definition construction remains total; the compiler reports these recorded problems before interpreting uses. Replace the unsupported node with an argument-algebra description or a Schema shape the frontend can lower; a runtime transformation cannot be evaluated during source collection."
readonly examples: readonly [
{
readonly before: "args: { value: A.fromSchema(Schema.DateTimeUtcFromString) }"
readonly after: "args: { value: A.string }"
readonly explanation: "Keep the source argument a string and perform the date conversion in the interpreter, rather than asking source lowering to run a Schema transformation."
readonly language: "ts"
}
]
},
Schema.Struct<{ readonly annotation: Schema.String; readonly path: Schema.String; readonly nodeKind: Schema.String }>
>