Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

genson-js

Package Overview
Dependencies
Maintainers
5
Versions
7
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

genson-js

JSON schema generator with a possibility to merge schemas

  • 0.0.8
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
14K
decreased by-21.68%
Maintainers
5
Weekly downloads
 
Created
Source

genson-js

Build PRs Welcome TypeScript NPM version

genson-js is a user-friendly JSON Schema generator built in TypeScript/JavaScript.

This is not the JavaScript equivalent of the Java Genson library. The motivation for this library was to port GenSON python library to JS, however having exactly the same api or possiblities was not a goal.

genson-js's core function is to take JSON objects and generate schemas that describe them, with an ability to merge schemas.

Usage

Creating schemas

To infer a schema from existing object:

import { createSchema } from 'genson-js';

const schema = createSchema({
    userName: 'smith',
    languages: ['c++', 'java'],
    age: 40,
});

The following schema will be created:

{
  type: "object",
  properties: {
    userName: {
      type: "string",
    },
    languages: {
      type: "array",
      items: {
        type: "string",
      },
    },
    age: {
      type: "integer",
    },
  },
  required: ["userName", "languages", "age"],
};

Merging schemas

You can merge 2 or more schemas, so that merged schema would be kind of a superset of the schemas that it was built from:

import { mergeSchemas } from 'genson-js';

const merged = mergeSchemas([{ type: ValueType.Number }, { type: ValueType.String }]);

// will create merged schema like this:
// { type: ['number', 'string'] }

Create compound schema

Shorthand for createSchema + mergeSchemas.
Can take multiple inputs and create one compound schema:

import { createCompoundSchema } from 'genson-js';

const schema = createCompoundSchema([{ age: 19, name: 'John' }, { age: 23, admin: true }, { age: 35 }]);

// Will create the following schema:
// {
//   type: 'object',
//   properties: { admin: { type: 'boolean' }, age: { type: 'integer' }, name: { type: 'string' } },
//   required: ['age']
// }

Exending schemas

You can extend existing schema to match some value:

import { extendSchema } from 'genson-js';

const extended = extendSchema({ type: ValueType.Number }, 'some string');

// will create extended schema like this:
// { type: ['number', 'string'] }

Comparing schemas

You can compare 2 schemas for equality like this:

import { areSchemasEqual } from 'genson-js';

areSchemasEqual({ type: ValueType.Number }, { type: ValueType.Number });
// will return true

Subset

You can also check if one schema is a subset of another one like so:

import { isSubset } from 'genson-js';

isSubset(
    { type: ValueType.Array, items: { type: [ValueType.Boolean, ValueType.Integer] } },
    { type: ValueType.Array, items: { type: [ValueType.Boolean] } }
);
// will return true

You can find more examples in the unit tests.

Keywords

FAQs

Package last updated on 12 Jan 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc