myrmidon

package myrmidon provides a list of common utilities for comfortable work with js projects.

Version Bundle size Downloads

CodeFactor SonarCloud Codacy Total alerts Language grade Scrutinizer

Dependencies Security Build Status Coverage Status

Commit activity FOSSA License

Table of Contents

Requirements

Platform Status

To use library you need to have node and npm installed in your machine:

  • node 6.0+
  • npm 3.0+

Package is continuously tested on darwin, linux, win32 platforms. All active and maintenance LTS node releases are supported.

Installation

To install the library run following command

  npm i --save myrmidon

Usage

Read full Reference

benchmark

array

  • toArray - transforms any value to Array
  • uniqueFilter - generates filter function, that leaves only unique items
  • uniqueIdFilter - filter function, that leaves only unique items with same id property
  • uniqueIdenticFilter - filter function, that leaves only identicly unique items (same by ===)
  • existanceFilter - filter function, that leaves only exited values
  • passFilter - filter function, that leaves all items
  • flatten - flattens array
  • isUnique - checks are all items of array unique
  • last - get last element of an array

checkType

  • isString - determines whether the value is string
  • isClass - determines whether the value is class
  • isFunction - determines whether the value is function
  • isObject - determines whether the value is an object
  • isArray - determines whether the value is array
  • isPromise - determines whether the value is promise
  • isValue - determines whether the value is set
  • isNumber - determines whether the value is Number
  • isBoolean - determines whether the value is Boolean
  • isStream - determines whether the value is Stream
  • isGetter - determines whether the value is function getter
  • isRegexp - determines whether the value is regualr expression

custom

  • retry - Retrying function calls on errors
  • getProp - Get nested property of object
  • fill - Fills string template with specified data
  • searchFor - Search all occurrences of pattern in text

object

  • cleanUndefined - cleans object from undefined fields recursievly
  • clone - create deep clone of object
  • isEmpty - determines whether the object or array is empty

Contribute

Make the changes to the code and tests. Then commit to your branch. Be sure to follow the commit message conventions. Read Contributing Guidelines for details.