InspectModule

PackageReified.Schema

Inspect

Inspect.model turns a schema into finite metadata without parsing input or running application code. The result contains field names, nested shapes, union cases, and the inspectable constraints attached to each value.

Forms, admin interfaces, and documentation tools can use this model to choose controls and display rules before a user submits data. Opaque constraints remain identified as runtime-only because their predicates cannot be exported.

Summary

NameSignatureSynopsis
modelInspect.model schemaDescribes a built model schema as inspectable field metadata.
schemaInspect.schema schemaDescribes a value schema as inspectable shape, format, and constraint metadata.
fieldInspect.field fieldDescribes a standalone schema field as inspectable field metadata.

model

Inspect.model schema
Member
Describes a built model schema as inspectable field metadata.

Parameters

NameTypeDescription
schemaSchema<'model>The built model schema to describe.

Returns

ModelDescription

Verification Examples

let description = Inspect.model customerSchema
let names = description.Fields |> List.map _.Name

schema

Inspect.schema schema
Member
Describes a value schema as inspectable shape, format, and constraint metadata.

Parameters

NameTypeDescription
schemaSchema<'value>The value schema to describe.

Returns

SchemaDescription

field

Inspect.field field
Member
Describes a standalone schema field as inspectable field metadata.

Parameters

NameTypeDescription
fieldField<'model, 'value>The schema field to describe.

Returns

FieldDescription