Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

typa

Package Overview
Dependencies
Maintainers
1
Versions
30
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

typa - npm Package Compare versions

Comparing version 0.2.3 to 0.3.0

dist-node/index.js
dist-node/index.js.map
dist-src/index.js
dist-types/index.d.ts
dist-web/index.js
dist-web/index.js.map

54

package.json
{
"name": "typa",
"version": "0.2.3",
"description": "Super-simple, zero-dependency JavaScript type checker utility.",
"main": "dist/typa.min.js",
"scripts": {
"start": "grunt",
"deploy": "grunt deploy",
"test": "jest",
"test-with-coverage": "jest --coverage && cat ./coverage/lcov.info"
},
"repository": {
"type": "git",
"url": "git+https://gitlab.com/selfagency/typa.git"
},
"version": "0.3.0",
"license": "MIT",
"files": [
"dist-*/",
"bin/"
],
"pika": true,
"sideEffects": false,
"keywords": [

@@ -24,23 +20,33 @@ "javascript",

],
"author": "The Self Agency, LLC",
"license": "MIT",
"homepage": "https://gitlab.com/selfagency/typa",
"bugs": {
"url": "https://gitlab.com/selfagency/typa/issues"
},
"homepage": "https://gitlab.com/selfagency/typa",
"repository": {
"type": "git",
"url": "git+https://gitlab.com/selfagency/typa.git"
},
"dependencies": {},
"devDependencies": {
"eslint": "^5.16.0",
"@pika/plugin-build-node": "^0.9.2",
"@pika/plugin-build-types": "^0.9.2",
"@pika/plugin-build-web": "^0.9.2",
"@pika/plugin-bundle-node": "^0.9.2",
"@pika/plugin-bundle-web": "^0.9.2",
"@pika/plugin-standard-pkg": "^0.9.2",
"eslint": "^6.8.0",
"eslint-plugin-import": "^2.17.2",
"eslint-plugin-node": "^8.0.1",
"eslint-plugin-node": "^11.1.0",
"eslint-plugin-prettier": "^3.1.3",
"eslint-plugin-promise": "^4.1.1",
"eslint-plugin-security": "^1.4.0",
"eslint-plugin-standard": "^4.0.0",
"grunt": "^1.0.4",
"grunt-exec": "^3.0.0",
"grunt-node-minify": "^1.5.0",
"jest": "^24.7.1",
"jit-grunt": "^0.10.0",
"prettier": "^1.17.0"
"jest": "^25.5.2",
"prettier": "^2.0.5",
"typescript": "^3.8.3"
},
"dependencies": {}
"esnext": "dist-src/index.js",
"main": "dist-node/index.js",
"module": "dist-web/index.js",
"types": "dist-types/index.d.ts"
}

252

README.md

@@ -1,26 +0,26 @@

