npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

stygian

v1.1.1

Published

Function for combining schema and generating validators

Downloads

3

Readme

stygian

Function for combining schema and generating validators

Function takes a series of json schemas with keywords as defined in ajv-interface-keywords produces a validation function for the passed name

Example

module.exports = () => {
  const compile = require("../index");
  const passData = {
    a: {
      b: 2
    },
    c: {
      d: () => {}
    },
    e: {
      f: {
        g: "",
        i: true,
        l: {
          b: 4
        }
      },
      j: new Set()
    }
  };

  const interfaces = [
    {
      foo: {
        type: "object",
        properties: {
          b: {
            interface: "integer"
          }
        },
        required: ["b"]
      }
    },
    [
      {
        bar: {
          interface: "object",
          properties: {
            d: {
              return: {}
            }
          }
        }
      }
    ],
    [
      [
        [
          [
            [
              [
                {
                  baz: {
                    type: "object",
                    properties: {
                      f: {
                        type: "object",
                        properties: {
                          g: {
                            type: "string"
                          },
                          i: {
                            const: true
                          },
                          l: {
                            interface: "foo"
                          }
                        }
                      },
                      j: {
                        interface: "set"
                      }
                    }
                  }
                }
              ]
            ]
          ]
        ]
      ]
    ],
    {
      bing: {
        interface: "object",
        properties: {
          a: {
            interface: "foo"
          },
          c: {
            interface: "bar"
          },
          e: {
            interface: "baz"
          }
        },
        required: ["a", "c", "e"]
      }
    }
  ];

  return compile("bing", interfaces, { actionOnFail: "false" })(passData); // returns passData
};

Arguments

target

Interface name of the interface to generate a validator for, specified interface must be in interfaces

interfaces

Interfaces which will be flattened and merged, validates to interface

options

Defines how returned function will behave

Returns

function

Recieves value .target and tests if matches interface definition, function effect depends on .options

Options

actionOnConflict

What action to take when multiple interfaces of the same name are detected

default: overwrite

options

  • overwrite: Replace old interface of name with new interface

  • ignore: Keep old interface of name

  • warn-overwrite: Replace old interface of name with new interface of name and print warning

  • warn-ignore: Keep old interface of name and print warning

  • throw: Throw error on interface name conflict

actionOnFail

What action to take when a validation fails

default: throw

options

  • throw: Throw on validate fail

  • warn: Print warning and return target on validate fail

  • false: Return false on validate fail

Static functions

resolveMacrosAllOf

resolve macros with allOf pattern

resolveMacrosDeepmerge

resolve macros with deepmerge pattern

resolveMacrosMerge

resolve macros with merge pattern