SchemaDSLModule
PackageReified.Schema
The concise schema-definition vocabulary: the record computation expression, its field and constructor
forms, and the collection-schema operations.
Summary
| Name | Signature | Synopsis |
|---|---|---|
| Operations | ||
| schema | schema | Record-schema computation expression. |
| case | case tag | Starts one named-field union case. |
| tryExtract | tryExtract tryPayload | Selects the union case and exposes its field payload. |
| fieldAs | fieldAs name getter | Declares a field under an explicit wire name, for when the name differs from the property and for portable code. |
| construct | construct constructor | Closes a record schema with a total constructor. |
| constructResult | constructResult constructor | Closes a record schema with a checked constructor. |
| constrainItems | constrainItems constraint' schema | Adds a constraint to every item described by a list schema. |
| constrainValues | constrainValues constraint' schema | Adds a constraint to every value described by a string-keyed map schema. |
Operations
kind:member
Starts one named-field union case.
Parameters
| Name | Type | Description |
|---|---|---|
| tag | string |
Returns
UnionCaseBuilder<'union, 'payload>
Verification Examples
let tryVolumeCase = function Volume amount -> Some amount | _ -> None
case "volume" {
tryExtract tryVolumeCase
fieldAs "amount" id
construct Volume
}kind:member
kind:member
Declares a field under an explicit wire name, for when the name differs from the property and for
portable code.
Parameters
| Name | Type | Description |
|---|---|---|
| name | string | |
| getter | 'model -> 'value |
Returns
field<'model, 'value>
Verification Examples
type Signup = { Email: string }
fieldAs "email_address" (fun (s: Signup) -> s.Email)kind:member
kind:member
kind:member
kind:member
Adds a constraint to every value described by a string-keyed map schema.
Parameters
| Name | Type | Description |
|---|---|---|
| constraint' | Constraint<'item> | |
| schema | Schema<Map<string, 'item>> |
Returns
Schema<Map<string, 'item>>
Verification Examples
Schema.map () |> constrainValues Constraint.present