ooi

const append = require('ooi/append');

let arr1 = [1, 2, 3];

append(arr1, 4, 5, 6);

console.log(arr1)
> [1, 2, 3, 4, 5, 6]

Requires: ooi/append

Filename: ooi/append.js

function

concat () => array

Concatenates arrays.

import concat from 'ooi/concat';

let result = concat();

Filename: ooi/concat.js

function

ensureArray () => array

Wrapper for array.

import ensureArray from 'ooi/ensure-array';

let result = ensureArray();

Requires: concat, is-array

Filename: ooi/ensure-array.js

class

List (...values) => new List

List class.

import List from 'ooi/list';

let result = List(...values);

Requires: define, keys, extend, each, defaults, values, flatten, strcase, range, event-emitter

Filename: ooi/list.js

function

list (...array) => new List(...array)

Creates List object (extends Array) with additional list methods.

import list from 'ooi/list';

let result = list(...array);

Requires: define, keys, extend, each, defaults, values, flatten, strcase, range, event-emitter

Filename: ooi/list.js

Collections

Section, 5 tools

function

clone (data) => data

Shallow copy of object.

import clone from 'ooi/clone';

let result = clone(data);

Requires: each, extend, deep-clone

Filename: ooi/clone.js

function

deepClone (data) => data

Deep copy of object

const deepClone = require('ooi/deep-clone');
// or
const deepClone = require('ooi/clone').deep;

Requires: ooi/deep-clone, ooi/clone, each

Filename: ooi/deep-clone.js

function

each (data, cb) => void

Iterates over all properties of data and calls cb(value, key) for each of them.

import each from 'ooi/each';

let result = each(data, cb);

Requires: keys

Filename: ooi/each.js

function

flatten (object) => object

Flattens all `object` properties and returns plain object.

import flatten from 'ooi/flatten';

let result = flatten(object);

Requires: set, keys

Filename: ooi/flatten.js

function

flatten.unflatten (object) => object

Returns object with resurrected properties structure.

import flatten.unflatten from 'ooi/flatten';

let result = flatten.unflatten(object);

Requires: set, keys

Filename: ooi/flatten.js

Convert

Section, 7 tools

function

base64.decode () => string

Converts base64-string to regular string.

import base64.decode from 'ooi/base64';

let result = base64.decode();

Requires: extend

Filename: ooi/base64.js

function

base64.encode () => string

Convert regular string to base64.

import base64.encode from 'ooi/base64';

let result = base64.encode();

Requires: extend

Filename: ooi/base64.js

function

parse (string) => object

Parse url query string.

import parse from 'ooi/query';

let result = parse(string);

Requires: extend, flatten

Filename: ooi/query.js

function

query (string | object) => object | string

If receives not URI string, returns parsed query object. If receives object, returns stringified query url.

import query from 'ooi/query';

let result = query(string | object);

Requires: extend, flatten

Filename: ooi/query.js

function

stringify (object) => string

Stringifies plain object into query url.

import stringify from 'ooi/query';

let result = stringify(object);

Requires: extend, flatten

Filename: ooi/query.js

function

uri (string) => object

Parses string URI and returns object with properties uri, protocol, host, path, filename, extname, query, request.

import uri from 'ooi/uri';

let result = uri(string);

Requires: extend, flatten, query, path

Filename: ooi/uri.js

function

uri (string) => object

Same as uri.parse.

import uri from 'ooi/uri';

let result = uri(string);

Requires: extend, flatten, query, path

Filename: ooi/uri.js

Events

Section, 1 tools

class

EventEmitter () => new EventEmitter()

Class for events handling.

const ooi = require('ooi');

class Manager extends ooi.EventEmitter {

  constructor () {
    super();
  }

}

let manager = new Manager();

manager.on('message', message => {
  console.log('New message:', message);
});

setTimeout(() => {
  manager.emit('message', 'This is new message!');
}, 1000);

Requires: ooi, each, define, extend

Filename: ooi/event-emitter.js

Format

Section, 2 tools

function

classNames (...any) => array

Receives classes in any format, returns array of class names

import classNames from 'ooi/class-names';

let result = classNames(...any);

Requires: each, flatten

Filename: ooi/class-names.js

function

template (source, opts) => function(data)

Creates function-template with specified template code, which returns content with replaced all expressions surrounded by [[ and ]].

import template from 'ooi/template';

let result = template(source, opts);

Requires: extend, expression, reg, trim, proto

Filename: ooi/template.js

Meta

Section, 2 tools

function

