Comments (1)
@MentalGear Hi,
Check
TypeBox will terminate on the first error with Check
by default. Internally, this is done using chained logical expressions (A && B && C
) where if A
fails, condition B
and C
are not checked.
const A = () => { console.log('A'); return false }
const B = () => { console.log('B'); return true }
const C = () => { console.log('C'); return true }
const R = A() && B() && C() // only A is printed
All checks are implemented using logical expressions like the above.
Errors
Unlike Check, TypeBox uses an iterator system for Errors. Because errors may need to be exhaustive, the Check logic is re-implemented for the Errors to "NOT use chained expressions" and to "NOT terminate on error". Instead the Errors function will yield
at each failure case and continue
....the caller receiving the errors can chose to yield only the first (terminate on error) or all (exhaustive checking)
const T = Type.Object({ ... })
const F = Value.Errors(T, { ... }).First() // terminate at first error
const A = [...Value.Errors(T, { ... })] // exhaustive errors
This means that there no need to implement a strict mode, as the caller can chose either first
or exhaustive
processing by receiving values of the iterator.
Usage
Putting it all together, the following implements a Parse function using both Check and Errors.
import { Type, Static, TSchema } from '@sinclair/typebox'
import { Value } from '@sinclair/typebox/value'
export function Parse<T extends TSchema>(schema: T, value: unknown): Static<T> {
if(Value.Check(schema, value)) return value // check and return
const first = Value.Errors(schema, value).First()! // optionally gather diagnostics
throw Error(first.message) // ... and throw
}
const A = Parse(Type.String(), 'hello')
from typebox.
Related Issues (20)
- Clean call on extended prisma result object does not work HOT 2
- esm.sh builds are broken if using FormatRegistry HOT 1
- Circular references HOT 4
- Value.Clean causes dereference error on Recursive type with nullable optional union HOT 2
- How to work with dates and timestamps HOT 2
- Issue regarding enums becoming never when using a partial deep method HOT 2
- Support for composite custom kinds HOT 1
- transform object property encoding HOT 4
- Built-in types for JSON? HOT 1
- MaxLength on keys defining a Type.Record HOT 2
- decode object with null prototype HOT 3
- Validate Enum at a low level HOT 4
- AOT compilation using custom registered types HOT 2
- Uses of BigInt over the project breaks compatibility w/ ES5 (?) HOT 3
- Typescript doesn't suggests the props using Pick or Omit HOT 1
- UUID not accpeted as string HOT 2
- How to import just Decode? HOT 4
- How to check if a schema conforms? HOT 2
- email validation doesn't work? HOT 2
- `Value.Cast` casts to wrong schema when called with union of `Refs` HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from typebox.