Comments (2)
We finally solved this problem with another approach.
import { object, number, string, optional, Banditype } from 'banditypes'
type Simplify<T> = T extends Object ? { [K in keyof T]: T[K] } : T;
const personSchema = object({
name: string().or(optional()),
age: number(),
profession: string().or(optional()),
})
function withDefault<Schema extends object, Inputs extends Schema, Defaults extends Partial<Schema>> (
schema: Banditype<Schema>,
inputs: Inputs,
defaults: Defaults & { [K in keyof Defaults]: K extends keyof Schema ? Schema[K] : never },
) {
const data = schema(inputs);
const result = {
...defaults,
...data,
}
return result as Simplify<typeof result>;
}
const input = { age: 12 }
const person1 = withDefault(personSchema, input, { profession: 'John Doe' });
const person2 = withDefault(personSchema, input, { name: 'John Doe', foobar: 'azerty' }); // 1
const person3 = withDefault(personSchema, input, { name: 'John Doe' });
function showName(name: string) { console.log(name) }
showName(person1.name) // 2
showName(person2.name) // 3
showName(person3.name) // 4
- An error because foobar is not a key of personSchema
- An error because name was not provided in input nor in defaults
- No error because name was provided in defaults
- Same as 3
We hope this can help anyone which want to achieve this using banditypes =)
from banditypes.
Ah yes, I am playing with this idea. It enables quite a few data transformation scenarios, from one with a default value that you suggested to exhausive type normalization:
array(string())
.or(string().map(s => [s]))
.or(set(string()).map(s => [...s]))
Besides, I suppose it would help us to make proper union types with objectLoose({ x: string() }).or(objectLoose({ y: string }))
, where objectLoose
could be generic WRT the input of the or
.
I'm not yet sure how to implement it, or what the most convenient API would be for declaring narrow input types, so let's have it sit here for a while.
from banditypes.
Related Issues (8)
- docs: add minor note on the future of this lib HOT 2
- Breaking bug in 0.2.4 introduce by required in object HOT 3
- Function fail throw an error HOT 3
- optional handling in object HOT 4
- [Discussion] Object processing HOT 1
- [Bug] Schema for optional object properties with TS-first definition must be rquired
- [Bug] TS-first schemas allow stricter-than-needed checks HOT 2
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 banditypes.