rgjs6 v0.2.8

RGJS6

A bag of useful tools, now ES6-ified.

Getting started

Install via npm:

npm install rgjs6

Usage

Documentation

You can find a copy of the full jsdoc here

ES6 Modules

If you're using ES modules in nodejs or a bundler that can find node_modules:

// Entire rgjs library
import rgjs from 'rgjs6';

// Specific sub-module:
import * as array from 'rgjs6/array'; // (tree-shakable!)
import { array, obj } from 'rgjs6';

// Or a specific method (tree-shakable!)
import { isArray } from 'rgjs6/array';
import { isObject } from 'rgjs6/obj';

Without a bundler:

// Entire rgjs library
import rgjs from './node_modules/rgjs6/dist/rgjs6.esm.min.js';

// Specific sub-module:
import * as array from './node_modules/rgjs6/dist/esm/array.js'; // (tree-shakable!)
import { array, obj } from './node_modules/rgjs6/dist/rgjs6.esm.min.js';

// Or a specific method: (tree-shakable!)
import { isArray } from './node_modules/rgjs6/dist/esm/array.js';
import { isObject } from './node_modules/rgjs6/dist/esm/obj.js';

CommonJS (nodejs)

// Entire rgjs library
const rgjs = require('rgjs6');

// Specific sub-module:
const array = require('rgjs6/array');
const obj = require('rgjs6/obj');

// Or a specific method:
const isArray = require('rgjs6/array').isArray;
const isObject = require('rgjs6/obj').isObject;

UMD (browser, workers)

Browser:

<!-- From node_modules -->
<script src="node_modules/rgjs6/dist/rgjs6.umd.min.js"></script>

<!-- From unpkg -->
<script src="https://unpkg.com/rgjs6@latest/dist/rgjs6.umd.min.js"></script>

Workers:

// From node_modules
self.importScripts('./node_modules/rgjs6/dist/rgjs6.umd.min.js');

// From unpkg
self.importScripts('https://unpkg.com/rgjs6@latest/dist/rgjs6.umd.min.js');

Polyfills

RGJS should work on all modern browsers. That said, if you need to support IE it may require a polyfill or two, depending on the methods you use:

• Array.isArray()
• Object.entries()
• Object.keys() and -.values()
• CustomEvent