classMeta (Class) => { methods, methodsNames, staticMethods, staticMethodsNames, extended }

Extemdan;

import classMeta from 'ooi/class-meta';

let result = classMeta(Class);

Requires: extend, each, keys

Filename: ooi/class-meta.js

function

wrap.class (Class, options) => Class

Modifies target class with options: init.

import wrap.class from 'ooi/wrap';

let result = wrap.class(Class, options);

Requires: extend, each, define, get, set, keys, expression

Filename: ooi/wrap.js

Objects

Section, 8 tools

function

aliases (data, { propName: [...aliases] }) => data

Defines property aliases for object.

const ooi = require('ooi');

let data = {
  one: 1,
  two: 2,
  three: 3,
};

ooi.aliases(data, {
  one: ['first', 'number1'],
  two: ['second', 'number2'],
  three: ['third', 'number3'],
});

Requires: ooi, each, extend, flatten, defaults, type, get, set, map, keys, trim, ensure-array

Filename: ooi/aliases.js

function

define.box (object, name[, isEnumerable]) => data

Defines new virtual property on object and serves it by property name. If the property gets assigned — new object deep merges with existing.

import define.box from 'ooi/define';

let result = define.box(object, name[, isEnumerable]);

Requires: each, extend, flatten, set, range

Filename: ooi/define.js

function

define.prop ({ object, name, value, get, set, configurable, enumerable, writable }) => object

Defines new property on object.

import define.prop from 'ooi/define';

let result = define.prop({ object, name, value, get, set, configurable, enumerable, writable });

Requires: each, extend, flatten, set, range

Filename: ooi/define.js

function

extend (target, ...sources) => object

Extends `target` object with properties of sources objects.

import extend from 'ooi/extend';

let result = extend(target, ...sources);

Requires: each, set, get, flatten

Filename: ooi/extend.js

function

extend.deep (target, ...sources) => object

Extends `target` object with properties of sources objects (deep extending).

import extend.deep from 'ooi/extend';

let result = extend.deep(target, ...sources);

Requires: each, set, get, flatten

Filename: ooi/extend.js

function

keys (object) => array

Returns array of `object` property names.

import keys from 'ooi/keys';

let result = keys(object);

Filename: ooi/keys.js

function

proto (object) => prototype

Returns object's prototype.

import proto from 'ooi/proto';

let result = proto(object);

Requires: extend

Filename: ooi/proto.js

function

proto.chain (obj1, obj2, obj3) => void

Sets second argument as prototype of first, third as prototype of second etc.

import proto.chain from 'ooi/proto';

let result = proto.chain(obj1, obj2, obj3);

Requires: extend

Filename: ooi/proto.js

Util

Section, 3 tools

class

TypeEntity (opts) => new TypeEntity

Type entity class.

import TypeEntity from 'ooi/type-manager';

let result = TypeEntity(opts);

Requires: is-class, is-array, extend, each, strcase, define, defaults, wrap, flatten, keys, values, sort, set, get, event-emitter, ooi/type-manager

Filename: ooi/type-manager.js

class

TypeManager (opts) => new TypeManager

Type manager class.

import TypeManager from 'ooi/type-manager';

let result = TypeManager(opts);

Requires: is-class, is-array, extend, each, strcase, define, defaults, wrap, flatten, keys, values, sort, set, get, event-emitter, ooi/type-manager

Filename: ooi/type-manager.js

function

typeManager (name, options) => new TypeManager()

Creates and returns new TypeManager instance;

const typeManager = require('ooi/type-manager');

let manager = typeManager('app', {
  // ...
});

manager.create([
  number: {
    matcher: val => !isNaN(val),
    children: {
      integer: {
        matcher: val => +val === Math.round(+val),
      },
    },
  },
]);

Requires: is-class, is-array, extend, each, strcase, define, defaults, wrap, flatten, keys, values, sort, set, get, event-emitter, ooi/type-manager

Filename: ooi/type-manager.js

Utils

Section, 1 tools

function

defaults (data, defaultData) => data

Replaces all undefined properties of data object with defaultData analog.

import defaults from 'ooi/defaults';

let result = defaults(data, defaultData);

Requires: extend, each, keys, flatten, define, set, get

Filename: ooi/defaults.js

Arrays

Section, 5 tools

Collections

Section, 5 tools

Convert

Section, 7 tools

Events

Section, 1 tools

Format

Section, 2 tools

Meta

Section, 2 tools

Objects

Section, 8 tools

Util

Section, 3 tools

Utils

Section, 1 tools