Comments (5)
Found the answer in the unit tests, here is the way to do it:
struct.optional(User),
or another way
const User = struct.optional({
id: 'number',
name: 'string',
})
Maybe you will have to update the docs.
from superstruct.
The |
syntax should be documented too. It is already implemented.
Example :
meta: 'object | null'
from superstruct.
Documented now!
from superstruct.
struct.union([ 'object', 'null' ]
achieves the same thing, for those following this. Comes in handy when validating more complex objects.
from superstruct.
The set of possible operations on structs
(intersection, union, optional etc..) is already well documented here, except the one char short syntax. Got to be familiar with functional programming to connect the dots.
https://github.com/ianstormtaylor/superstruct/blob/master/docs/reference.md#structs
from superstruct.
Related Issues (20)
- Type-tests do not check for strict types
- Example coercion does not work. Have I done it right ? HOT 2
- [Question|Feature] Add functions to an interface
- [Feature] Support for `Required` HOT 1
- Please provide security reporting information or enable advisories
- `intersection` flattens unions too much HOT 1
- [Feature] `one of` or `or` type HOT 2
- [Feature] Discriminated unions (fast lookup) HOT 1
- `size` on `array` uses a permissive type
- Defaulted optional to undefined does not fill field with default value
- Never type creates a typescript issue
- Dynamic context property access
- Unexpected behaviour when combining `assign` + `refine`
- pattern (regex) does not return consistent output when using the global modifier
- Source maps seem broken HOT 4
- `instance` causes a TypeScript error with abstract classes
- Unions of instances produce unhelpful error message
- Fix compatibility with Node16/NodeNext moduleResolution HOT 4
- Mask fails on `interface aaa { foo: string; [key: string]: any }` interface with any key.
- Move tests to Vitest
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 superstruct.