https://github.com/westonganger/rearmed-js

A collection of helpful methods and monkey patches for Arrays, Objects, Numbers, and Strings in Javascript
https://github.com/westonganger/rearmed-js

javascript monkey-patching rearmed-js utilities

Last synced: 4 months ago
JSON representation

A collection of helpful methods and monkey patches for Arrays, Objects, Numbers, and Strings in Javascript

Host: GitHub
URL: https://github.com/westonganger/rearmed-js
Owner: westonganger
License: mit
Created: 2016-08-20T20:58:20.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2023-11-01T00:20:36.000Z (about 2 years ago)
Last Synced: 2025-09-19T02:24:58.358Z (4 months ago)
Topics: javascript, monkey-patching, rearmed-js, utilities
Language: JavaScript
Homepage:
Size: 426 KB
Stars: 103
Watchers: 8
Forks: 4
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

          # Rearmed-JS







 

This library is a collection of helpful methods and monkey patches for Arrays, Objects, Numbers, and Strings in Javascript. Start writing your Javascript like you write your Ruby code! 

Works in the Browser and in NodeJS.

5.1kb minified and gzipped.

# Install

#### Yarn, NPM, Bower

```

yarn add rearmed-js

npm install rearmed-js

bower install rearmed-js

```

#### Rails / Bundler

```ruby

# Gemfile

source 'https://rails-assets.org' do

  gem 'rails-assets-rearmed-js'

end

```

# Usage

Note: Only import/require the patches once at the beginning of your page or app start otherwise you will get warnings about redefining methods.

### Plain HTML

```html

```

### ES7+

```javascript

import 'rearmed-js'; // import everything

// OR 

// import patches for certain object types only

import 'rearmed-js/array';

import 'rearmed-js/number';

import 'rearmed-js/object';

import 'rearmed-js/string';

import 'rearmed-js/generic';

// OR

// import only the methods you want

import 'rearmed-js/array/reject';

import 'rearmed-js/array/select';

```

### ES6

```javascript

require('rearmed-js') // require everything

// OR

// require patches for certain object types only

require('rearmed-js/array');

require('rearmed-js/number');

require('rearmed-js/object');

require('rearmed-js/string');

require('rearmed-js/generic');

// OR

// require only the methods you want

require('rearmed-js/array/reject');

require('rearmed-js/array/select');

```

### Rails

```ruby

/*

 *= require rearmed-js

 *

 * OR for certain object types only

 *= require rearmed-js/array

 *= require rearmed-js/number

 *= require rearmed-js/object

 *= require rearmed-js/string

 *= require rearmed-js/generic

 *

 * OR only the methods you want

 *= require rearmed-js/array/reject

 *= require rearmed-js/array/select

*/

```

# Methods Implemented

## Generic

These methods are available on all types that inherit from Object which is almost everything.

```javascript

var cb = function(){ };

var str = "";

var array = [];

str.equals(array); // returns bool

str.isBlank(); // returns bool

// collections are blank if length == 0

str.isPresent(); // return bool

// collections are present if length > 0

array.presence(); // returns self or false

// same thing as: array.isPresent() ? array : false;

cb.simpleType(); // return str

// possible return values are 'Object','Array','String','Boolean','Number','Function','Other'

// return value or false

str.try('length'); // => 0

array.try('sort'); // => []

str.try('badMethod').try('anotherBadMethod'); // => false

```

## Array

```javascript

var array = [];

var cb = function(val, i){ };

array.any(cb=null) // returns bool

array.all(cb=null) // returns bool

array.compact(badValues=[null, undefined, '']) // returns array, accepts array or splat arguments

  

array.dig(*args) // returns value, accepts splat arguments or array

array.each(function(val, i){ })

array.empty() // return bool

array.equals(array) // returns bool

array.excludes(val, fromIndex=0) //  returns bool

array.find(cb_or_val) // returns value, undefined if not found

array.findIndex(cb_or_val) // returns integer, undefined if not found

array.first() // returns value

array.flatten() // returns array

array.includes(val, fromIndex=0) // returns bool

array.inGroupsOf(int, fillWith=false) // returns nested array

array.groupBy(cb) // returns nested array

array.last // returns value

array.max(cb=null) // returns value

array.maxBy(cb=null) // returns value

array.min(cb=null) // returns value

array.minBy(cb=null) // returns value

array.reject(cb) // reutrns array

array.select(cb) // returns array

array.tap(cb); // returns array

// this is an each method that returns the original array after its done

array.smartIncludes(val, fromIndex=0) // returns bool

// smart meaning that it uses `equals` method to compare if item is Array or Object

array.smartExcludes(val, fromIndex=0) // returns bool

// smart meaning that it uses `equals` method to compare if item is Array or Object

array.sum(cb=null) // returns number

array.uniq(cb=null) // returns array

/* CLASS METHODS - Not available in Typescript */

Array.range(startNumber, endNumber, step=1) // returns array

```

