utils.js

JavaScript utility library for web and nodejs development

Installation

npm i @andrewcaires/utils.js

Api

EventEmitter

Class for custom events

import { EventEmitter } from '@andrewcaires/utils.js';

const emitter = new EventEmitter();

// OR

class CustomEvent extends EventEmitter {}

const custom = new CustomEvent();

• EventEmitter.on Adds the listener function to the end of the listeners array for the event named.

const cb = (data) => {

  console.log(data);
}

emitter.on('event', cb);

• EventEmitter.once Adds the listener function to the end of the listeners array for the event named. The next time event is triggered, this listener is removed.

const cb = (data) => {

  console.log(data);
}

emitter.once('event', cb);

• EventEmitter.off Removes the specified listener from the listener array for the event named.

emitter.off('event', cb);

• EventEmitter.emit Synchronously calls each of the listeners registered for the event named.

emitter.emit('event', 'on emit event');
// > on emit event

type

Determine the internal JavaScript [[Class]] of an object.

import { isArray, isBoolean, isFunction, isNumber, isObject, isString, isFloat, isInteger, isNull, isUndefined, isValid, type } from '@andrewcaires/utils.js';

• isArray Finds whether a variable is an array.

isArray([]) // > true

• isBoolean Finds out whether a variable is a boolean.

isBoolean(true) // > true
isBoolean(false) // > true

• isFunction Find whether the type of a variable is function.

isFunction(function() {}) // > true

• isNumber Finds whether a variable is an number.

isNumber(1) // > true
isNumber(1.7) // > true

• isObject Finds whether a variable is an object.

isObject({}) // > true

• isString Find whether the type of a variable is string.

isString('') // > true

• isFloat Finds whether the type of a variable is float.

isFloat(1.7) // > true

• isInteger Find whether the type of a variable is integer.

isInteger(1) // > true

• isNull Finds whether a variable is null.

isNull(null) // > true

• isUndefined Finds whether a variable is undefined.

isUndefined(undefined) // > true

• isValid Find out if a variable is valid.

isValid(any) // > true

• type Get the type of a variable.

type([]); // => 'array'

type(true); // => 'boolean'
type(false); // => 'boolean'

type(frunction() {}); // => 'function'

type(1); // => 'number'
type(1.7); // => 'number'

type({}); // => 'object'

type(''); // => 'string'
type('test'); // => 'string'

type(); // => 'null'
type(null); // => 'null'

Links

• Docs
• GitHub
• npm

License

• MIT License