What is Chek? Well we have a guy we call Chekov, as in "I can do zat Captain I can do zat". So we shortened it to "Chek". Hey there's a logger named after "Winston" right.

Anyway Chek is a slimmed down lib for common tasks like check if "is" a type or convert to a type. There are helpers for dealing with strings, converting objects to arrays and back (handy for Firebase type apis) and so on.

Nothing special just a nice little toolkit preventing the need for large libs like Lodash or Underscore (both great of course).

The end game is simple. Have about 90% or so coverage for common tasks preventing the need for a larger footprint.

Comes with 100% test coverage out of the gate. Some handy methods like push, splice, shift, unshfit and so on that handle immutability as well as other methods where applicable.

Installation

npm install chek -s

Usage

Using Typescript

import * as ck from 'chek'; // or import { isString, slugify } from 'chek';

let slug = 'i can Do zAT';
if (ck.isString(slug))
  slug = ck.slugify(slug) // result: 'i-can-do-zat';

Using ES5

const ck = require('chek');

// same as above.

Methods

Methods are broken into several categories. Some have only a method or two and we'll likely expand a little on some. Have any suggestions be sure to post an issue we're all ears. Not prideful help out we all win!

• array - things like contains, containsAny, duplicates.
• from - things like fromEpoch, fromJSON, tryWrap & tryRequire.
• functions - noop and noopIf
• is - things like if isString, isBoolean, isFunction.
• object - things like get, set, clone, extend.
• string - things like lowercase, uppercase, slugify, padding, uuid.
• to - handles converting to a type like toBoolean, toRegExp.
• type - handles getting and casting types.

Please Note the following tables are here for convenience you should ALWAYS reference the "docs" below for updated method signatues, there's only so much time in the day.

Array

From

Function

Is

Object

String

To

Type

Docs

See https://origin1tech.github.io/chek/

Changes

See CHANGE.md

License

See LICENSE