## Object (Hash)

```javascript

var obj = {};

// Monkey-patching Object is very dangerous, so we only patch it with one method

obj = obj.rearmed(); 

var cb = function(key, val){ };

obj.all(cb=null) // returns bool

obj.any(cb=null) // returns bool

obj.compact(badValues=[null, undefined, '']) // returns object, accepts array or splat arguments

obj.dig(*args) // returns object, accepts splat arguments or array

obj.each(cb);

obj.empty() // returns bool

obj.equals(obj) // returns bool

obj.except(*keys) // returns object, accepts keys as splat arguments or an array

obj.hasKey() // returns bool

obj.hasValue() // returns bool

obj.join(cb, delimiter=', ') // returns string

obj.keys() // returns array

obj.merge(obj) // returns object

obj.only(*keys) // returns object, accepts keys as splat arguments or an array

obj.reject(cb) // returns object

obj.select(cb) // returns object, known to cause error with React select elements

obj.values() // returns array

```

When requiring Object patches individually you must first require `object/rearmed`. Example:

```javascript

require('rearmed-js/object/rearmed');

require('rearmed-js/object/select');

require('rearmed-js/object/reject');

```

The following methods are used under the hood to provide patches to Object. I have exposed these methods publicly so that you can add your own custom methods to `rearmed()` objects. These methods are available on Object after requiring either of these: `rearmed-js/object/rearmed` or `rearmed-js`

```javascript

Object.rearmed.add({

  myMethodName: function(){

    // add new method to rearmed() objects

  }

);

Object.rearmed.remove(

  myMethodName: function(){

    // remove method from rearmed() objects

  }

);

```

## Number

```javascript

var num = 8.5;

num.ceil() // returns number

num.floor() // returns number

num.isDecimal() // returns bool

num.isEven() // returns bool

num.isInteger() // returns bool

num.isOdd() // returns bool

num.round() // returns number

```

## String

```javascript

var str = 'Hello World':

str.capitalize() // returns string

str.caseCmp(str) // returns bool

str.chars() // returns array

str.downcase() // returns string

str.empty() // returns bool

str.endsWith(val) // returns bool

str.excludes(val, fromIndex=0) // returns bool

str.gsub(str, toStr) // returns string

str.includes(val, fromIndex=0) // returns bool

str.lstrip() // returns string

str.reverse() // returns string

str.rstrip() // returns string

str.startsWith(val) // returns bool

str.strip() // returns string

str.sub(str, toStr) // returns string

// Warning: doesn't warn when it overwrites the original sub method as it has been removed from the JS standard.

str.titleize(onlyFirstLetters=true) // returns string

str.toBool() // returns bool

str.upcase() // returns string

```

# Browser / NodeJS / Typescript Support

- Browser support is IE 9+ and everything else. Use the files in the `dist` folder if you need pre-minified files.

- Array `find` doesnt work properly in old NodeJS 0.x and iojs.

- String `empty` doesnt work properly in old NodeJS 0.x.

- Typescript is supported however it does not support Class methods because its not possible to define static methods on existing interfaces such as Array. At this time the only effected method is `Array.range`

# Contributing

- I recommend discussing your intentions via an issue before making a PR because there are very concious design choices that must go into this library.

- Only edit js files from `src/` and `test/` folders.

- Use the gulp task: `gulp` to run the build after making your changes.

- PR's should include tests. Testing these methods are simple & easy, check the test folder to see how it works.

# Credits

Created by Weston Ganger - [@westonganger](https://github.com/westonganger)

## Similar Libraries Created By Me

- [JS-Try](https://github.com/westonganger/js-try)

- [Rearmed-CSS](https://github.com/westonganger/rearmed-css)

- [Rearmed Ruby](https://github.com/westonganger/rearmed-rb)

- [Rearmed Rails](https://github.com/westonganger/rearmed_rails)

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/westonganger/rearmed-js

Awesome Lists containing this project

README