FieldType
PackageReified.Schema
Functions for inspecting schema field metadata.
Specification
Kind
Type
Members
11
Examples
0
createSignature
Field.create externalName getter value
externalNameSignature
Field.externalName field
aliasesSignature
Field.aliases field
withAliasSignature
Field.withAlias alias field
withAliasesSignature
Field.withAliases aliases field
Summary
| Name | Signature | Synopsis |
|---|---|---|
| Operations | ||
| create | Field.create externalName getter value | Creates a standalone typed schema field from a boundary-facing name, a trusted-model getter, and a trusted value schema. |
| externalName | Field.externalName field | Returns the boundary-facing name for a schema field. |
| aliases | Field.aliases field | Returns the alternate input names accepted for a schema field. |
| withAlias | Field.withAlias alias field | Returns a schema field that also accepts one exact, input-only alternate name. |
| withAliases | Field.withAliases aliases field | Returns a schema field that also accepts the exact, input-only alternate names. |
| order | Field.order field | Returns the zero-based field order used for trusted construction and ordered interpreter output. |
| getValue | Field.getValue field model | Reads a schema field value from an existing trusted model. |
| constraints | Field.constraints field | Returns the constraint descriptions attached to a schema field, in declaration order. |
| supply | Field.supply field | Returns the boundary supply declaration attached to a schema field, when one was made. |
| withConstraint | Field.withConstraint constraint' field | Returns a schema field with additional portable constraint metadata appended in declaration order. |
| withConstraints | Field.withConstraints constraints field | Returns a schema field that also requires every supplied constraint, in declaration order. |