Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
typeof-arguments
Advanced tools
typeof-arguments - npm Package Compare versions
Comparing version 4.0.0 to 5.0.0
| { | ||
| "name": "typeof-arguments", | ||
| "version": "4.0.0", | ||
| "description": "Validate the types of arguments passed to the function.", | ||
| "main": "src/index.js", | ||
| "version": "5.0.0", | ||
| "description": "Validate the type of arguments passed through the function.", | ||
| "main": "dist/typeof-arguments.node.js", | ||
| "scripts": { | ||
| "test": "node tests/jasmine.conf.js", | ||
| "build": "webpack --config webpack.config.js" | ||
| "test": "babel-node jasmine.conf.js", | ||
| "start": "webpack --config webpack.dev.js", | ||
| "build": "webpack --config webpack.prod.js" | ||
| }, | ||
@@ -21,3 +22,3 @@ "keywords": [ | ||
| "dependencies": { | ||
| "of-type": "^2.2.0" | ||
| "of-type": "^3.0.0" | ||
| }, | ||
@@ -33,11 +34,15 @@ "homepage": "https://github.com/devrafalko/typeof-arguments#readme", | ||
| "devDependencies": { | ||
| "babel-cli": "^6.26.0", | ||
| "babel-loader": "^7.1.5", | ||
| "babel-preset-env": "^1.7.0", | ||
| "jasmine": "^3.1.0", | ||
| "@babel/cli": "^7.1.0", | ||
| "@babel/core": "^7.0.1", | ||
| "@babel/node": "^7.0.0", | ||
| "@babel/preset-env": "^7.0.0", | ||
| "babel-loader": "^8.0.2", | ||
| "jasmine": "^3.3.1", | ||
| "jasmine-spec-reporter": "^4.2.1", | ||
| "uglifyjs-webpack-plugin": "^1.2.7", | ||
| "webpack": "^4.16.1", | ||
| "webpack-cli": "^3.1.0" | ||
| "uglifyjs-webpack-plugin": "^1.3.0", | ||
| "webpack": "^4.19.1", | ||
| "webpack-cli": "^3.1.1", | ||
| "webpack-merge": "^4.1.4", | ||
| "webpack-node-externals": "^1.7.2" | ||
| } | ||
| } |
166
readme.md
| # Description | ||
| `typeof-arguments` is a module that validates arguments' types passed to the enclosing function. | ||
| * Any bugs found? Give me to know on [GitHub](https://github.com/devrafalko/typeof-arguments) | ||
| * Also check out [**`of-type`**](https://www.npmjs.com/package/of-type) package that checks whether the given value is of particular type *(`typeof-arguments` is based on `of-type` package)*. | ||
| * Also check out [**`typeof-properties`**](https://www.npmjs.com/package/typeof-properties) to validate value types of the properties of objects. | ||
| `typeof-arguments` validates the arguments' types passed through the enclosing function. | ||
| # Installation | ||
| ### Node | ||
| * Also see [`of-type`](https://www.npmjs.com/package/of-type) package to check if the given value|object is of expected type. | ||
| * Also see [`typeof-properties`](https://www.npmjs.com/package/typeof-properties) to validate the object's properties' type. | ||
| # Implementation | ||
| #### with NodeJS | ||
| `npm install typeof-arguments` | ||
@@ -15,22 +16,34 @@ | ||
| ### Browsers | ||
| Load the `typeof-arguments.min.js` file from the `src` folder into your `.html` file. | ||
| The module is accessible as `typeofArguments` in the global scope. | ||
| It is a `babel` converted and `webpack` bundled crossbrowser module version. | ||
| #### with Browser | ||
| #### Add `typeof-arguments.js` library to the HTML file. | ||
| The library is located in `./dist/typeof-arguments.js` directory. | ||
| It is a webpack&babel bundled cross-browser library version. | ||
| The library is accessible as `typeofArguments` variable in the global *(window)* scope. | ||
| ```html | ||
| <script src="./src/typeof-arguments.min.js"></script> | ||
| <script> | ||
| function test() { | ||
| typeofArguments(arguments, [String, Number]); | ||
| } | ||
| </script> | ||
| <head> | ||
| <script src='typeof-arguments.js'></script> | ||
| <script> | ||
| function test(name, age) { | ||
| typeofArguments(arguments, ['string', 'number|string|null']); | ||
| } | ||
| test('Nikola', 26); | ||
| </script> | ||
| </head> | ||
| ``` | ||
| # Tests | ||
| ``` | ||
| > git clone https://github.com/devrafalko/typeof-arguments.git | ||
| > cd typeof-arguments | ||
| > npm install | ||
| > npm test //run tests in node | ||
| > npm test deep //run tests in node with errors shown | ||
| ``` | ||
| # Usage | ||
| ### `type(actual, expected[, callback])` | ||
| ### `actual` **[Object]** | ||
| * It should always indicate the enclosing function **`arguments`** object | ||
| It should always indicate the enclosing function **`arguments`** object. | ||
@@ -43,3 +56,3 @@ ### `expected` **[Array]** | ||
| ```javascript | ||
| test('Paul', 26); | ||
| test('Nikola', 26); | ||
@@ -54,14 +67,24 @@ function test(name, age) { | ||
| ### The `expected` Types | ||
| There are three ways to check the type of the arguments: | ||
| There are four ways to check the type of the arguments: | ||
| * by **string expression** values | ||
| * by **regular expression** values | ||
| * by **constructor functions**, `null` or `undefined` values | ||
| * by some of supported custom types | ||
| #### 1. [String] expressions | ||
| * Possible values: `'null'`, `'undefined'`, or any value equal to `constructor.name`, eg: `'string'`, `'number'`, `'regexp'`, `'array'`, `'object'`, `'boolean'`,`'buffer'`, etc. | ||
| * The [String] value is case insensitive: `'String'`, `'string'`, `'StRiNg'` checks if the argument is of type [String]. | ||
| * The [String] value can contain **multiple** allowed types, separated with `|`. eg: `'array|object'` checks if the argument is of type [Array] **`OR`** of type [Object]. | ||
| > Mind, that the `typeof-arguments` library uses the `of-type` library as the dependency, to validate the types. If you feel confused how to use the types, see more samples [here](https://www.npmjs.com/package/of-type#samples). | ||
| `[String]` | ||
| * Possible values: | ||
| * `'null'`, `'undefined'` | ||
| * any value that equals to argument's `constructor.name`, eg: | ||
| `'string'`, `'number'`, `'regexp'`, `'array'`, `'object'`, `'boolean'`,`'buffer'`, etc. | ||
| * The [String] type is case insensitive: | ||
| * `'String'`, `'string'`, `'StRiNg'` checks if the argument is of `[String]` type | ||
| * `'RegExp'`, `'REGEXP'`, `'regexp'` checks if the argument is of `[RegExp]` type | ||
| * The [String] type can contain multiple types, separated with `|`: | ||
| * `'array|object'` checks if the argument is of `[Array]` **`OR`** `[Object]` type | ||
| * `'undefined|null'` checks if the argument is of `undefined` **`OR`** `null` type | ||
| ```javascript | ||
| test('Paul', 26); | ||
| test('Nikola', 26); | ||
@@ -73,12 +96,17 @@ function test() { | ||
| #### 2. [RegExp] expressions | ||
| * Possible values: `/null/`, `/undefined/`, or any value matching the `constructor.name`, eg: `/String/`, `/Number/`, `/RegExp/`, `/Array/`, `/Object/`, `/Boolean/`,`/Buffer/`, `/Promise/`, etc. | ||
| * For the case insensitivity use `i` flag, eg: `/string/i`, `/regexp/i`, `/typeerror/i` | ||
| * For **multiple** values use regexp `(x|y)` expression, eg: `/String|Number/`, `/TypeError|Error/` | ||
| * Use another regexp features: | ||
| * eg. `/(Type|Range|Syntax)Error/` will match `TypeError`, `RangeError` and `SyntaxError` | ||
| * eg. `/[A-Z].+/` will match `String`, `Array`, but will not match `undefined`, `null`, etc. | ||
| `[RegExp]` | ||
| * Possible values: | ||
| * `/null/`, `/undefined/` | ||
| * any value matching the argument's `constructor.name`, eg: `/String/`, `/Number/`, `/RegExp/`, `/Array/`, `/Object/`, `/Boolean/`,`/Buffer/`, `/Promise/`, etc. | ||
| * Use all regular expression's features to match the type in a desired way: | ||
| * `/Str/`, `/Err/`, `/Reg/`, `/B/` | ||
| * `/.+Error$/`, `/^RegExp$/`, | ||
| * `/^[A-Z][a-z]+$/` | ||
| * For the case insensitivity use `i` flag: | ||
| * `/string/i`, `/regexp/i`, `/TYPEERROR/i` | ||
| * For multiple values use regexp `(x|y)` expression: | ||
| * `/String|Number/`, `/TypeError|Error/`, `/(obj|str)/i` | ||
| ```javascript | ||
| test('Paul', 26); | ||
| test('Nikola', 26); | ||
@@ -90,8 +118,12 @@ function test() { | ||
| #### 3. [null|undefined|Function] expressions | ||
| * Possible values: `null`, `undefined` or any **constructor** object, eg: `String`, `TypeError`, `Promise`, `Array`, etc. | ||
| * For **multiple** values use **array**, eg: `[String,Object,Array,null]` | ||
| `[Function|Array|null|undefined]` | ||
| * Possible values: | ||
| * `null`, `undefined` | ||
| * any `[Function]` constructor, eg: `String`, `TypeError`, `Promise`, `Array`, etc. | ||
| * For multiple values use array: | ||
| * `[String, Object, Array, null]` | ||
| * `[null, undefined, Boolean]` | ||
| ```javascript | ||
| test('Paul', 26); | ||
| test('Nikola', 26); | ||
@@ -103,9 +135,33 @@ function test() { | ||
| > When you use **bundlers** or **minifiers**, use `[String|RegExp]` type **wisely** as bundlers may change the names of functions|constructors|classes in the output file and eg. `type(arguments, ['MyClass']);` that returns `true` before compilation, may return `false` after compilation, if the bundler minifies the `'MyClass'` constructor name. | ||
| ### Extra types: | ||
| * The value can be: `'arguments'` or `/arguments/`. It returns `true` if the argument is defined as the `arguments` Object | ||
| * The value can be : `'instance'` or `/instance/`. It returns `true` if the argument is the **instance** of user **class** or **constructor**. It returns `false` for instances of built-in *(native)* constructors, *eg. for `[]`, `"hello world"`, `{ }`* | ||
| * The value can be: `'truthy'` or `/truthy/`. It returns `true` if the argument has the value like: `"abc"`, `true`, `1`, `{ }`, `[]`,`function(){ }`, etc. | ||
| * The value can be: `'falsy'` or `/falsy/`. It returns `true` if the argument has the value like: `""`, `false`, `0`, `null`, `undefined`, `NaN`, etc. | ||
| * The value can be: `''` or `'any'` or `/any/` or `[]`, It returns `true` if the argument is of **any type**. | ||
| `[String] 'arguments'` | `[RegExp] /arguments/` | ||
| * The type `'arguments'` or `/arguments/` expects the passed argument to be the function's `arguments` object | ||
| `[String] 'instance'` | `[RegExp] /instance/` | ||
| * The type `'instance'` or `/instance/` expects the passed argument to be the instance of the user's class|constructor | ||
| * It fails when the passed argument is an instance of built-in *(native)* constructor | ||
| * `[]`, `'hello world'`, `{}` | ||
| * It fails for instances that are the `global`|`window`'s properties | ||
| `[String] 'objectable'` | `[RegExp] /objectable/` | ||
| * The type `'objectable'` or `/objectable/` expects the passed argument to be the object that is the instance of the `Object` constructor | ||
| * `{}`, `[]`, `new String('hello world')`, `new Boolean(1)` | ||
| * It fails when the passed argument is a primitive value or a simple value | ||
| * `'hello world'`, `true`, `10`, `null`, `undefined` | ||
| `[String] 'truthy'` | `[RegExp] /truthy/` | ||
| * The type `'truthy'` or `/truthy/` expects the passed argument to be like: | ||
| * `'abc'`, `true`, `1`, `-1`, `{}`, `[]`, `function(){}` | ||
| `[String] 'falsy'` | `[RegExp] /falsy/` | ||
| * The type `'falsy'` or `/falsy/` expects the passed argument to be like: | ||
| * `''`, `false`, `0`, `null`, `undefined`, `NaN` | ||
| `[String] 'any'` | `[RegExp] /any/` | `[Array] []` | `[String] ""` | ||
| * The `type` `'any'` or `/any/` or empty array `[]` or empty string `""` expects the passed argument to be of any type | ||
| ### `callback` **[Function]** *(optional)* | ||
@@ -134,3 +190,3 @@ * if **not passed**, the **TypeError** with **default message** will be **thrown** to the console, if the argument passed to the function is invalid. | ||
| hello('Paul', 26); | ||
| hello('Nikola', 26); | ||
@@ -164,11 +220,2 @@ function hello(name, age) { | ||
| # Tests | ||
| ``` | ||
| > git clone https://github.com/devrafalko/typeof-arguments.git | ||
| > cd typeof-arguments | ||
| > npm install | ||
| > npm test | ||
| > npm test deep //displays error messages | ||
| ``` | ||
| # Samples | ||
@@ -191,3 +238,3 @@ ```javascript | ||
| test({ name: 'Paul' }, false, /test/); | ||
| test({ name: 'Nikola' }, false, /test/); | ||
| //Invalid argument [0]. The [Object] argument has been passed, while the argument of type matching string expression "number|string" is expected. | ||
@@ -203,3 +250,2 @@ //Invalid argument [2]. The [RegExp] argument has been passed, while the argument of type matching string expression "null|array" is expected. | ||
| ### more samples | ||
| ```javascript | ||
@@ -232,3 +278,2 @@ const type = require('typeof-arguments'); | ||
| ### more samples | ||
| ```javascript | ||
@@ -244,19 +289,18 @@ const type = require('typeof-arguments'); | ||
| test('Paul', null, false, 10); | ||
| test('Nikola', null, false, 10); | ||
| //no errors | ||
| test('Paul', null, false, 10, new TypeError('error')); | ||
| test('Nikola', null, false, 10, new TypeError('error')); | ||
| //no errors | ||
| test('Paul', null, false, 10, false); | ||
| test('Nikola', null, false, 10, false); | ||
| //no errors | ||
| test('Paul'); | ||
| test('Nikola'); | ||
| //Invalid argument [3]. The [undefined] argument has been passed, while the argument of type [Number] is expected. | ||
| test('Paul', true, true, 10, new Error('error')); | ||
| test('Nikola', true, true, 10, new Error('error')); | ||
| //Invalid argument [4]. The [Error] <<truthy>> argument has been passed, while the argument of type matching regular expression /((syntax|type)error)|falsy/i is expected. | ||
| ``` | ||
| ### more samples | ||
| ```javascript | ||
@@ -263,0 +307,0 @@ const type = require('typeof-arguments'); |
| /* global describe, expect, it */ | ||
| const path = require('path'); | ||
| const type = require(path.resolve('./src/index.js')); | ||
| const scenario = require('./scenarios-arguments.js'); | ||
| import scenario from './data/scenarios-arguments.js'; | ||
@@ -10,3 +8,3 @@ describe('When the module function type() is called',function(){ | ||
| it(`type(${scenario[i].oActual},${scenario[i].oExpected}), it should throw TypeError with message "${scenario[i].message}"`,function(){ | ||
| let binded = type.bind(this,scenario[i].actual,scenario[i].expected,()=>{}); | ||
| let binded = this.type.bind(this,scenario[i].actual,scenario[i].expected,()=>{}); | ||
| expect(binded).toThrowError(TypeError,scenario[i].message); | ||
@@ -19,3 +17,3 @@ }); | ||
| it(`type(${scenario[i].oActual},${scenario[i].oExpected}), it should throw TypeError with message "${scenario[i].message}"`,function(){ | ||
| let binded = type.bind(this,scenario[i].actual,scenario[i].expected,()=>{}); | ||
| let binded = this.type.bind(this,scenario[i].actual,scenario[i].expected,()=>{}); | ||
| expect(binded).toThrowError(TypeError,scenario[i].message); | ||
@@ -22,0 +20,0 @@ }); |
| /* global jasmine, describe, expect, it */ | ||
| const path = require('path'); | ||
| const type = require(path.resolve('./src/index.js')); | ||
| const scenario = require('./scenarios-invalid.js'); | ||
| import scenario from './data/scenarios-invalid.js'; | ||
@@ -14,3 +12,3 @@ describe('When the argument is of invalid type, the module function',function(){ | ||
| function test(){ | ||
| type(arguments,expected); | ||
| this.type(arguments,expected); | ||
| } | ||
@@ -36,3 +34,3 @@ }); | ||
| function test(){ | ||
| return type(arguments,expected,clb); | ||
| return this.type(arguments,expected,clb); | ||
| } | ||
@@ -39,0 +37,0 @@ }); |
| /* global jasmine, describe, expect, it */ | ||
| const path = require('path'); | ||
| const type = require(path.resolve('./src/index.js')); | ||
| const scenario = require('./scenarios-valid.js'); | ||
| import scenario from './data/scenarios-valid.js'; | ||
@@ -14,3 +12,3 @@ describe('The module function should not throw error and run callback function',function(){ | ||
| function test(){ | ||
| return type(arguments,[],clb); | ||
| return this.type(arguments,[],clb); | ||
| } | ||
@@ -30,3 +28,3 @@ }); | ||
| function test(){ | ||
| return type(arguments,expected,clb); | ||
| return this.type(arguments,expected,clb); | ||
| } | ||
@@ -33,0 +31,0 @@ }); |
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Minified code
QualityThis package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Dynamic require
Supply chain riskDynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by34.03%
61663
- Number of package files
- increased by40%
21
- Lines of code
- increased by10.22%
701
- Number of lines in readme file
- increased by15.6%
326
- Number of low supply chain risk alerts
- decreased by-100%
0
Worsened metrics
- Dev dependency count
- increased by50%
12
- Number of low quality alerts
- increased byInfinity%
1
- Number of medium supply chain risk alerts
- increased byInfinity%
1
Dependency changes
+ Addedof-type@3.0.4(transitive)
- Removedof-type@2.2.0(transitive)
Updatedof-type@^3.0.0