Skip to content

🛰 Skema provides a handy & composable way to validate / transform / purify the input data.

License

Notifications You must be signed in to change notification settings

kaelzhang/skema

Folders and files

NameName
Last commit message
Last commit date

Latest commit

May 5, 2020
f0ea054 · May 5, 2020
Jan 31, 2018
Jan 28, 2018
May 5, 2020
Jan 7, 2017
Oct 16, 2018
Jan 7, 2017
May 5, 2020
Jan 7, 2017
Mar 29, 2019
Jun 29, 2018
Jan 7, 2017
Mar 11, 2019
Jan 7, 2017
Jan 23, 2018
May 5, 2020

Repository files navigation

Build Status Coverage

skema

skema provides a handy and composable way to validate/transform JavaScript variables:

  • Supports both async and sync flows. Skema has two working modes to support either async or sync validators, setters, etc, making it capable with much more complicated challenges.

  • NOT only type checker. Unlike TypeScript, joi, and many others, Skema is not only a JavaScript type checker, but also a good solution for your Anti-Corruption Layer (ACL) to transform and purify the input data. And Skema could also be configured as a simple schema validator too.

  • Pluggable basic types. Even basic types such as Number could also be replaced and customized if using Skema. Actually, in the core of Skema, there is NOT a single definition of one type.

  • Powerful custom types. Every single type is able to be customized that you can handle almost everything including descriptor, conditions, default values, validators and so on.

  • Composable structures. You could build a much bigger schema with the small ones into the whole world.

Install

npm i skema

Basic Usage

🔬 Live Demo with JsFiddle

import {shape} from 'skema'

// Schema definitions are ONLY objects.
const User = shape({
  id: 'number?',
  name: String
})

// Then use these definitions to purify our data.
const user = User.from({
  id: '1',
  name: 'Steve'
})

console.log(user)
// {
//   id: 1,
//   name: 'Steve'
// }

user.id = 'boooom!'
// throw TypeError
// - message: 'not a number'
// - code: 'VALIDATION_FAILS'

Documentations

Many Examples

Related Packages

  • @skema/basic The default built-in javascript types of skema.

License

MIT

About

🛰 Skema provides a handy & composable way to validate / transform / purify the input data.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published