https://github.com/devtin/duckfficer
Zero-dependencies light-weight library for modeling, validating and sanitizing data 🦆 🐵 👁
https://github.com/devtin/duckfficer
coercion data duck-typing json parsing schema validation
Last synced: 4 months ago
JSON representation
Zero-dependencies light-weight library for modeling, validating and sanitizing data 🦆 🐵 👁
- Host: GitHub
- URL: https://github.com/devtin/duckfficer
- Owner: devtin
- License: mit
- Created: 2019-12-16T19:09:59.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T04:27:43.000Z (over 2 years ago)
- Last Synced: 2025-02-02T15:36:26.608Z (5 months ago)
- Topics: coercion, data, duck-typing, json, parsing, schema, validation
- Language: HTML
- Homepage: https://devtin.github.io/duckfficer
- Size: 4.04 MB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
duckfficer
Zero-dependencies, light-weight library (~4.6KB minified + gzipped)
for modeling, validating & sanitizing data
## Manifesto
Performing duck-type validation and data sanitation is not what I came to this world for... I want a utility helping me
simplify that task.
This utility must:
- Check whether certain value has the shape of a predefined schema-type
- When a given value does not match the schema, it must offer a full report of what is wrong with the given
value vs what the schema is expecting! (see: [https://duckfficer.js.org/#/guide?id=error-handling-and-lifecycle](https://duckfficer.js.org/#/guide?id=error-handling-and-lifecycle))
- Be easy to extend and share schemas within each other (see: [https://duckfficer.js.org/#/guide?id=nesting-schemas](https://duckfficer.js.org/#/guide?id=nesting-schemas))
- Provide a built-in set of types for most common usages (see: [https://duckfficer.js.org/#/types](https://duckfficer.js.org/#/types))
- Allow custom types as well as a cast and transform hooks (see: [https://duckfficer.js.org/#/types?id=custom](https://duckfficer.js.org/#/types?id=custom))
Let's put hands on it!
**Index**
- [Installation](#installation)
- [About](#about)
- [At a glance](#at-a-glance)
- [Documentation](https://devtin.github.io/duckfficer)
## Installation
```sh
$ npm i duckfficer
# or
$ yarn add duckfficer
```
## At-a-glance
```js
const { Schema } = require('duckfficer')
// lets create a schema first
const User = new Schema({
firstName: String,
lastName: String,
get fullName () {
return this.firstName + ' ' + this.lastName
},
dob: Date,
contact: {
phoneNumber: {
type: Number,
autoCast: true // transforms String that look like a number into a Number
},
emails: {
default () {
return []
},
type: Array,
arraySchema: {
type: String,
regex: [/^[a-z0-9._]+@[a-z0-9-]+\.[a-z]{2,}$/, '{ value } is not a valid e-mail address']
}
}
}
})
User.parse({
firstName: 'Fulano de Tal',
contact: {
emails: ['fulanito']
}
})
.catch(err => {
console.log(err.message) // => Data is not valid
console.log(err.errors.length) // => 4
console.log(err.errors[0].message) // => Property lastName is required
console.log(err.errors[0].field.fullPath) // => lastName
console.log(err.errors[1].message) // => Property dob is required
console.log(err.errors[1].field.fullPath) // => dob
console.log(err.errors[2].message) // => Property contact.phoneNumber is required
console.log(err.errors[2].field.fullPath) // => contact.phoneNumber
console.log(err.errors[3].message) // => fulanito is not a valid e-mail address
console.log(err.errors[3].field.fullPath) // => contact.emails.0
})
User.parse({
firstName: 'Fulano',
lastName: 'de Tal',
dob: '1/1/2020',
contact: {
phoneNumber: '3051234567',
emails: [
'[email protected]',
'[email protected]'
]
}
})
.then(obj => {
console.log(obj.dob instanceof Date) // => true
console.log(typeof obj.contact.phoneNumber) // => number
console.log(obj) // =>
/*
{
firstName: 'Fulano',
lastName: 'de Tal',
dob: 2020-01-01T05:00:00.000Z,
contact: {
phoneNumber: 3051234567,
emails: [ '[email protected]', '[email protected]' ]
}
}
*/
})
```
[Read the documentation](https://devtin.github.io/duckfficer)
* * *
## License
[MIT](https://opensource.org/licenses/MIT)
© 2019-2020 Martin Rafael