PluginReference
Output fields
Declaring the fields a leaf returns, and the object type they add up to.
Exports of @north-light/crouter-plugin, read from the TypeScript compiler at build time. Types re-exported from @north-light/crouter-api are documented with that package.
field
variable declared in fields.ts
The output-field builders. Fields are required unless { required: false } is passed.
Prop
Type
OutField
interface declared in fields.ts
One declared field of a leaf's result, as returned by a field.* builder.
Prop
Type
Output
type declared in fields.ts
The result type inferred from a leaf's output object: required fields present, the rest optional, and each value typed from its field's manifest type.
{ [K in keyof O as O[K] extends { required: true; } ? K : never]: FieldValue<O[K]>; } & { [K in keyof O as O[K] extends { required: true; } ? never : K]?: FieldValue<O[K]> | undefined; }