Docs
Reference
Packages
GitHub
0.1.0
0.1.0
light
dark
MessageDescriptor
Record
Package
Reified.Constraint
A message identity and the operands its template may interpolate.
Fields
Name
Type
Description
Segments
Segments
No description available.
Values
Values
No description available.
Filter
Overview
Home
API Reference
Docs
Getting Started
Getting Started
What a schema gives you
Where to go next
Result handling
Result handling
Quickstart
Creating a Result
Transforming values
Handling errors
Extracting values
Working with collections
Observing a Result
The result computation expression
Collecting every error
Constraints
Constraints
Quickstart
ConstraintDSL
Using constraints
Constraint
Interpreted and opaque
Working with violations
Localization
Localization
Context and fallback
Custom rules
Advanced rendering
The key catalogue
Adding a language
Fable support
Constraint tutorials
Constraint tutorials
Constraint and Result Tutorial
Introductory Reference App
Parsing
Parsing
Refined
Refined
Built-in Refined Values
Compose Parse and Refinement
Define Refined Types
Schema Integration
Tutorials
Tutorials
Order Totals Tutorial
Customer Id Tutorial
Data
Data
Build, vary, and test structured data
Using Data with Reified
What Data represents
DataDSL
Declare, render, and edit data
Match selected parts of data
Numbers
Convert data and parse JSON
Build variations and matrices
Test Schema Guarantees
Compare complete data
Schema
Schema
Quickstart
Schema Tutorials
Schema Tutorials
Signup Form Tutorial
Nested Models And Collections Tutorial
Inspecting Schema Metadata Tutorial
SchemaDSL
Input Sources
Field Blocks and Plain Functions
Redisplay And Field Errors
Construction Guarantees
Refined Schemas
Union Schemas
Advanced Union Handling
JSON Codecs
Derived Schemas
Derived Schemas
Build Generation
Derivation Attributes
Schema Inference
Versioned Contracts
Recommended Patterns
Recommended Patterns
Build A Private Aggregate
Model Legal Transitions
Separate Wire And Domain Models
Split A Larger Application
Runnable Examples
Walkthrough: Reference Apps
Comparisons
Comparisons
How it compares
vs FluentValidation
vs zod
FsToolkit.ErrorHandling
Notes
Notes
Benchmarks
Compiler-Directed, AOT, and Fable
Packages and platforms
API Reference
Reified.Constraint
Catalogue
Constraint
BlankDispatcher
CardinalityDispatcher
ContainsDispatcher
DistinctDispatcher
MultipleOfDispatcher
NotContainsDispatcher
OptionalDispatcher
PresentDispatcher
ConstraintAtom
ConstraintDSL
ConstraintDescription
ConstraintValue
ConstraintValueInternals
MessageDescriptor
Advanced
MessageFormatSpec
Advanced
Renderer
Advanced
UnsupportedOperation
Violation
AtomicViolation
Cardinality
Constraint<'value>
ConstraintAtom
ConstraintDescription
ConstraintExpression
ConstraintValue
Format
Membership
MessageDescriptor
MessageFormatSpec
MessageFormatSpecError
MessageKeyError
MessageLeaf
MessageLookup
MessageRequest
MessageResolution
MessageResolver
MessageTree
Number
OpaqueConstraint
PortableFloat
PortableFloat32
Presence
Relation
RelationOperator
Renderer
UnsupportedOperation
ValueFormatRequest
Violation
Reified.Data
Data
Json
DataDSL
DataEdit
DataErgonomicsHelpers
DataPath
Data
DataCase
DataDifference
DataDifferenceCause
DataDimension
DataEdit
DataExpectation
DataField
DataMatchException
DataMismatch
DataPatchException
DataPatchFailure
DataPath
DataPathSegment
DataPattern
DataVariation
PatternConversion
Reified.Parse
Parse
ParseError
Reified.Refinements
Bounded
BoundedFloat
DistinctList
FiniteFloat
FiniteFloat32
Interval
NonBlankString
NonEmptyArray
NonEmptyList
Refine
Character
Choice
Collection
Text
Refinement
UnitInterval
Bounded<'value>
DateRange
DistinctList<'value>
FiniteFloat
FiniteFloat32
Interval<'value>
NonBlankString
NonEmptyArray<'value>
NonEmptyList<'value>
Refinement<'underlying, 'refined>
UnitInterval
Reified.Result
Result
Reified.Schema
Contract
EnumCase
ExternalFieldName
Field
FieldOrder
Inspect
JsonSchema
RefinedSchemas
RetainedParseResult
Schema
SchemaCheck
SchemaDSL
SchemaError
SchemaErrors
SchemaFormat
SchemaMessages
SchemaPath
SchemaValidation
UnionCase
UnionRepresentations
Contract<'model>
ContractBuilder<'model, 'current>
ContractError
EnumCase<'enum>
EnumCaseDescription
EnumDescription
ExternalFieldName
Field<'model, 'value>
FieldDescription
FieldOrder
IRecordPlanCompiler<'model, 'result>
IRecordPlanState<'model, 'constructorIn, 'constructorOut>
MigrationError
ModelDescription
PrimitiveValueKind
RetainedParseResult<'value>
Schema<'model>
SchemaDefaults
SchemaDescription
SchemaError
SchemaErrors
SchemaFormat
SchemaIssue
SchemaParseOptions
SchemaPath
SchemaShape
Supply
UnionCase<'union>
UnionCaseDescription
UnionCaseShape
UnionDescription
UnionPayloadStyle
UnionRepresentation
VersionSource
field<'model, 'target>
DerivedSchema
AtLeastAttribute
AtMostAttribute
DefaultAttribute
DeriveSchemaAttribute
DeriveUnionAttribute
DistinctAttribute
EmailAttribute
FormatAttribute
GreaterThanAttribute
LengthAttribute
LengthBetweenAttribute
LessThanAttribute
MaxAttribute
MinAttribute
MultipleOfAttribute
PatternAttribute
PresentAttribute
SchemaConstructorAttribute
SchemaNameAttribute
SuppliedAttribute
UnionPayloadStyleKind
UnionRepresentationKind
Reified.Schema.Contracts
Emitter
FieldDecl
Parser
Records
Resolver
Annotation
ConstraintDecl
ContractDecl
ContractDiagnostic
ContractFile
ContractRef
ExternalEnumCase
ExternalUnionCase
ExternalUnionField
ExternalUnionPayload
ExternalUnionRepresentation
FieldDecl
FieldType
Literal
PrimitiveType
SchemaNaming
UnionCaseDecl
Reified.Schema.Json
Json
JsonCodec<'model>
JsonCodecException
Reified.Schema.Testing
SchemaGen
SchemaGenerationError