# Typa
# Typa: Zero-dep JS type checker 🧐
A super-simple zero-dependency JavaScript type checker. Mainly pilfered from [this blog post](https://www.webbjocke.com/javascript-check-data-types/) by [Webbjocke](https://github.com/webbjocke). 4.6K [GCC](https://github.com/google/closure-compiler-js) compiled, 3.0K uncompiled.
[![npm](https://img.shields.io/npm/dt/typa.svg)](https://www.npmjs.com/package/typa) [![npm](https://img.shields.io/npm/v/typa.svg)](https://www.npmjs.com/package/typa) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Twitter: @selfagency_llc](https://img.shields.io/twitter/follow/selfagency_llc.svg?style=social)](https://twitter.com/selfagency_llc)
[![npm](https://img.shields.io/npm/dt/typa.svg)](https://www.npmjs.com/package/typa) [![npm](https://img.shields.io/npm/v/typa.svg)](https://www.npmjs.com/package/typa)
The easy-peasy zero-dependency JavaScript type checker that asks, "What typa input is that?"
**Install**
**Notice:** Breaking changes in v0.3.0. New bundler, plus `nll` is now `nil` and `noru` is now `nullish`.
## Install
```sh
yarn add typa || npm install typa
```
npm install typa
```
**Import**
## Run tests
```sh
yarn test
```
import is from 'typa'
/* or */
## Basic Usage
const is = require('typa')
```
```js
import is from 'typa' || const is = require('typa')
**Quick Start**
```
const hello = 'Hello!'

@@ -38,39 +38,36 @@ const goodbye = ['Goodbye!', 'Adios!', 'Au revoir!']

* <a href="#array">_arr_</a> → Array
* <a href="#bad">_bad_</a> → Null, undefined, empty, or an error
* <a href="#boolean">_bool_</a> → Boolean
* <a href="#date">_date_</a> → Date
* <a href="#empty">_empty_</a> → Empty string, array, or object
* <a href="#error">_err_</a> → Error
* <a href="#function">_fn_</a> → Function
* <a href="#integer">_int_</a> → Integer
* <a href="#json">_json_</a> → Serialized JSON object
* <a href="#null">_nll_</a> → Null
* <a href="#noru">_noru_</a> → Null or undefined
* <a href="#number">_num_</a> → Number
* <a href="#object">_obj_</a> → Object
* <a href="#promise">_prom_</a> → Promise
* <a href="#regex">_regex_</a> → Regular expression
* <a href="#string">_str_</a> → String
* <a href="#symbol">_sym_</a> → Symbol
* <a href="#undefined">_undef_</a> → Undefined
- <a href="#array">_arr_</a> → Array
- <a href="#bad">_bad_</a> → Null, undefined, empty, or an error
- <a href="#boolean">_bool_</a> → Boolean
- <a href="#date">_date_</a> → Date
- <a href="#empty">_empty_</a> → Empty string, array, or object
- <a href="#error">_err_</a> → Error
- <a href="#function">_fn_</a> → Function
- <a href="#integer">_int_</a> → Integer
- <a href="#json">_json_</a> → Serialized JSON object
- <a href="#nil">_nil_</a> → Null
- <a href="#nullish">_nullish_</a> → Null or undefined
- <a href="#number">_num_</a> → Number
- <a href="#object">_obj_</a> → Object
- <a href="#promise">_prom_</a> → Promise
- <a href="#regex">_regex_</a> → Regular expression
- <a href="#string">_str_</a> → String
- <a href="#symbol">_sym_</a> → Symbol
- <a href="#undefined">_undef_</a> → Undefined
## Typa Method
Ternary function that checks if the supplied value matches the specified type, then returns the first function (or value) if true or the second function (or value) if false.
Ternary operator that checks if the supplied value matches the specified type, then returns the first callback function (or value) if true or the second callback function (or value) if false.
**.typa**($type, $value, $fn1, $fn2)
```
const myString = 'this is a string'
const myArray = 'this is also a string, not an array'
```js
const isStr = () => console.log('I am a string')
const aintStr = () => console.log('I am not a string')
const fn1 = (() => console.log('hello'))
const fn2 = (() => console.log('goodbye'))
is.typa('str', 'Am I a string?', isStr, aintStr)
// => 'I am a string'
is.typa('str', myString, fn1, fn2)
// => 'hello'
is.typa('arr', myArray, fn1, fn2)
// => 'goodbye'
is.typa('str', ['Am', 'I', 'a', 'string', '?'], isStr, aintStr)
// => 'I am not a string'
```

@@ -82,13 +79,10 @@

**.what**($value)
**.what**(\$value)
```
const myString = 'this is a string'
const myArray = 'this is my array'
```js
is.what('This is a string')
// => 'string'
is.what(myString)
// => 'string'
is.what(myArray)
// => ['array', 'object']
is.what(['This', 'is', 'an', 'array'])
// => ['array', 'object']
```

@@ -98,117 +92,119 @@

<a name="array"></a>**.arr**($value) — Array
<a name="array"></a>**.arr**(\$value) — Array
```
```js
const isArray = is.arr(['text', 12])
// => true
// => true
```
<a name="bad"></a>**.bad**($value) — Null, undefined, empty, or an error
<a name="bad"></a>**.bad**(\$value) — Null, undefined, empty, or an error
```
```js
let isBad = is.bad(null)
// => true
// => true
isBad = is.bad(undefined)
// => true
// => true
isBad = is.bad({})
// => true
// => true
isBad = is.bad(new Error('This is an error'))
// => true
// => true
```
<a name="boolean"></a>**.bool**($value) — Boolean
<a name="boolean"></a>**.bool**(\$value) — Boolean
```
```js
let isBool = is.bool(true)
// => true
// => true
isBool = is.bool(false)
// => true
// => true
```
<a name="date"></a>**.date**($value) — Date
<a name="date"></a>**.date**(\$value) — Date
```
```js
const isDate = is.date(new Date())
// => true
// => true
```
<a name="empty"></a>**.empty**($value) — Empty string, array, or object
<a name="empty"></a>**.empty**(\$value) — Empty string, array, or object
```
```js
let isEmpty = is.empty('')
// => true
// => true
isEmpty = is.empty([])
// => true
// => true
isEmpty = is.empty({})
// => true
// => true
```
<a name="error"></a>**.err**($value) — Error
<a name="error"></a>**.err**(\$value) — Error
```
```js
const isErr = is.err(new Error('This is an error.'))
// => true
// => true
```
<a name="function"></a>**.fn**($value) — Function
<a name="function"></a>**.fn**(\$value) — Function
```js
const isFn = is.fn(() => {
console.log('Hi!')
})
// => true
```
const isFn = is.fn(() => { console.log('Hi!') })
// => true
```
<a name="integer"></a>**.int**($value) — Integer
<a name="integer"></a>**.int**(\$value) — Integer
```
```js
const isInt = is.int(12)
// => true
// => true
```
<a name="json"></a>**.json**($value) — Serialized JSON object
<a name="json"></a>**.json**(\$value) — Serialized JSON object
```
```js
const isJson = is.json('{"key": "value"}')
// => true
// => true
```
<a name="null"></a>**.nll**($value) — Null
<a name="nil"></a>**.nil**(\$value) — Null
```js
const isNil = is.nil(null)
// => true
```
const isNll = is.nll(null)
// => true
```
<a name="noru"></a>**.noru**($value) — Null or Undefined
<a name="nullish"></a>**.nullish**(\$value) — Null or Undefined
```
let isNoru = is.noru(null)
// => true
```js
let isNullish = is.nullish(null)
// => true
isNoru = is.noru(undefined)
// => true
isNullish = is.nullish(undefined)
// => true
```
<a name="number"></a>**.num**($value) — Number
<a name="number"></a>**.num**(\$value) — Number
```
```js
const isNum = is.num(28.2)
// => true
// => true
```
<a name="object"></a>**.obj**($value) — Object
<a name="object"></a>**.obj**(\$value) — Object
```
```js
const isObj = is.obj({ key: 'value' })
// => true
// => true
```
<a name="promise"></a>**.prom**($value) — Promise
<a name="promise"></a>**.prom**(\$value) — Promise
```
```js
const myPromise = new Promise((resolve, reject) => {

@@ -218,3 +214,3 @@ try {

resolve()
} catch(err) {
} catch (err) {
reject(err)

@@ -225,31 +221,51 @@ }

const isProm = is.prom(myPromise)
// => true
// => true
```
<a name="regex"></a>**.regex**($value) — Regular Expression
<a name="regex"></a>**.regex**(\$value) — Regular Expression
```
```js
const isRegex = is.regex(new Regex(/\W/))
// => true
// => true
```
<a name="string"></a>**.str**($value) — String
<a name="string"></a>**.str**(\$value) — String
```
```js
const isStr = is.str('text')
// => true
// => true
```
<a name="symbol"></a>**.sym**($value) — Symbol
<a name="symbol"></a>**.sym**(\$value) — Symbol
```
```js
const isSym = is.sym(Symbol(42))
// => true
// => true
```
<a name="undefined"></a>**.undef**($value) — Undefined
<a name="undefined"></a>**.undef**(\$value) — Undefined
```
```js
const isUndef = is.undef(undefined)
// => true
// => true
```
## Author
👤 **Daniel Sieradski <hello@self.agency>**
- Website: [self.agency](https://self.agency)
- Twitter: [@selfagency_llc](https://twitter.com/selfagency_llc)
- GitLab: [@selfagency](https://gitlab.com/selfagency)
## Acknowledgements
Most of the checks comprising this library were pilfered from [this blog post](https://www.webbjocke.com/javascript-check-data-types/) by [Webbjocke](https://github.com/webbjocke).
## Contributing
Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://gitlab.com/selfagency/utfu/issues).
## Show your support
Give a ⭐️ if this project helped you!
.editorconfig
.eslintrc
.vscode/settings.json
dist/typa.min.js
Gruntfile.js
src/typa.js
tests/array.test.js
tests/bad.test.js
tests/boolean.test.js
tests/date.test.js
tests/empty.test.js
tests/error.test.js
tests/fn.test.js
tests/int.test.js
tests/json.test.js
tests/noru.test.js
tests/null.test.js
tests/num.test.js
tests/obj.test.js
tests/promise.test.js
tests/regex.test.js
tests/str.test.js
tests/sym.test.js
tests/typa.test.js
tests/undef.test.js
tests/what.test.js
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc