Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aminnairi/node-decode
Check that your data meet your expectations
https://github.com/aminnairi/node-decode
check data decode expectations schema
Last synced: about 5 hours ago
JSON representation
Check that your data meet your expectations
- Host: GitHub
- URL: https://github.com/aminnairi/node-decode
- Owner: aminnairi
- License: gpl-3.0
- Created: 2021-03-25T12:54:42.000Z (over 3 years ago)
- Default Branch: next
- Last Pushed: 2021-03-25T13:25:32.000Z (over 3 years ago)
- Last Synced: 2024-11-13T02:11:25.316Z (3 days ago)
- Topics: check, data, decode, expectations, schema
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@aminnairi/decode
- Size: 42 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# node-decode
Check that your data meet your expectations.
[](https://github.com/aminnairi/node-decode/actions/workflows/test.yaml) [](https://github.com/aminnairi/node-decode/actions/workflows/publish.yaml)
## Requirements
- Node
## Usage
### Simple
```console
$ npm install @aminnairi/decode
$ touch index.mjs
```
```javascript
import {decode} from "@aminnairi/decode";
const schema = "string";
const goodData = "Hello world";
const badData = 123;
console.log(decode(schema, goodData));
console.log(decode(schema, badData));
```
```console
$ node index.mjs
true
false
```
### Array
```console
$ npm install @aminnairi/decode
$ touch index.mjs
```
```javascript
import {decode} from "@aminnairi/decode";
const schema = ["string"];
const goodData = ["Hello", "world"];
const badData = ["Hello", 123];
console.log(decode(schema, goodData));
console.log(decode(schema, badData));
```
```console
$ node index.mjs
true
false
```
### Object
```console
$ npm install @aminnairi/decode
$ touch index.mjs
```
```javascript
import {decode} from "@aminnairi/decode";
const schema = {user: "string", age: "number"};
const goodData = {user: "john", age: 42};
const badData = {user: "jane", age: "24"};
console.log(decode(schema, goodData));
console.log(decode(schema, badData));
```
```console
$ node index.mjs
true
false
```
### Object (loose)
```console
$ npm install @aminnairi/decode
$ touch index.mjs
```
```javascript
import {decode} from "@aminnairi/decode";
const schema = {user: "string", age: "number"};
const goodData = {user: "john", age: 42, isAdmin: false};
const badData = {user: "jane", age: "24", isAdmin: false};
console.log(decode(schema, goodData));
console.log(decode(schema, badData));
```
```console
$ node index.mjs
true
false
```
### Array of objects
```console
$ npm install @aminnairi/decode
$ touch index.mjs
```
```javascript
import {decode} from "@aminnairi/decode";
const schema = [{user: "string", age: "number"}];
const goodData = [{user: "john", age: 42}, {user: "jane", age: 24}];
const badData = [{user: "john", age: "42"}, {user: "jane", age: 24}];
console.log(decode(schema, goodData));
console.log(decode(schema, badData));
```
```console
$ node index.mjs
true
false
```
## Example
```console
$ npm install node-fetch @aminnairi/decode
$ touch index.mjs
```
```javascript
import fetch from "node-fetch";
import {decode} from "@aminnairi/decode";
const usersSchema = [{
id: "number",
name: "string",
username: "string",
email: "string",
address: {
street: "string",
suite: "string",
city: "string",
zipcode: "string",
geo: {
lat: "string",
lng: "string"
}
},
phone: "string",
website: "string",
company: {
name: "string",
catchPhrase: "string",
bs: "string"
}
}];
fetch("https://jsonplaceholder.typicode.com/users/").then(response => {
return response.json();
}).then(users => {
if (!decode(usersSchema, users)) {
throw new Error("Bad response from the server (has the API changed?)");
}
console.log("Do something with the users.");
}).catch(({message}) => {
console.error(message);
});
```
```console
$ node index.mjs
Do something with the users.
```
## Changelog
See [`CHANGELOG.md`](./CHANGELOG.md).
## Contributing
See [`CONTRIBUTING.md`](./CONTRIBUTING.md).
## License
See [`LICENSE`](./LICENSE).