Skip to content

Latest commit

 

History

History
659 lines (407 loc) · 11.2 KB

DOCUMENTATION.md

File metadata and controls

659 lines (407 loc) · 11.2 KB

Table of Contents

UUID_NIL

Null value for uuid. Database type is uuid/guid. Value is '00000000-0000-0000-0000-000000000000'

Type: string

EnumGenerator

Generates a Enum class

Parameters

  • attr EnumInput Valid enum data

Examples

const enumObj = Utilify.EnumGenerator({ 1: 'Yes', 2: 'No' });
enumObj[1] // 'Yes'
enumObj['Yes'] // 1

Returns JSEnum JavaScript compatible enum class.

getCurrentEpochTime

Returns current epoch time in int.

Returns number current time in epoch format

CacheMgr

Cache manager, stores data in memory.

Examples

CacheMgr.set('key1', 1000);
CacheMgr.get('key1'); // 1000
CacheMgr.remove('key1');

set

Sets cache value

Parameters

  • key string Key of the value
  • val T Cached value

Examples

CacheMgr.set('key', 1000);

Returns T Cached value.

get

Gets cached value

Parameters

Examples

CacheMgr.get('key');

Returns any Cached value.

remove

Removes given cached value

Parameters

Examples

CacheMgr.remove('key');

Returns undefined undefined.

clearAll

Removes all cached values.

Examples

CacheMgr.clearAll();

Returns undefined undefined.

copy

Copies all properties from data to copy object.

Parameters

Examples

deepCopy({}, {a:10}); // {a:10}

Returns Object copied object.

deepCopy

Deep clones all properties from data to copy object.

Parameters

Examples

deepCopy({}, {a:{b:{c:10}}}); // {a:{b:{c:10}}}

Returns Object copied object.

clone

Returns clonned object from given object

Parameters

  • data T Source object.

Examples

clone({}, {a:{b:{c:10}}}); // {a:{b:{c:10}}}

Returns T copied object.

defaultsGenerator

Generator function for defaults in a class constructor.

Parameters

  • attr Object Default Object attribute (optional, default {})

Examples

var def = Utilify.defaultsGenerator({
  id: 0,
  name: 'abc'
});
var vals = def({ name: 'sid' });

EventManager

Custom event manager. Scope based.

Examples

var arr = EventManager.listenTo(obj1, 'Util', respFunc);
EventManager.trigger(obj1, 'Util', data);
EventManager.off(obj1, 'Util', respFunc);

listenTo

Adds an event listener on given context with given event name and callback.

Parameters

once

Adds an event listener on given context with given event name and callback but removes when once executed.

Parameters

trigger

Triggers given event on given context with data.

Parameters

  • context Object The context
  • eventName string The event name
  • data ANY The data

off

Removes an event listener if no callback provided, all events will be removed on context with given event.

Parameters

  • context Object The context
  • eventName string The event name
  • callback Function The callback (optional)

isNumber

Returns true if parameter is number.

Parameters

  • item any parameter to check.

Examples

var myVar = 10; isNumber(myVar); // true

Returns boolean

isFunction

Returns true if parameter is function.

Parameters

  • item any parameter to check.

Examples

var myVar = "str"; isFunction(myVar); // false

Returns boolean

isString

Returns true if parameter is string.

Parameters

  • item any parameter to check.

Examples

var myVar = "str"; isString(myVar); // true

Returns boolean

isBoolean

Returns true if parameter is boolean.

Parameters

  • item any parameter to check.

Examples

var myVar = 10; isBoolean(myVar); // false

Returns boolean

isArray

Returns true if parameter is an array.

Parameters

  • item any parameter to check.

Examples

var myVar = []; isArray(myVar); // true

Returns boolean

argumentsToArray

Converts type arguments into array, with same values

Parameters

  • args argument The arguments

Examples

function myFunc1() {
 myFunc2.apply(this, argumentsToArray(arguments).push(10));
}

Returns Array<any> Array type arguments

removeDuplicates

Removes duplicates elements in array.

Parameters

  • arr Array<T> Array with items of type T, having duplicate items

Examples

removeDuplicates([10,10,20,20,20,30]); // [10,20,30]

Returns Array<T> Array without duplicate items.

Ajax

put

PUT Request, generally used for adding new record in the database. Uses XMLHttpRequest to make an xhr call.

Parameters

  • url string URL for given request.
  • data Object object payload to be sent to server.
  • onSuccess Function Optional, success callback for put operation.
  • onFail Function Optional, error callback for put operation.

Examples

Ajax.put('//google.com').then(...).catch(...);

Returns Promise<any> Promise with response

get

GET Request, generally used to fetch items. Uses XMLHttpRequest to make an xhr call.

Parameters

  • url string URL for given request.
  • onSuccess Function Optional, success callback for put operation.
  • onFail Function Optional, error callback for put operation.

Examples

Ajax.get('//google.com/users').then(...).catch(...);

Returns Promise<any> Promise with response

post

POST Request, generally used to update items in the database. Uses XMLHttpRequest to make an xhr call.

Parameters

  • url string URL for given request.
  • data Object object payload to be sent to server.
  • onSuccess Function Optional, success callback for put operation.
  • onFail Function Optional, error callback for put operation.

Examples

Ajax.post('//google.com/users').then(...).catch(...);

Returns Promise<any> Promise with response

delete

DELETE Request, generally used to remove/delete items from the database. Uses XMLHttpRequest to make an xhr call.

Parameters

  • url string URL for given request.
  • data Object object payload to be sent to server.
  • onSuccess Function Optional, success callback for put operation.
  • onFail Function Optional, error callback for put operation.

Examples

Ajax.delete('//google.com/users').then(...).catch(...);

Returns Promise<any> Promise with response