README

jijejo-node is a collection of functions to create and validate json compliant with jijejo-spec/functions.md specifications.

Jijejo is a universal and easy api for all yours applications or libraries. Jijejo is a human and light alternative of json:api, json-ld, hal, OpenAPI, GraphQL, joi, zod, yup, hydra ... Back to basics to get ahead in your business. Read more by visiting jijejo-spec.

jijejo = (j)son (i)n + (j)son (e)rr + (j)son (o)ut

install

npm install jijejo-node

usage

import { jsonin, jsonerr, jsonout, jicheck, jecheck, jocheck } from 'jijejo-node';

functions

creates

jsonin

function to create jsonin.

jsonin({"hello": "in"}) // return { meta:{}, in: {"hello": "in"}}
jsonin({"hello": "in"}, {"hello": "meta"}) // return { meta:{"hello": "meta"}, in: {"hello": "in"}}

jsonerr

function to create jsonerr.

jsonerr({"hello": "err"}) // return { meta:{}, iserr: true, isout: false, err: {"hello": "err"}}
jsonerr({"hello": "err"}, {"hello": "meta"}) // return { meta:{"hello": "meta"}, iserr: true, isout: false, out: {"hello": "err"}}

jsonout

function to create jsonout.

jsonout({"hello": "out"}) // return { meta:{}, iserr: false, isout: true, out: {"hello": "out"}}
jsonout({"hello": "out"}, {"hello": "meta"}) // return { meta:{"hello": "meta"}, iserr: false, isout: true, out: {"hello": "out"}}

checks

jicheck = (j)son (i)n (check)

This function must verify jsonin basic attributs.

jicheck({}); // return error because missing attribut in
jicheck({ in: {} }); // return ok, jsonin is valid

jecheck = (j)son (e)rr (check)

This function must verify jsonerr basic attributs.

jecheck({ isout: true, iserr: true, err: {} }); // return error because isout==true
jecheck({ isout: false, iserr: true, err: {} }); // return ok, jsonerr is valid

jocheck = (j)son (o)ut (check)

This function must verify jsonout basic attributs.

jocheck({ isout: true, iserr: true, out: {} }); // return error because iserr==true
jocheck({ isout: true, iserr: false, out: {} }); // return ok, jsonout is valid

development

git clone https://github.com/AlbanMinassian/jijejo-node
cd jijejo-node
npm install
npm run test
npm run coverage

license

MIT

albanminassian / jijejo-node Goto Github PK

jijejo-node's Introduction