From a2a426adcca5be9748e19a5c02e21c7a1b26064a Mon Sep 17 00:00:00 2001 From: Sven Slootweg Date: Tue, 26 May 2020 02:52:49 +0200 Subject: [PATCH] Initial commit --- .gitignore | 1 + README.md | 5 +++++ example.js | 11 +++++++++++ index.js | 10 ++++++++++ package.json | 17 +++++++++++++++++ yarn.lock | 20 ++++++++++++++++++++ 6 files changed, 64 insertions(+) create mode 100644 .gitignore create mode 100644 README.md create mode 100644 example.js create mode 100644 index.js create mode 100644 package.json create mode 100644 yarn.lock diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3c3629e --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +node_modules diff --git a/README.md b/README.md new file mode 100644 index 0000000..7444545 --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +# @validatem/is-boolean + +Documentation for this module has not been written yet. By the time it reaches 1.0.0, it will have full documentation. + +In the meantime, check out the `example.js` file in the repository for a usage demonstration. diff --git a/example.js b/example.js new file mode 100644 index 0000000..1c6c438 --- /dev/null +++ b/example.js @@ -0,0 +1,11 @@ +"use strict"; + +const { validateValue } = require("@validatem/core"); /* FIXME: Add to devDependencies */ +const isBoolean = require("./"); + +console.log(validateValue(false, [ isBoolean ])); // false + +console.log(validateValue("hello world", [ isBoolean ])); /* + AggregrateValidationError: One or more validation errors occurred: + - At (root): Must be a boolean +*/ diff --git a/index.js b/index.js new file mode 100644 index 0000000..4183477 --- /dev/null +++ b/index.js @@ -0,0 +1,10 @@ +"use strict"; + +const ValidationError = require("@validatem/error"); +const isBooleanObject = require("is-boolean-object"); + +module.exports = function (value) { + if (!isBooleanObject(value)) { + throw new ValidationError("Must be a boolean"); + } +}; diff --git a/package.json b/package.json new file mode 100644 index 0000000..bcfc73c --- /dev/null +++ b/package.json @@ -0,0 +1,17 @@ +{ + "name": "@validatem/is-boolean", + "description": "Validatem validator for ensuring that a value is a boolean", + "keywords": [ + "validatem", + "validator" + ], + "version": "0.1.0", + "main": "index.js", + "repository": "http://git.cryto.net/validatem/is-boolean.git", + "author": "Sven Slootweg ", + "license": "WTFPL OR CC0-1.0", + "dependencies": { + "@validatem/error": "^1.0.0", + "is-boolean-object": "^1.0.1" + } +} diff --git a/yarn.lock b/yarn.lock new file mode 100644 index 0000000..64d9f3a --- /dev/null +++ b/yarn.lock @@ -0,0 +1,20 @@ +# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. +# yarn lockfile v1 + + +"@validatem/error@^1.0.0": + version "1.0.0" + resolved "https://registry.yarnpkg.com/@validatem/error/-/error-1.0.0.tgz#a975904aa4c3e7618d89088a393567a5e1778340" + integrity sha512-7M3tV4DhCuimuCRdC2L/topBByDjhzspzeQGNU0S4/mdn2aDNtESYE43K/2Kh/utCAhqXh2gyw89WYxy//t3fQ== + dependencies: + create-error "^0.3.1" + +create-error@^0.3.1: + version "0.3.1" + resolved "https://registry.yarnpkg.com/create-error/-/create-error-0.3.1.tgz#69810245a629e654432bf04377360003a5351a23" + integrity sha1-aYECRaYp5lRDK/BDdzYAA6U1GiM= + +is-boolean-object@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/is-boolean-object/-/is-boolean-object-1.0.1.tgz#10edc0900dd127697a92f6f9807c7617d68ac48e" + integrity sha512-TqZuVwa/sppcrhUCAYkGBk7w0yxfQQnxq28fjkO53tnK9FQXmdwz2JS5+GjsWQ6RByES1K40nI+yDic5c9/aAQ==