inanisomnia / constrainjs

A pure javascript method of limiting and controlling the properties of native js objects and JSON objects, along with extra builtin methods to make js easier to use.

Constrain JS

A pure javascript method of limiting and controlling the properties of native js objects and JSON objects, along with extra builtin methods to make js easier to use.
Report bug · Request feature

WARNING Major updates are being made to this package without a version change as this package is not made for public release yet

See our docs for full documentation

Table of Contents

• Table of Contents
• Quick Start Guide
• What's included
• Compatibility
• Bugs and feature requests
• Contributing
• Authors
• Copyright and license

Quick Start Guide

Require the package

const constrainjs = require("constrainjs");
// or
const {ConstrainArray, ConstrainString} = require("constrainjs").native;

and start using the new native objects!

const myArray = ["hello", "world"];
const options = {
    maxLength: 5,
    allowedTypes: ["string"]
}
const myBetterArray = new ConstrainArray(myArray, options)

See our docs for further documentation

What's included

• Native
  • Array (A custom and constrainable version of the native Array object)
  • String (A custom and constrainable version of the native String object)
• JSON
  • Config (A JSON object access class, used by Schema for defining controlled schemas)
  • ConfigSchema (A Class used to define schemas and check objects against them)

Compatibility

See compatibility table

Bugs and feature requests

Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

VSCode Editor preferences are left available in the editor config to aid development, any changes made to this folder for personal preferences should NOT be committed to any PRs

Authors

Inanis

Main developer and package initiator

• https://github.com/lordfarquhar

If you would like to join this list, please feel free to send a pull request!

Copyright and license

Code released under the MIT License.

Enjoy

constrainjs's Issues

Generate empty

A method on the schema object that generates an empty json object with blank values (and any defaults) so it can be populated by other code or written to a file.

Default Parameters

Optionally, a default parameter can be passed into the CType. When this is passed, the optional parameter is presumed true and if not present in the config, it is replaced with the default value when called with parseConfig

Describe alternatives you've considered

• Separate methods can be used to return true or false if the config passes the schema and another method to return a parsed version of the config which has the default values put in place and any config options not defined in the schema removed

• Could also set the parameter to its default state if its the wrong type