open-draft / reach-schema Goto Github PK

What

Need to have a validation mode where extra object properties would cause validation errors.

Why

To validate strict object shapes.

When using the optional utility it returns a type that is not compatible with the SchemaValue type expected by the schema keys.

What

Need to support Array validation.

1. Array as a value of object's property.
2. Root-level Array.

How

• Have a "mask" approach, where all Array members must satisfy a predicate.
• Have an index-based approach, where each Array member may have unique predicate.

When installed, [email protected] has no published TypeScript definitions file, and therefore has no suggestions and autocompletion when being used.

Reach Schema should come with a sensible default behavior. However, ceratin use cases may want to modify how a schema is applied. Examples of such modifications may be:

• Custom resolver function arguments
• Custom actual data traversal method

Specification

import { createSchemaFunctor } from 'reach-schema'

const applyCustomSchema = createSchemaFunctor({
  traverse: (tree, node) => {},
  resolver: (value) => {}
})

applyCustomSchema({
  data: ({ value }) => value !== 2
}, {
  data: 'value'
})

Call signatures to be designed