json-comb-core
v8.0.20
Published
The inner core of json-comb
Downloads
306
Maintainers
Readme
Install
This package is pure ESM. If you're not ready yet, install an older version of this program, 6.9.0 (npm i [email protected]
).
npm i json-comb-core
Quick Take
import { strict as assert } from "assert";
import {
getKeysetSync,
getKeyset,
enforceKeyset,
enforceKeysetSync,
sortAllObjectsSync,
noNewKeysSync,
findUnusedSync,
} from "json-comb-core";
// STEP #1
// =======
// calculate the schema - superset of all possible keys used across
// all JSON files
const schema = getKeysetSync([
{
// <- object #1
a: "a",
b: "c",
c: {
d: "d",
e: "e",
},
},
{
// <- object #2
a: "a",
},
{
// <- object #3
c: {
f: "f",
},
},
]);
assert.deepEqual(schema, {
a: false,
b: false,
c: {
d: false,
e: false,
f: false,
},
});
// STEP #2
// =======
// now we can normalise the object #2 for example:
assert.deepEqual(
enforceKeysetSync(
{
// <- object #2
a: "a",
},
schema,
),
{
a: "a",
b: false,
c: {
d: false,
e: false,
f: false,
},
},
);
Documentation
Please visit codsen.com for a full description of the API.
Contributing
To report bugs or request features or assistance, raise an issue on GitHub.
Licence
MIT License.
Copyright © 2010-2024 Roy Revelt and other contributors.