Options
All
  • Public
  • Public/Protected
  • All
Menu

chitu (Chuck Her In The Ute)

Chuck Her In The Ute

youtube.com/watch?v=9i2eZaJsC7g

JavaScript Utilities

Travis Codecov npm

Installation

via npm

> npm install chitu --save

via yarn

> yarn add chitu

Modules available

Chitu exports 3 module types:

  • UMD (dist/chitu.min.js)
  • Common JS (dist/chitu.js)
  • ES Module (dist/chitu.es.js)

Usage

type

A module to check the type of a given value.

import { type } from 'chitu';

type.isArray(['foo', 'bar']); // = true
type.isObject({ foo: 'bar' }); // = true
type.isString('foo'); // = true
type.isDate(new Date()); // = true
type.isRegExp(/foo/g); // = true
type.isFunction(function () {}); // = true
type.isBoolean(false); // = true
type.isNumber(123); // = true
type.isError(new Error()); // = true
type.isNull(null); // = true
type.isUndefined(void 0); // = true

// or for anything else
type.is('Symbol', Symbol('foo')); // = true
type.is('Map', new Map([])); // = true
type.is('Set', new Set([])); // = true
// etc

value

Check if the value is a function and execute it (with provided parameters) or simply return the value.

import { value } from 'chitu';

const foo = (a, b, c) => a * b * c;
const bar = ['baz'];

const fooVal = value(foo, 2, 2, 2); // = 8
const barVal = value(bar); // = ['baz']

round

Round a number to a given number of decimal places.

import { round } from 'chitu';

round(123.456); // = 123.46
round(1, 2); // = 1.00
round(1.937); // = 1.94
// etc

ordinal

Return the ordinal value for a given number.

import { ordinal } from 'chitu';

ordinal(1) // = '1st'
ordinal(2) // = '2nd'
ordinal(3) // = '3rd'
ordinal(4) // = '4th'
ordinal(12) // = '12th'
ordinal(101) // = '101st'
// etc

Index

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc