check-types-mini

check-types-mini

Validate options object

Install

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required:

npm i check-types-mini

If you need a legacy version which works with require, use version 6.1.0

Quick Take

import { strict as assert } from "assert";
import { checkTypesMini } from "check-types-mini";

assert.throws(() => {
  checkTypesMini(
    checkTypesMini(
      {
        // object to check
        option1: "setting1",
        option2: "false",
        option3: false,
      },
      {
        // reference defaults object
        option1: "setting1",
        option2: false,
        option3: false,
      }
    ),
    /not boolean but string/g
  );
});

Documentation

Please visit codsen.com for a full description of the API and examples.

Contributing

To report bugs or request features or assistance, raise an issue on GitHub.

Licence

MIT License

Copyright (c) 2010-2021 Roy Revelt and other contributors