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

typical

Package Overview
Dependencies
Maintainers
1
Versions
28
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

typical

Isomorphic, functional type-checking for Javascript

  • 6.0.0
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

view on npm npm module downloads Build Status Coverage Status Dependency Status js-standard-style

typical

Isomorphic, functional type-checking for Javascript.

Example

const t = require('typical')
const allDefined = array.every(t.isDefined)

t.isNumber(n) ⇒ boolean

Returns true if input is a number. It is a more reasonable alternative to typeof n which returns number for NaN and Infinity.

Kind: static method of typical

ParamTypeDescription
n*the input to test

Example

> t.isNumber(0)
true
> t.isNumber(1)
true
> t.isNumber(1.1)
true
> t.isNumber(0xff)
true
> t.isNumber(0644)
true
> t.isNumber(6.2e5)
true
> t.isNumber(NaN)
false
> t.isNumber(Infinity)
false

t.isPlainObject(input) ⇒ boolean

A plain object is a simple object literal, it is not an instance of a class. Returns true if the input typeof is object and directly decends from Object.

Kind: static method of typical

ParamTypeDescription
input*the input to test

Example

> t.isPlainObject({ something: 'one' })
true
> t.isPlainObject(new Date())
false
> t.isPlainObject([ 0, 1 ])
false
> t.isPlainObject(/test/)
false
> t.isPlainObject(1)
false
> t.isPlainObject('one')
false
> t.isPlainObject(null)
false
> t.isPlainObject((function * () {})())
false
> t.isPlainObject(function * () {})
false

t.isArrayLike(input) ⇒ boolean

An array-like value has all the properties of an array yet is not an array instance. An example is the arguments object. Returns true`` if the input value is an object, not null`` and has a length property set with a numeric value.

Kind: static method of typical

ParamTypeDescription
input*the input to test

Example

function sum(x, y){
  console.log(t.isArrayLike(arguments))
  // prints `true`
}

t.isObject(input) ⇒ boolean

Returns true if the typeof input is 'object' but not null.

Kind: static method of typical

ParamTypeDescription
input*the input to test

t.isDefined(input) ⇒ boolean

Returns true if the input value is defined.

Kind: static method of typical

ParamTypeDescription
input*the input to test

t.isUndefined(input) ⇒ boolean

Returns true if the input value is undefined.

Kind: static method of typical

ParamTypeDescription
input*the input to test

t.isNull(input) ⇒ boolean

Returns true if the input value is null.

Kind: static method of typical

ParamTypeDescription
input*the input to test

t.isDefinedValue(input) ⇒ boolean

Returns true if the input value is not one of undefined, null, or NaN.

Kind: static method of typical

ParamTypeDescription
input*the input to test

t.isClass(input) ⇒ boolean

Returns true if the input value is an ES2015 class.

Kind: static method of typical

ParamTypeDescription
input*the input to test

t.isPrimitive(input) ⇒ boolean

Returns true if the input is a string, number, symbol, boolean, null or undefined value.

Kind: static method of typical

ParamTypeDescription
input*the input to test

t.isPromise(input) ⇒ boolean

Returns true if the input is a Promise.

Kind: static method of typical

ParamTypeDescription
input*the input to test

t.isIterable(input) ⇒ boolean

Returns true if the input is an iterable (Map, Set, Array, Generator etc.).

Kind: static method of typical

ParamTypeDescription
input*the input to test

Example

> t.isIterable('string')
true
> t.isIterable(new Map())
true
> t.isIterable([])
true
> t.isIterable((function * () {})())
true
> t.isIterable(Promise.resolve())
false
> t.isIterable(Promise)
false
> t.isIterable(true)
false
> t.isIterable({})
false
> t.isIterable(0)
false
> t.isIterable(1.1)
false
> t.isIterable(NaN)
false
> t.isIterable(Infinity)
false
> t.isIterable(function () {})
false
> t.isIterable(Date)
false
> t.isIterable()
false
> t.isIterable({ then: function () {} })
false

t.isString(input) ⇒ boolean

Returns true if the input value is a string. The equivalent of typeof input === 'string' for use in funcitonal contexts.

Kind: static method of typical

ParamTypeDescription
input*the input to test

t.isFunction(input) ⇒ boolean

Returns true if the input value is a function. The equivalent of typeof input === 'function' for use in funcitonal contexts.

Kind: static method of typical

ParamTypeDescription
input*the input to test

Load anywhere

This library is compatible with Node.js, the Web and any style of module loader. It can be loaded anywhere, natively without transpilation.

Node.js:

const typical = require('typical')

Within Node.js with ECMAScript Module support enabled:

import typical from 'typical'

Within a modern browser ECMAScript Module:

import typical from './node_modules/typical/index.mjs'

Old browser (adds window.typical):

<script nomodule src="./node_modules/typical/dist/index.js"></script>

© 2014-19 Lloyd Brookes <75pound@gmail.com>. Documented by jsdoc-to-markdown.

Keywords

FAQs

Package last updated on 15 Nov 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

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

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc