Comments (4)
@GorvGoyl Hi,
This part of the API is a little bit in flux currently, however you can import the TransformDecode
function which performs the interior decode op, but not the check. You can wire this up into a custom Parse function as follows (which should tree shake for other functionality)
import { Type, TSchema, StaticDecode } from '@sinclair/typebox'
import { Check, TransformDecode } from '@sinclair/typebox/value'
import { Errors } from '@sinclair/typebox/errors'
const T = Type.Object({
x: Type.Number(),
y: Type.Number(),
z: Type.Number()
})
export function Parse<T extends TSchema, D = StaticDecode<T>>(schema: T, value: unknown): D {
if(!Check(schema, value)) throw new Error('Invalid value', { cause: Errors(schema, value).First() })
return TransformDecode(schema, [], value) as D
}
const value = Parse(T, { x: 1, y: 2, z: 3 })
console.log(value)
The TransformDecode function is currently treated as an internal function but would like to promote this API as the preferred Decode function in later revisions. The function returns unknown
(so you need to type assert the return value) and expects the value to be checked before calling it (as above).
Hope this helps
S
from typebox.
@GorvGoyl Hiya,
Might close off this issue. As above you can import TransformDecode which should provide the functionality you need, just be sure to Check the value prior to calling the function.
If you have any follow up questions, feel free to ping on this thread
Cheers
S
from typebox.
Thanks. this seems a bit much for such common use case. Would you consider providing one simple function to achieve this?
from typebox.
Thanks. this seems a bit much for such common use case. Would you consider providing one simple function to achieve this?
Yes, I'm planning to sort this out on the next minor revision.
from typebox.
Related Issues (20)
- Covariance issue with `TypeCheck<TSchema>` and `TypeCheck<TObject<{}>>` HOT 1
- Default values in nested objects are not generated HOT 2
- Doubt on Record HOT 2
- TypeCompiler compile on Type.Strict(T) - Preflight validation check failed to guard for the given schema HOT 2
- Max call stack size exceeded HOT 1
- Value.Convert() doesn't work with nullable record HOT 1
- Variadic Any Typed function parameters HOT 2
- How to do a cross field validation? HOT 3
- Undefined is incorrectly handled in Diff HOT 3
- QoL helper: `TypeCheck.Ensure` HOT 3
- Usage of `Type.Composite` with `Type.TemplateLiteral` HOT 3
- `Check` doesn't validate strings with enums HOT 4
- `Type.Omit` mixed with `Type.Union` is not preserving the `additionalProperties` attribute HOT 2
- Advice to compose types HOT 3
- Access to schema properties for non TObject schemas HOT 5
- Type.Optional with Type.Transform unexpected behaviour HOT 1
- ts(7056) when you try to export a big union type HOT 1
- `Value.Default` does not traverse object schema HOT 2
- Unable to use a union of literal as record key type after upgrading version HOT 2
- Unknown format 'email' after update HOT 3
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.