diff --git a/.eslintrc.js b/.eslintrc.js index ffd3427..c5c80fc 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -7,6 +7,14 @@ module.exports = { 'jsdoc/require-param': 'error', 'jsdoc/require-param-description': 'error', 'jsdoc/require-returns-type': 'error', + + // 'filenames/match-regex': [2, '^[a-z_]+[a-zA-Z_]+$', true], + // "filenames/match-exported": [2, [ null, "kebab", "snake" ] ], + // "filenames/match-exported": [ 2, null, "\\.react$" ], + // 'filenames/match-regex': 2, + // 'filenames/match-exported': 2, + // 'filenames/no-index': 2, + // 'inferno/display-name': 'OFF', // 'inferno/display-no-depreciated': 'OFF', }, diff --git a/Makefile b/Makefile index 6e90b4f..d416f4b 100644 --- a/Makefile +++ b/Makefile @@ -41,6 +41,9 @@ lint: docgen: node build/cli --docs +site: + node docs/_site/index.js + dox: yarn run dox -- 'src/**/*.js' --layout markdown --output docs/bits/doxdox.md @@ -58,6 +61,9 @@ babel: tests: yarn run test -- --notify +frisbee: + cd _modules/frisbee && npm run test + testdist: yarn run ava -- test/built.js --verbose diff --git a/README.md b/README.md index a3840d9..bbc790e 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,11 @@ [![BuildStatus](https://travis-ci.org/fluents/awesome-fluents.svg?branch=master)](https://travis-ci.org/fluents/awesome-fluents) [![Coverage Status](https://coveralls.io/repos/github/fluents/chain-able/badge.svg?branch=master)](https://coveralls.io/github/fluents/chain-able?branch=master) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/b1d92a30c4aa43df9a6233cfadde2307)](https://www.codacy.com/app/aretecode/chain-able?utm_source=github.com&utm_medium=referral&utm_content=fluents/chain-able&utm_campaign=Badge_Grade) -[![gzip size](http://img.badgesize.io/https://unpkg.com/chain-able@3.0.0/index.amd.js?compression=gzip)](https://unpkg.com/chain-able@3.0.0) +[![gzip size](http://img.badgesize.io/https://unpkg.com/chain-able@4.0.6/dists/amd/index.js?compression=gzip)](https://unpkg.com/chain-able@4.0.6) + [![fluent](https://img.shields.io/badge/⛓-fluent-9659F7.svg)](https://github.com/fluents/awesome-fluents) [![fluent](https://img.shields.io/badge/🎡-playground-black.svg)](https://aretecode.github.io/chain-able-playground/) - - [david-deps-img]: https://img.shields.io/badge/0-dependencies-blue.svg [david-deps-url]: https://david-dm.org/fluents/chain-able [chain-able-npm-image]: https://img.shields.io/npm/v/chain-able.svg @@ -57,6 +56,8 @@ > interfaces that describe their intentions +❗ chain-able now has a website! +[🔗 chain-able.js.org](https://chain-able.js.org) ### 📦 install @@ -65,6 +66,11 @@ yarn add chain-able npm i chain-able --save ``` +#### cdn +- _dev_ `` +- _min_ `` + + # 🏰 benefits writing an api using chain-able means: @@ -78,8 +84,8 @@ writing an api using chain-able means: - [expressive, clearly communicative code][wiki] - [runtime type validation][Schema] -- [🔬 230+ tests][Tests] with [96%+ code coverage][cov] -- ⚡ [performant & tiny][Src] `~7kb` _(gzip)_ [_300 byte_ minimal version available as snippet][snippet] +- [🔬 300+ tests][Tests] with [96%+ code coverage][cov] +- ⚡ [performant & tiny][Src] `~8kb` _(gzip)_ [_300 byte_ minimal version available as snippet][snippet]
more... @@ -123,7 +129,6 @@ writing an api using chain-able means: - [🏭 infinitely nestable understandable factories][FactoryChain] - [▶️◀️ easy deep merging][MergeChain] - [☮️ compatibility - typescript, nodejs, webpack, rollup, fusebox, babel, buble, amd][API] -- ⚡ performant & tiny `~7kb` _(gzip)_ [_300 byte_ minimal version available as snippet][snippet]
@@ -140,4 +145,4 @@ writing an api using chain-able means: - thanks to [Jon Schlinkert](https://github.com/jonschlinkert/kind-of) & [inferno](https://github.com/infernojs/inferno/blob/master/packages/inferno-shared/src/index.ts) for type checking inspirations - transpiled with [buble](https://gitlab.com/Rich-Harris/buble) - [Martin Fowler on FluentInterface](https://www.martinfowler.com/bliki/FluentInterface.html) - +- [ramda](https://github.com/ramda/ramda) & [lodash](https://github.com/lodash/lodash) for some well tested & documented utilities (currying, mapping) diff --git a/_modules/_chain-able-md/package.json b/_modules/_chain-able-md/package.json index 3b9c3de..d13bf2e 100644 --- a/_modules/_chain-able-md/package.json +++ b/_modules/_chain-able-md/package.json @@ -10,9 +10,6 @@ "babel-plugin-transform-flow-strip-types": "^6.22.0" }, "dependencies": { - "fliplog": "^1.0.4", - "frisbee": "^1.5.0", - "node-fetch": "^1.7.1", - "xmlhttprequest": "^1.8.0" + "fliplog": "^1.0.4" } } diff --git a/_modules/_chain-able-md/src/Frisbee.js b/_modules/_chain-able-md/src/Frisbee.js deleted file mode 100644 index 61059e6..0000000 --- a/_modules/_chain-able-md/src/Frisbee.js +++ /dev/null @@ -1,440 +0,0 @@ -// eslint-disable-next-line -'use strict' -// frisbee -// Copyright (c) 2015- Nick Baugh -// MIT Licensed -// * Author: [@niftylettuce](https://twitter.com/#!/niftylettuce) -// * Source: -// # frisbee - -const {Buffer} = require('buffer') -const qs = require('qs') -const isJSON = require('./isJSON') -const { - Chain, - isFunction, - isString, - isObjPure, - isReal, - isUndefined, - isObj, - isArray, - isNull, - isNill, - merge, -} = require('./chains') - -const fetch = typeof window === 'object' ? window.fetch : global.fetch -const mergeOpts = {clone: true} - -const validations = [ - // 0 fatal.fetch - 'A global `fetch` method is required as either `window.fetch` ' + - 'for browsers or `global.fetch` for node runtime environments. ' + - 'Please add `require(\'isomorphic-fetch\')` before importing `frisbee`. ' + - 'You may optionally `require(\'es6-promise\').polyfill()` before you ' + - 'require `isomorphic-fetch` if you want to support older browsers.' + - '\n\nFor more info: https://github.com/niftylettuce/frisbee#usage', - // 1 validate.fatal.baseuri* - 'baseURI option is required', - // 2 validate.path.string - '`path` must be a string', - // 3 validate.opts.obj - '`options` must be an object', - // 4 validate.auth.keys - 'auth option can only have two keys `[user, pass]`', - // 5 validate.auth.user.string - 'auth option `user` must be a string', - // 6 validate.auth.pass.string - 'auth option `pass` must be a string', - // 7 validate.auth.jwt.string - 'jwt token must be a string', - `Invalid JSON received from`, -] - -// @TODO could also just put strings here but then they are allocated each time -// using `_` instead of dot for easier selection -// could also assign to variables but array isn't so bad for order and the eyes and ease -// smaller this way, but changes stack... -const errMsg = msg => { - if (msg === 'req_fetch') return validations[0] - else if (msg === 'req_base') return validations[1] - else if (msg === 'str_path') return validations[2] - else if (msg === 'obj_opts') return validations[3] - else if (msg === 'auth_keys') return validations[4] - else if (msg === 'str_user') return validations[5] - else if (msg === 'str_pass') return validations[6] - else if (msg === 'str_jwt') return validations[7] - else if (msg === 'json') return validations[8] -} -const throwWithMsg = msg => { - throw new Error(errMsg(msg)) -} - -if (!fetch) throw new Error(errMsg('req_fetch')) - -const methods = ['get', 'head', 'post', 'put', 'del', 'options', 'patch'] - -const respProperties = { - readOnly: [ - 'headers', - 'ok', - 'redirected', - 'status', - 'statusText', - 'type', - 'url', - 'bodyUsed', - ], - writable: ['useFinalURL'], - callable: [ - 'clone', - 'error', - 'redirect', - 'arrayBuffer', - 'blob', - 'formData', - 'json', - 'text', - ], -} - -const getContentType = headers => { - if (isNill(headers)) { - return null - } - else if (isFunction(headers.get)) { - return headers.get('Content-Type') || headers.get('content-type') - } - else if (isObj(headers)) { - return headers['Content-Type'] || headers['content-type'] - } -} - -// determine whether we're returning text or json for body -// or attempt to parse json body to use as error message -async function parseFrisbeeResponseBody(res, contentTypeJSON) { - if (contentTypeJSON) { - if (isFunction(res.json)) { - res.body = await res.json() - } - else { - res.body = await res.text() - - // @NOTE good thing to test solidly - if (isJSON(res.body)) { - res.body = JSON.parse(res.body) - } - else { - res.err = this.handleError('json') - } - } - return res - } - else { - res.body = await res.text() - } - return res -} - -/* prettier-ignore */ -function formatFrisbeeResponseError(res, contentTypeJSON, baseURI) { - res.err = new Error(res.statusText) - - // check if the response was JSON, and if so, better the error - if (contentTypeJSON) { - // @TODO Glazed? - // attempt to use Glazed error messages - if (isObj(res.body) && isString(res.body.message)) { - res.err = new Error(res.body.message) - } - // attempt to utilize Stripe-inspired error messages - else if (!(isArray(res.body) && isObj(res.body.error))) { - if (res.body.error.message) res.err = new Error(res.body.error.message) - if (res.body.error.stack) res.err.stack = res.body.error.stack - if (res.body.error.code) res.err.code = res.body.error.code - if (res.body.error.param) res.err.param = res.body.error.param - } - } -} - -function createFrisbeeResponse(origResp) { - const resp = { - originalResponse: origResp, - } - - respProperties.readOnly.forEach(prop => - Object.defineProperty(resp, prop, { - value: origResp[prop], - }) - ) - - respProperties.writable.forEach(prop => - Object.defineProperty(resp, prop, { - get() { - return origResp[prop] - }, - set(value) { - origResp[prop] = value - }, - }) - ) - - let callable = null - respProperties.callable.forEach(prop => { - Object.defineProperty(resp, prop, { - value: ( - (callable = origResp[prop]), - isFunction(callable) && callable.bind(origResp) - ), - }) - }) - - // easy vanilla access headers - const headersObj = {} - origResp.headers.forEach(pair => { - headersObj[pair[0]] = pair[1] - }) - Object.defineProperty(resp, 'headersObj', { - value: headersObj, - }) - - return resp -} - -// easy destructure err -const fetchIt = async(url, opts) => { - let error = null - try { - const result = await fetch(url, opts) - return [error, result] - } - catch (e) { - return [e, null] - } -} - -/* prettier-ignore */ -class Frisbee extends Chain { - constructor(opts = {}) { - super() - - this - .extend(['headers', 'arrayFormat']) - // .autoGetSet() - // .getSet() - // .build() - - .opts(opts) - .headers(opts.headers) - .arrayFormat(opts.arrayFormat || 'indices') - .when(opts.auth, () => this.auth(opts.auth)) - - // @default - // wish you could make better stack traces once thrown? extend error?? - this.onError(function defaultErrorThrower(error) { - console.log('throwing...') - // throw error - }) - - // because conflicting names - this._get = this.get.bind(this) - - methods.forEach(method => { - this[method] = this._setup(method) - }) - - // already bound - // this.httpGet = this._get - // this._get = (arg1, arg2) => { - // if (isUndefined(arg2)) - // } - } - opts(opts) { - // validate - if (!opts.baseURI) this.handleError('req_base') - this.set('opts', opts) - return this - } - - // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error#Custom_Error_Types - // can have arrays of handlers, middleware, this is baby steps - onError(handler) { - return this.set('onError', handler) - } - handleError(msg, data) { - const error = new Error(msg) - error.data = data - console.log({data}) - throw error - - try { - const error = new Error(msg) - // newest at top, remove this line - // error.stack = error.stack.split('\n') - // error.stack.shift() - // error.stack = error.stack.join('\n') - const onerr = this._get('onError') - onerr(error) - } - catch (e) { - console.log({e}) - } - console.log('wut in the fuck') - // this._get('onError').call(this, error, this) - } - - /** - * @methodFactory - * @method - * @memberOf frisbee - * @protected - * @param {string} method enum - * @return {Frisbee} @chainable - */ - _setup(methodKeyword) { - return (path = '/', options = {}) => { - // validate --- - - // path must be string - if (!isString(path)) this.handleError('str_path') - - // otherwise check if its an object - if (!isObjPure(options)) this.handleError('obj_opts', options) - - // console.log('about to get', this) - // require('fliplog').quick(this) - - // setup data --- - const baseURI = this._get('opts').baseURI - - // swappable/placeholder var to use existing them update with merged - let headers = this._get('headers') - - // --- here down is not tied to any instance --- - - // don't want to override param, - // and it's easier to read as a descriptive variable - // @NOTE would be a good transform - const method = - methodKeyword === 'del' ? 'DELETE' : methodKeyword.toUpperCase() - - // merge headers when we have them - if (isObj(options) && options.headers) { - headers = merge(headers, options.headers, mergeOpts) - } - const opts = merge(options, {headers, method}, mergeOpts) - - // remove any nil or blank headers - // (e.g. to automatically set Content-Type with `FormData` boundary) - Object.keys(opts.headers).forEach(key => { - if (!isReal(opts.headers[key])) delete opts.headers[key] - }) - - - /** - * in order to support Android POST requests - * we must allow an empty body to be sent - * @see https://github.com/facebook/react-native/issues/4890 - */ - if (isUndefined(opts.body)) { - if (opts.method === 'POST') opts.body = '' - } - else if (isObj(opts.body)) { - if (opts.method === 'GET' || opts.method === 'DELETE') { - path += `?${qs.stringify(opts.body, {arrayFormat: this._get('arrayFormat')})}` - delete opts.body - } - // @TODO: better stringify here - else { - /* - * @NOTE using caseless means checking - * permutations of casings - * encouraging bad practice - * and doing a massive amount of loops - * when it just simply isn't in the headers - */ - const reqContentType = opts.headers ? getContentType(opts.headers) : false - - if (reqContentType && reqContentType.split(';')[0] === 'application/json') { - try { - opts.body = JSON.stringify(opts.body) - } - catch (err) { - throw err - } - } - } - } - - // @TODO does this part here ever throw to wrap try catch? - const dofetch = async() => { - const [error, ogRes] = await fetchIt(baseURI + path, opts) - - // simple error - if (!isNill(error)) { - // @TODO @DEV - console.log('has error', {error}) - return Promise.reject(error) - } - - const res = createFrisbeeResponse(ogRes) - const contentType = res.headers.get('Content-Type') - const contentTypeJSON = - isString(contentType) && - contentType.includes('application/json') - - await parseFrisbeeResponseBody(res, contentTypeJSON) - if (!res.ok) formatFrisbeeResponseError(res, contentTypeJSON, baseURI) - - return Promise.resolve(res) - } - - return dofetch() - } - } - - delAuth() { - return this.delete('headers.Authorization') - } - setAuth(Authorization) { - return this.set('headers.Authorization', Authorization) - } - - auth(creds) { - // if it has :, split into array - if (isString(creds)) { - const index = creds.indexOf(':') - if (index !== -1) { - creds = [creds.substr(0, index), creds.substr(index + 1)] - } - } - - // @TODO this is no good... - if (!isArray(creds)) creds = [].slice.call(arguments) - - // essentially padd out our credentials with empty - if (creds.length === 0) creds = ['', ''] - else if (creds.length === 1) creds.push('') - else if (creds.length !== 2) this.handleError('auth_keys') - - // @TODO can do 1 step further with validation as in split plugin - if (!isString(creds[0])) this.handleError('str_user') - if (!isString(creds[1])) this.handleError('str_pass') - - if (!creds[0] && !creds[1]) this.delAuth() - else this.setAuth(`Basic ${new Buffer(creds.join(':')).toString('base64')}`) - - return this - } - - jwt(token) { - if (isNull(token)) return this.delAuth() - else if (isString(token)) return this.setAuth(`Bearer ${token}`) - else return this.handleError('str_jwt') - } -} - -module.exports = function Frisbees(opts) { - return new Frisbee(opts) -} diff --git a/_modules/_chain-able-md/src/github.js b/_modules/_chain-able-md/src/github.js index abcc847..a7bb8b0 100644 --- a/_modules/_chain-able-md/src/github.js +++ b/_modules/_chain-able-md/src/github.js @@ -3,7 +3,7 @@ // const {XMLHttpRequest} = require('xmlhttprequest') global.fetch = require('node-fetch') -var Frisbees = require('./Frisbee') +var Frisbees = require('../../frisbee') var log = require('fliplog') log.registerCatch() diff --git a/_modules/_chain-able-md/src/isJSON.js b/_modules/_chain-able-md/src/isJSON.js deleted file mode 100644 index 565e8ee..0000000 --- a/_modules/_chain-able-md/src/isJSON.js +++ /dev/null @@ -1,130 +0,0 @@ -// https://bitsrc.io/amit/json/global/json-validator/code - -// const isString = require('./string') -// const onlyLettersAndSpaces = /^([\sa-z]+)*$/gim - -// const regexp = /[\"|\{|\[|\}|]+/ -// const chars = ['[', '"', '{', ']', '}'] -// const nums = [91, 34] -// const map = { -// '"': 34, -// '{': 123, -// '}': 125, -// ']': 93, -// '[': 91, -// } - -// these exist in /is -var isArray = Array.isArray -var isString = x => typeof x === 'string' -var isNumber = x => typeof x === 'number' -var toRegExp = str => new RegExp(str.replace(/[|\\{}()[\]^$+*?.]/g, '\\$&')) -var isTrue = x => x === true - -// @TODO everything like this -// eslint-disable-next-line no-useless-escape -var JSONAlphaOmega = x => - x === 93 || x === 91 || x === 125 || x === 123 || x === 34 - -/* prettier-ignore */ -/** - * @desc isOdd - * @param {number | any} x value to check - * @return {boolean} isOdd - * - * @see https://stackoverflow.com/questions/6211613/testing-whether-a-value-is-odd-or-even (smaller solution than original) - * @extends isNumber - * @alternate n % 2 === 0 - * - * @example - * - * isOdd(1) - * //=> true - * isOdd(2) - * //=> false - */ -function isOdd(x) { - return isNumber(x) && (x & 1) -} - -// @TODO auto-curry -function isAbove() {} -function isBelow() {} -function isBetween() {} - -/** - * @desc isEven - * @param {number | any} x value to check - * @return {boolean} isEven - * - * @extends isOdd - * @variations inverse - * - * @example - * - * isEven(1) - * //=> false - * isEven(2) - * //=> true - * - * var rando = Math.floor(Math.random(0, 10000)) - * isEven(rando) !== isOdd(rando) - * //=> true - * - */ -function isEven(x) { - return !isOdd(x) -} - -/** - * @alias occurrs - * @alias getIncludesCount - * - * @param {string | Array} haystack - * @param {string | Matchable} needle - * @return {number} occurrs/includes times/count - */ -const getIncludesCount = (haystack, needle) => { - if (isString(haystack)) { - return haystack.split(needle).length - 1 - } - else if (isArray(haystack)) { - return haystack.filter(straw => toRegExp(needle).test(straw)) - } -} - -function hasWith(x, fn, symbol) { - if (isArray(symbol)) return symbol.map(s => hasWith(x, fn, s)).every(isTrue) - else return fn(getIncludesCount(x.split(''), symbol)) -} - -/* prettier-ignore */ -/** - * @desc isJSON, without tryCatch - * @param {*} x value to check - * @return {boolean} x isJSON - * - * @example - * isJSON('{}') - * // => true - * - * isJSON('') - * // => false - * - * isJSON('[]') - * // => true - */ -function isJSON(x) { - return isString(x) && x.split(',').every(subString => { - const trimmed = subString.trim() - const start = trimmed.charCodeAt(0) - const end = trimmed.charCodeAt(trimmed.length - 1) - return JSONAlphaOmega(start) && JSONAlphaOmega(end) - }) -} - -function isJSONSafe(x) { - return isJSON(x) && hasWith(x, isEven, ['[', ']', '{', '}', '"']) -} - -module.exports = isJSON diff --git a/_modules/_chain-able-md/test/index.js b/_modules/_chain-able-md/test/index.js new file mode 100644 index 0000000..8315b1c --- /dev/null +++ b/_modules/_chain-able-md/test/index.js @@ -0,0 +1,18 @@ +const todo = console.log + +todo('badge html output') +todo('marked to html example') +todo('frisbee in examples + isJSON in examples') +todo('github api - can copy?') +todo('isjson test') +todo('find list of tags for md to loop thru') +todo('pkgr') + +todo('there are not too many markdown places in docdown so use it there') + +todo(`make some reusable parts for string building + like the string chain had a few elements that + provided potential to do but was not created + for that purpose at all and had some technical debt`) + +todo('use it to make plugins') diff --git a/_modules/_docdown/index.js b/_modules/_docdown/index.js index 2361b0c..d483a6f 100755 --- a/_modules/_docdown/index.js +++ b/_modules/_docdown/index.js @@ -29,6 +29,7 @@ function docdown(options) { style: 'default', title: 'API documentation', toc: 'properties', + metadata: true, // @TODO debug: false, diff --git a/_modules/_docdown/lib/generator.js b/_modules/_docdown/lib/generator.js index 3bebd1f..f3ce0ba 100644 --- a/_modules/_docdown/lib/generator.js +++ b/_modules/_docdown/lib/generator.js @@ -71,7 +71,10 @@ function escape(string) { * @returns {string} Returns the member seperator. */ function getSeparator(entry) { - return entry.isPlugin() ? '.prototype.' : '.' + return '.' + + // @NOTE: removed this temporarily, is ugly + // return entry.isPlugin() ? '.prototype.' : '.' } /*----------------------------------------------------------------------------*/ @@ -92,6 +95,7 @@ function generateDoc(source, options) { const byCategories = options.toc === 'categories' const entries = getEntries(source) const organized = {} + const useMetadata = options.metadata const sortEntries = options.sort const {style, url, files} = options @@ -180,10 +184,34 @@ function generateDoc(source, options) { // Start markdown for the entry. const entryMarkdown = ['\n\n'] - const {linksToString, seeToString, makeTypes, makeTests} = maker(files, entry, entryMarkdown) + const { + linksToString, + seeToString, + makeTypes, + makeTests, + } = maker(files, entry, entryMarkdown) + + // @NOTE: moved here to add as metadata to toc for search with data-* attr + const links = entry.getLink() + const see = entry.getSee() + const notes = entry.getNote() + const todos = entry.getTodo() + const sig = entry.getSig() + const symb = entry.getSymb() + const klass = entry.getClass() + const klassDesc = entry.getClassDesc() + const klassProps = entry.getClassProps() + const xtends = entry.getExtends() + const variation = entry.getVariation() + const description = entry.getDesc() + const hash = entry.getHash(style) + const call = entry.getCall() + const category = entry.getCategory() + const entryData = { - call: entry.getCall(), - category: entry.getCategory(), + call, + see, + category, // eslint-disable-next-line no-template-curly-in-string entryHref: '#${hash}', entryLink: _.get( @@ -192,12 +220,12 @@ function generateDoc(source, options) { // eslint-disable-next-line no-template-curly-in-string style === 'github' ? '' : '# ' ), - hash: entry.getHash(style), + hash, member, name, separator, + description, sourceHref: url + '#L' + entry.getLineNumber(), - sourceLink: '\n' + _.get( options, 'sourceLink', @@ -229,38 +257,43 @@ function generateDoc(source, options) { } ) - // Add the heading. - entryMarkdown.push( + let entryLinkTemplate = '' + entryLinkTemplate += '${entryLink}${member}${separator}${call}\n' + - interpolate( - // eslint-disable-next-line no-template-curly-in-string - _(['${sourceLink}', _.get(options, 'sublinks', []), '${tocLink}']) - .flatten() - .compact() - .join(' '), - entryData - ).replace(/ {2,}/g, ' '), + _(['${sourceLink}', _.get(options, 'sublinks', []), '${tocLink}']) + .flatten() + .compact() + .join(' '), entryData - ) + ).replace(/ {2,}/g, ' '), + entryData ) + // Add the heading. + entryMarkdown.push(renderedHeading) + // Add the description. - entryMarkdown.push('\n' + entry.getDesc() + '\n') + entryMarkdown.push('\n' + description + '\n') // ----- new ----- - const links = entry.getLink() - const see = entry.getSee() - const notes = entry.getNote() - const todos = entry.getTodo() - const sig = entry.getSig() - const symb = entry.getSymb() - const klass = entry.getClass() - const klassDesc = entry.getClassDesc() - const klassProps = entry.getClassProps() - const xtends = entry.getExtends() - const variation = entry.getVariation() const news = { see, @@ -278,6 +311,7 @@ function generateDoc(source, options) { // log.white('new').data(news).echo(false) + const h4 = '\n#### @' const newsKeys = Object.keys(news) newsKeys.forEach(key => { const value = news[key] @@ -308,7 +342,7 @@ function generateDoc(source, options) { log.yellow('is @see').data(seeString).echo(false) if (value.length !== 0) { - entryMarkdown.push('\n### @' + key + ' \n') + entryMarkdown.push(h4 + key + ' \n') entryMarkdown.push(seeString) } } @@ -316,7 +350,7 @@ function generateDoc(source, options) { entryMarkdown.push(value + ' ') } else if (key === 'extends') { - const md = '\n### @' + key + const md = h4 + key const augments = value if (augments.length === 1) { entryMarkdown.push(md) @@ -334,7 +368,7 @@ function generateDoc(source, options) { // log.cyan('\n### @' + key + ' \n').data({data: value, str}).echo(false) if (str === ' ') return - entryMarkdown.push('\n### @' + key + ' \n') + entryMarkdown.push(h4 + key + ' \n') entryMarkdown.push(str) } // console.log('###H3: ' + key + ': ', news[key], news[key] + ' <- ') @@ -344,7 +378,7 @@ function generateDoc(source, options) { // Add optional since version. const since = entry.getSince() if (!_.isEmpty(since)) { - entryMarkdown.push('#### Since', since, '') + entryMarkdown.push(h4 + 'Since', since, '') } // @TODO: needs comments not just tag // var version = entry.getVersion() @@ -353,7 +387,7 @@ function generateDoc(source, options) { // } // Add optional aliases. - var aliases = entry.getAliases() + let aliases = entry.getAliases() if (!_.isEmpty(aliases)) { entryMarkdown.push( '#### Aliases', @@ -429,6 +463,7 @@ function generateDoc(source, options) { examples.map(example => entryMarkdown.push('#### Example', example)) } + // ---- // End markdown for the entry. @@ -469,8 +504,8 @@ function generateDoc(source, options) { if (sortEntries && organized[group]) { // Sort the TOC groups. organized[group].sort(function(value, other) { - var valMember = value.getMembers(0) - var othMember = other.getMembers(0) + const valMember = value.getMembers(0) + const othMember = other.getMembers(0) return util.compareNatural( (valMember ? valMember + getSeparator(value) : '') + value.getName(), @@ -479,6 +514,7 @@ function generateDoc(source, options) { }) } + // ----------- // Add TOC entries for each category. _.each(organized[group], function(entry) { const member = entry.getMembers(0) || '' @@ -489,6 +525,50 @@ function generateDoc(source, options) { return } + // @NOTE: added for metadata + const see = entry.getSee() + const notes = entry.getNote() + const todos = entry.getTodo() + const sig = entry.getSig() + const symb = entry.getSymb() + const klass = entry.getClass() + const klassDesc = entry.getClassDesc() + const klassProps = entry.getClassProps() + const xtends = entry.getExtends() + const description = entry.getDesc() + const call = entry.getCall() + const category = entry.getCategory() + + const meta = ` + ${(klass || '')} + ${(klassDesc || '')} + ${(xtends || '')} + ${(symb || '')} + ${(call || '')} + ${(sig || '')} + `.trim().replace(/\r\t/gmi, '') + + // @TODO could do examples too... + const metadata = { + meta, + call, + category, + description, + name, + member, + see, + notes, + todos, + klassProps, + } + + log.bold('toc').data({metadata}).echo() + + const metaKeys = Object.keys(metadata) + metadata.all = {} + metaKeys.forEach(key => metadata.all[key] = metadata[key]) + + if (entry.isAlias()) { // An alias has a more complex html structure. const owner = entry.getOwner() @@ -504,10 +584,13 @@ function generateDoc(source, options) { ) } else { + const metadataArg = useMetadata ? metadata : '' + // Add a simple TOC entry. - tocMarkdown.push( - '* ' + makeAnchor('#' + entry.getHash(style), '`' + title + '`') - ) + const hash = entry.getHash(style) + const anchor = makeAnchor('#' + hash, '`' + title + '`', metadataArg) + const tocEntry = '* ' + anchor + tocMarkdown.push(tocEntry) } }) diff --git a/_modules/_docdown/lib/md.js b/_modules/_docdown/lib/md.js index b39034f..1d5eb47 100644 --- a/_modules/_docdown/lib/md.js +++ b/_modules/_docdown/lib/md.js @@ -6,10 +6,31 @@ const _ = require('lodash') * @private * @param {string} href The anchor href. * @param {string} text The anchor text. + * @param {Object} [metadata] additional data for attriubutes * @returns {string} Returns the anchor HTML. */ -function makeAnchor(href, text) { - return '' + _.toString(text) + '' +function makeAnchor(href, text, metadata = '') { + if (typeof metadata === 'object') { + let attrs = '' + for (let prop in metadata) { + let value = metadata[prop] + if (typeof value === 'object') value = JSON.stringify(value) + // keep whitespaces as underscores + value = value.replace(/\s+/, '_') + // strip everything not letters/nums + // value = value.replace(/[\W_]+/g, '') + value = value.replace(/[^a-z0-9]/gmi, ' ') + // trim empty lines + // value = value.replace(/\"/gmi, `'`) + value = value.replace(/\r|\n|\t|\s+/gmi, ' ').trim() + + if (value === '') continue + attrs += ` data-${prop}="${value}" ` + } + metadata = attrs + } + + return `${_.toString(text)}` } const maker = (files, entry, entryMarkdown) => { diff --git a/_modules/frisbee/eh.js b/_modules/frisbee/eh.js new file mode 100644 index 0000000..03950b4 --- /dev/null +++ b/_modules/frisbee/eh.js @@ -0,0 +1,28 @@ +require('isomorphic-fetch') +const log = require('fliplog') +const Frisbee = require('./src/frisbee') +require('./test-setup') + +global._server.start() + +async function eh() { + const api = new Frisbee(global._options) + const querystring = { + a: 'blue', + b: 'cyan', + c: 'pink', + } + const getRes = await api.get('/querystring', { + body: querystring, + }) + + console.log(typeof getRes.body) + console.log(getRes.body) + + const delRes = await api.get('/querystring', { + body: querystring, + }) + console.log(typeof delRes.body) + console.log(delRes.body) +} +eh() diff --git a/_modules/frisbee/package.json b/_modules/frisbee/package.json new file mode 100644 index 0000000..17ed34a --- /dev/null +++ b/_modules/frisbee/package.json @@ -0,0 +1,25 @@ +{ + "name": "md-chain", + "scripts": { + "babs": "babel awesome-github.js > awesome-github-es6.js", + "build": "node js", + "test": "jest --verbose" + }, + "jest": { + "setupTestFrameworkScriptFile": "./test-setup.js" + }, + "devDependencies": { + "isomorphic-fetch": "*", + "express": "*", + "cors": "*", + "body-parser": "*", + "jest": "*" + }, + "dependencies": { + "fliplog": "^1.0.4", + "qs": "*", + "frisbee": "^1.5.0", + "node-fetch": "^1.7.1", + "xmlhttprequest": "^1.8.0" + } +} diff --git a/_modules/frisbee/src/__tests__/node.test.js b/_modules/frisbee/src/__tests__/node.test.js new file mode 100644 index 0000000..cb410eb --- /dev/null +++ b/_modules/frisbee/src/__tests__/node.test.js @@ -0,0 +1,323 @@ +require('isomorphic-fetch') +const log = require('fliplog') +const Frisbee = require('../../src/frisbee') +const { isError, isObj, isString, isNumber } = require('../chains') + +const standardMethods = ['get', 'post', 'put', 'del', 'patch'] +const methods = [].slice.call(standardMethods).concat(['head', 'options']) +const server = global._server + +// log.registerCatch() + +// describe('node runtime', () => { +let api + +// server.start() +afterEach(() => server.start()) +beforeEach(() => server.stop()) + +test('should have `fetch` defined', done => { + expect(fetch).toBeTruthy() + done() +}) + +// +test('should throw an error if we fail to pass baseURI', done => { + // expect(new Frisbee).toThrow(new Error('baseURI option is required')); + expect(() => new Frisbee()).toThrow(/baseURI option is required/) + done() +}) + +test('should create Frisbee instance with all methods', done => { + console.log(global._options) + api = new Frisbee(global._options) + expect(isObj(api)).toBe(true) + methods.forEach(method => expect(typeof api[method]).toBe('function')) + done() +}) + +test('should throw errors for incorrect auth() usage', done => { + api = new Frisbee(global._options) + expect(() => api.auth({})).toThrow(/auth option `user` must be a string/) + expect(() => api.auth(new Array(3))).toThrow( + /auth option can only have two keys/ + ) + expect(() => api.auth([{}, ''])).toThrow( + /auth option `user` must be a string/ + ) + expect(() => api.auth(['', {}])).toThrow( + /auth option `pass` must be a string/ + ) + done() +}) + +test('should accept valid auth("user:pass") usage', done => { + api = new Frisbee(global._options) + const creds = 'foo:bar' + api.auth('foo:bar') + const basicAuthHeader = `Basic ${new Buffer(creds).toString('base64')}` + expect(api.headers.Authorization).toEqual(basicAuthHeader) + done() +}) + +test('should allow chaining of `auth` and an HTTP method', async done => { + api = new Frisbee(global._options) + try { + await api.auth('foo', 'bar').get('/') + } + catch (err) { + throw err + } + done() +}) + +test('should allow removal of auth() header', done => { + api = new Frisbee(global._options) + + api.auth('foo') + // invalid auth + // expect(() => .toThrow(/user/) + api.auth() + expect(api.headers.Authorization).toBeFalsy() + done() +}) + +test( + 'should throw an error if we fail to pass a string `path`', + async done => { + api = new Frisbee(global._options) + + try { + await api.get({}) + } + catch (err) { + expect(err.message).toEqual('`path` must be a string') + } + + done() + } +) + +test('should throw an error if we fail to pass an object `options`', async done => { + api = new Frisbee(global._options) + + try { + await api.get('', []) + } + catch (err) { + expect(err.message).toEqual('`options` must be an object') + } + try { + await api.get('', 1) + } + catch (err) { + expect(err.message).toEqual('`options` must be an object') + } + done() +}) + +test('should throw an error if we pass a non object `options`', async done => { + api = new Frisbee(global._options) + try { + await api.get('', false) + } + catch (err) { + expect(err.message).toEqual('`options` must be an object') + } + done() +}) + +test('should automatically set options to an empty object if not set', async done => { + api = new Frisbee(global._options) + + try { + await api.get('') + } + catch (err) { + throw err + } + + done() +}) + +standardMethods.forEach(method => { + const methodName = method === 'del' ? 'DELETE' : method.toUpperCase() + + test(`should return 200 on ${methodName}`, async done => { + api = new Frisbee(global._options) + + const opts = {} + + if (method === 'post') opts.body = { foo: 'bar' } + + try { + const res = await api[method]('/', opts) + expect(isObj(res)).toBe(true) + expect(isObj(res.body)).toBe(true) + } + catch (err) { + throw err + } + + done() + }) +}) + +standardMethods.forEach(method => { + const methodName = method === 'del' ? 'DELETE' : method.toUpperCase() + + test(`should return 200 on ${methodName}`, async done => { + api = new Frisbee(global._options) + + const opts = {} + if (method === 'post') opts.body = { foo: 'bar' } + + try { + const res = await api[method]('/', opts) + expect(isObj(res)).toBe(true) + expect(isObj(res.body)).toBe(true) + } + catch (err) { + throw err + } + + done() + }) +}) + +test('should stringify querystring parameters for GET and DELETE requests', async done => { + api = new Frisbee(global._options) + const querystring = { + a: 'blue', + b: 'cyan', + c: 'pink', + } + const getRes = await api.get('/querystring', { + body: querystring, + }) + + expect(isObj(getRes.body)).toBe(true) + expect(getRes.body).toEqual(querystring) + + const delRes = await api.get('/querystring', { + body: querystring, + }) + expect(isObj(delRes.body)).toBe(true) + expect(delRes.body).toEqual(querystring) + + done() +}) + +test('should stringify querystring parameters with arrayFormat for GET and DELETE requests', async done => { + api = new Frisbee( + Object.assign({}, global._options, { formatArray: 'brackets' }) + ) + const querystring = { + a: 'blue', + b: 'cyan', + c: 'pink', + d: ['1', '2', '3'], + } + const getRes = await api.get('/querystring', { + body: querystring, + }) + expect(isObj(getRes.body)).toBe(true) + expect(getRes.body).toEqual(querystring) + + const delRes = await api.get('/querystring', { + body: querystring, + }) + expect(isObj(delRes.body)).toBe(true) + expect(delRes.body).toEqual(querystring) + + done() +}) + +test('should URL encode querystring parameters for GET and DELETE requests', async done => { + api = new Frisbee(global._options) + const querystring = { + a: ' ', + b: '&foo&', + c: '$$%%%%', + } + const getRes = await api.get('/querystring', { + body: querystring, + }) + expect(isObj(getRes.body)).toBe(true) + expect(getRes.body).toEqual(querystring) + + const delRes = await api.del('/querystring', { + body: querystring, + }) + expect(isObj(delRes.body)).toBe(true) + expect(delRes.body).toEqual(querystring) + + done() +}) + +test('should return 404', async done => { + api = new Frisbee(global._options) + const res = await api.get('/404') + console.log('should return 404', { res, statusText: res.statusText }) + console.log(res.statusText, 'statusText', res.statusText == 'Not Found') + // expect(isError(res.err)).toBe(true) + // expect(res.err.message).toEqual('Not Found') + expect(res.statusText).toEqual('Not Found') + done() +}) + +test('should return 404 with valid json', async done => { + api = new Frisbee(global._options) + const res = await api.get('/404-with-valid-json') + console.log('should return 404 with valid json', { res }) + + // expect(isError(res.err)).toBe(true) + // expect(res.err.message).toEqual('Bad Request') + expect(res.statusText).toEqual('Bad Request') + done() +}) + +test('should return 404 with invalid json', async done => { + api = new Frisbee(global._options) + try { + const res = await api.get('/404-with-invalid-json') + log.data(res).echo() + console.log(isError(res.err), res.err, 'isError___') + // expect(isError(res.err)).toBe(true) + expect(typeof (res.err)).toBe('object') + } + catch (e) { + log.data(e).red('e').echo() + } + // console.log('fetched, checking error message', res.err) + // invalid json response body at + // expect(res.err.message).toEqual( + // // @NOTE was Invalid JSON received from + // // + // `invalid json response body at ${global._options.baseURI}` + // ) + done() +}) + +test('should return 404 with stripe error', async done => { + api = new Frisbee(global._options) + const res = await api.get('/404-with-stripe-error') + console.log('should return 404 with stripe error', res) + // expect(isError(res.err)).toBe(true) + expect(isString(res.err.message)).toBe(true) + // expect(isString(res.err.stack)).toBe(true) + // expect(isNumber(res.err.code)).toBe(true) + // expect(isString(res.err.param)).toBe('string') + done() +}) + +test('should return 400 with message', async done => { + api = new Frisbee(global._options) + const res = await api.get('/400-with-message') + + // expect(isError(res.err)).toBe(true) + expect(res.body.message).toEqual('Oops!') + // expect(res.err.message).toEqual('Oops!') + done() +}) +// }) diff --git a/_modules/frisbee/src/chains.js b/_modules/frisbee/src/chains.js new file mode 100644 index 0000000..c116740 --- /dev/null +++ b/_modules/frisbee/src/chains.js @@ -0,0 +1,7 @@ +const Chainable = require('../../../src') +const isJSON = require('../../../src/deps/is/JSON') + +Chainable.isJSON = Chainable.is.isJSON = isJSON +Chainable.enhanceError = require('../../../src/deps/validators/error') + +module.exports = Chainable diff --git a/_modules/frisbee/src/frisbee.js b/_modules/frisbee/src/frisbee.js new file mode 100644 index 0000000..1caac02 --- /dev/null +++ b/_modules/frisbee/src/frisbee.js @@ -0,0 +1,710 @@ +// frisbee +// Copyright (c) 2015- Nick Baugh +// MIT Licensed +// * Author: [@niftylettuce](https://twitter.com/#!/niftylettuce) +// * Source: +// # frisbee + +// eslint-disable-next-line +'use strict' + +// https://davidwalsh.name/fetch + +const {Buffer} = require('buffer') +const qs = require('qs') +const { + Chain, + isFunction, + isString, + isObjPure, + isReal, + isUndefined, + isObj, + isArray, + isNull, + isNill, + isJSON, + merge, + encase, + enhanceError, +} = require('./chains') + +const fetch = typeof window === 'object' ? window.fetch : global.fetch +const mergeOpts = {clone: true} + +/* @TODO should wildcard fliplog in with logchain internal debugging for debug levels in dev build system thing */ +function isJSONSafe(json, debug = false) { + let valid = json + try { + valid = JSON.parse(json) + return valid + } + catch (e) { + if (debug === true) { + console.log('JSON is not JSON', e) + } + return false + } +} + +// base URI for everything +global._options = { + baseURI: 'http://localhost:8080', + headers: { + 'Accept': 'application/json', + 'Content-Type': 'application/json', + }, +} + +// scope the old function to the new one like .has .get since they are common +// have a requireable fn +// +// @IMPORTANT TO UPGRADE THE EXPORTING SO EVERYTHING IS FLAT +// NEEDS SOLID CHAIN-ABLE-FS +function renameMethod(originalMethodName, newMethodName) { + this[newMethodName] = this[originalMethodName] +} + +const validations = [ + // 0 fatal.fetch + 'A global `fetch` method is required as either `window.fetch` ' + + 'for browsers or `global.fetch` for node runtime environments. ' + + 'Please add `require(\'isomorphic-fetch\')` before importing `frisbee`. ' + + 'You may optionally `require(\'es6-promise\').polyfill()` before you ' + + 'require `isomorphic-fetch` if you want to support older browsers.' + + '\n\nFor more info: https://github.com/niftylettuce/frisbee#usage', + // 1 validate.fatal.baseuri* + 'baseURI option is required', + // 2 validate.path.string + '`path` must be a string', + // 3 validate.opts.obj + '`options` must be an object', + // 4 validate.auth.keys + 'auth option can only have two keys `[user, pass]`', + // 5 validate.auth.user.string + 'auth option `user` must be a string', + // 6 validate.auth.pass.string + 'auth option `pass` must be a string', + // 7 validate.auth.jwt.string + 'jwt token must be a string', + `Invalid JSON received from`, +] + +// @TODO could also just put strings here but then they are allocated each time +// using `_` instead of dot for easier selection +// could also assign to variables but array isn't so bad for order and the eyes and ease +// smaller this way, but changes stack... +const errMsg = msg => { + if (msg === 'req_fetch') return validations[0] + else if (msg === 'req_base') return validations[1] + else if (msg === 'str_path') return validations[2] + else if (msg === 'obj_opts') return validations[3] + else if (msg === 'auth_keys') return validations[4] + else if (msg === 'str_user') return validations[5] + else if (msg === 'str_pass') return validations[6] + else if (msg === 'str_jwt') return validations[7] + else if (msg === 'json') return validations[8] +} +const throwWithMsg = msg => { + throw new Error(errMsg(msg)) +} + +if (!fetch) throwWithMsg('req_fetch') + +const methods = ['get', 'head', 'post', 'put', 'del', 'options', 'patch'] + +const respProperties = { + readOnly: [ + 'headers', + 'ok', + 'redirected', + 'status', + 'statusText', + 'type', + 'url', + 'bodyUsed', + ], + writable: ['useFinalURL'], + callable: [ + 'clone', + 'error', + 'redirect', + 'arrayBuffer', + 'blob', + 'formData', + 'json', + 'text', + ], +} + +const getContentType = headers => { + if (isNill(headers)) { + return null + } + else if (isFunction(headers.get)) { + return headers.get('Content-Type') || headers.get('content-type') + } + else if (isObj(headers)) { + return headers['Content-Type'] || headers['content-type'] + } +} + +// @TODO could copy in the typed version to generate comments to generate docs too +// and allows backwards parsing thinking for creating typedefs +// +// clone() - Creates a clone of a Response object. +// error() - Returns a new Response object associated with a network error. +// redirect() - Creates a new response with a different URL. +// arrayBuffer() - Returns a promise that resolves with an ArrayBuffer. +// blob() - Returns a promise that resolves with a Blob. +// formData() - Returns a promise that resolves with a FormData object. +// json() - Returns a promise that resolves with a JSON object. +// text() + +// determine whether we're returning text or json for body +// or attempt to parse json body to use as error message +async function parseFrisbeeResponseBody(res, contentTypeJSON) { + // for (var originalProp in res.originalResponse) { + // // if (!isUndefined(res[originalProp])) { + // const has = originalProp in res + // if (has) continue + // Object.defineProperty(res, originalProp, Object.getOwnPropertyDescriptor(res.originalResponse, originalProp) || {}) + // // } + // } + try { + if (contentTypeJSON) { + // console.log('is contentTypeJSON') + if (isFunction(res.json)) { + // console.log('is json on response') + try { + // @TODO encase() + res.body = await res.json() + } + catch (e) { + // console.log('errored parsing json on response', e) + // return e + res.err = e + res.originalResponse.statusText = e ? e.message : e + + // res.originalResponse.err = e + // res.statusText = e.message + // console.log({res}) + } + // console.log('parsed json on response, done') + } + else { + // console.log('is isFoshoJSON - calling text') + + res.body = await res.text() + // console.log('is isFoshoJSON -pre') + const isFoshoJSON = isJSONSafe(res.body) + // console.log('is isFoshoJSON - pre parse') + + // @TODO another fn here could do + // @NOTE good thing to test solidly + if (isJSON(res.body)) { + res.body = encase(JSON.parse(res.body)).onInvalid((error) => res.err = error) + // console.log('error?') + } + else { + // console.log('handling it, on own') + res.err = this.handleError('json') + } + } + return res + } + else { + // console.log('LAST ELSE') + res.body = await res.text() + } + } + catch (e) { + res.err = e + // console.log('ERROR PARSING', e) + } + + // console.log('parsed response') + return res +} + +/** + * @TODO needs more features that make axios viable + * easy middleware for local storage & jwt retry que + */ + +/* prettier-ignore */ +function formatFrisbeeResponseError(res, contentTypeJSON, baseURI) { + // res.err = new Error(res.statusText) + const FrisbeeResponse = res + // new Response(res) + + // type - basic, cors + // url + // useFinalURL - Boolean for if url is the final URL + // status - status code (ex: 200, 404, etc.) + // ok - Boolean for successful response (status in the range 200-299) + // statusText - status code (ex: OK) + // headers + + + // check if the response was JSON, and if so, better the error + if (contentTypeJSON) { + // @TODO Glazed? + // attempt to use Glazed error messages + if (isObj(FrisbeeResponse.body) && isString(FrisbeeResponse.body.message)) { + // @TODO these are the same...? + // FrisbeeResponse.err = new Error(FrisbeeResponse.body.message) + FrisbeeResponse.err = FrisbeeResponse.body + } + // attempt to utilize Stripe-inspired error messages + if (!(isArray(FrisbeeResponse.body) && isObj(FrisbeeResponse.body.error))) { + // was here + res.err = FrisbeeResponse.body.error + } + // if (isObj(res.err)) { + // if (res.err.message) res.err = new Error(res.err.message) + // if (res.err.stack) res.err.stack = (res.err.stack) + // if (res.err.code) res.err.code = (res.err.code) + // if (res.err.param) res.err.param = (res.err.param) + // } + } + return FrisbeeResponse +} + +// enhanceError + +function createFrisbeeResponse(origResp) { + const resp = { + originalResponse: origResp, + } + + // curry + // const define = (prop, value) => Object.defineProperty(resp, prop, value) + + // console.log('creating frisbee response', {resp}) + + respProperties.readOnly.forEach(prop => + Object.defineProperty(resp, prop, { + value: origResp[prop], + }) + //&& console.log({ prop }) + ) + + respProperties.writable.forEach(prop => + Object.defineProperty(resp, prop, { + get() { + return origResp[prop] + }, + set(value) { + origResp[prop] = value + }, + }) + //&& console.log({ prop }) + ) + + let callable = null + respProperties.callable.forEach(prop => { + Object.defineProperty(resp, prop, { + // enumerable: true, + value: ( + (callable = origResp[prop]), + isFunction(callable) && callable.bind(origResp) + ), + }) + // && console.log({ prop }) + }) + + // easy vanilla access headers + const headersObj = {} + origResp.headers.forEach(pair => { + headersObj[pair[0]] = pair[1] + }) + Object.defineProperty(resp, 'headersObj', { + value: headersObj, + }) + + // const descriptors = obj => { + // const descs = [] + // for (let prop in obj) { + // descs.push({ [prop]: Object.getOwnPropertyDescriptor(obj, prop) }) + // } + // return descs + // } + + // .body + // descriptors(resp.originalResponse).forEach(desc => { + // const prop = Object.keys(desc)[0] + // if (resp[prop]) return + // Object.defineProperty(resp, prop, desc[prop]) + // console.log({ prop }) + // }) + + // console.log('created frisbee response') + // console.log(descriptors(resp.originalResponse)) + + return resp +} + +function copySetToMethodPlugin(name, parent) { + const copySetOntoMethod = arg => { + if (isUndefined(arg)) { + parent.get(name) + } + else { + parent.set(name, arg) + Object.assign(parent[name], arg) + } + return parent + } + + // so we know if we defaulted them + copySetOntoMethod.copySetOntoMethod = true + + return this.onSet(copySetOntoMethod) + .onGet(copySetOntoMethod) + .onCall(copySetOntoMethod) +} + +const makeBody = () => { + +} +const makeRequest = (url, opts) => { + const requestConfig = { + method: 'POST', + mode: 'cors', + redirect: 'follow', + headers: new Headers({ + 'Content-Type': 'text/plain', + }), + } + Object.assign(requestConfig, opts) + + return new Request(url, requestConfig) +} + + +/** + * @TODO formData (use util) + */ +// const blob = () => { +// fetch('https://davidwalsh.name/submit', { +// method: 'post', +// body: new FormData(document.getElementById('comment-form')) +// }); +// +// .then(function(response) { +// return response.blob(); +// }) +// .then(function(imageBlob) { +// document.querySelector('img').src = URL.createObjectURL(imageBlob); +// }); +// } + +// easy destructure err +const fetchIt = async(url, opts) => { + let error = null + try { + const request = makeRequest(url, opts) + // console.log({request}) + // url, opts + const result = await fetch(request) + // console.log(result) + return [error, result] + } + catch (e) { + return [e, null] + } +} + +/* prettier-ignore */ +class Frisbee extends Chain { + constructor(opts = {}) { + //('frisbee' + super() + + // because conflicting names + this._get = this.get.bind(this) + + // @default + // wish you could make better stack traces once thrown? extend error?? + this.onError(function defaultErrorThrower(error) { + console.log('throwing...', {error}) + throw error + }) + + // try { + // this.method('_setup').encase().onInvalid((error) => { + // require('fliplog').quick(error) + // }).build() + // } + // catch (e) { + // console.log('ugh', e) + // } + + + this + .method('headers') + .plugin(copySetToMethodPlugin) + .build() + .extend(['arrayFormat']) + // .autoGetSet() + // .getSet() + // .build() + + .auth(opts.auth) + .opts(opts) + .headers(opts.headers) + .arrayFormat(opts.arrayFormat || 'indices') + // .when(opts.auth, () => this.auth(opts.auth)) + + methods.forEach(method => { + this[method] = this._setup(method) + }) + + // already bound + // this.httpGet = this._get + // this._get = (arg1, arg2) => { + // if (isUndefined(arg2)) + // } + } + opts(opts) { + // validate + if (!opts.baseURI) this.handleError('req_base') + this.set('opts', opts) + return this + } + + // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error#Custom_Error_Types + // can have arrays of handlers, middleware, this is baby steps + onError(handler) { + // console.log('onerror') + return this.set('onError', handler) + } + handleError(msg, data) { + const messageForIndex = isString(msg) ? errMsg(msg) : msg + // console.log('handleerror') + const errorPlus = new Error(messageForIndex) + errorPlus.data = data + + // isError [object Object] FetchError { + // name: 'FetchError', + // message: 'invalid json response body at http://localhost:8080/404-with-invalid-json reason: Unexpected token o in JSON at position 1', + // type: 'invalid-json' + + // console.log(error.message, error.stack) + // throw error + + + // try { + // const errorPlus = new Error(messageForIndex) + // newest at top, remove this line + // errorPlus.stack = errorPlus.stack.split('\n') + // errorPlus.stack.shift() + // errorPlus.stack = errorPlus.stack.join('\n') + // throw errorPlus + const onerr = this._get('onError') + // console.log({onerr}) + // console.log(this.store) + onerr(errorPlus) + // } + // // when onerr throws an error + // catch (errorError) { + // console.log(errorError.message) + // console.log(errorError.stack) + // throw errorError + // } + // this._get('onError').call(this, error, this) + return errorPlus + } + + /** + * @methodFactory + * @method + * @memberOf frisbee + * @protected + * @param {string} method enum + * @return {Frisbee} @chainable + */ + _setup(methodKeyword) { + return (path = '/', options = {}) => { + // validate --- + + // path must be string + if (!isString(path)) return this.handleError('str_path') + + // otherwise check if its an object + if (!isObjPure(options)) return this.handleError('obj_opts', options) + + // console.log('about to get', this) + // require('fliplog').quick(this) + + // setup data --- + const {baseURI} = this._get('opts') + + // swappable/placeholder var to use existing them update with merged + let headers = this._get('headers') + + // console.log({baseURI, headers}, this) + + // --- here down is not tied to any instance --- + + // don't want to override param, + // and it's easier to read as a descriptive variable + // @NOTE would be a good transform + const method = + methodKeyword === 'del' ? 'DELETE' : methodKeyword.toUpperCase() + + // merge headers when we have them + if (isObj(options) && options.headers) { + headers = merge(headers, options.headers, mergeOpts) + } + const opts = merge(options, {headers, method}, mergeOpts) + + // remove any nil or blank headers + // (e.g. to automatically set Content-Type with `FormData` boundary) + Object.keys(opts.headers).forEach(key => { + if (!isReal(opts.headers[key])) delete opts.headers[key] + }) + + + /** + * in order to support Android POST requests + * we must allow an empty body to be sent + * @see https://github.com/facebook/react-native/issues/4890 + */ + if (isUndefined(opts.body)) { + if (opts.method === 'POST') { + opts.body = '' + } + } + else if (isObj(opts.body)) { + if (opts.method === 'GET' || opts.method === 'DELETE') { + let qsOpts = null + if (this.has('arrayFormat')) { + qsOpts = {arrayFormat: this._get('arrayFormat')} + } + + console.log('QS', qs.stringify(opts.body)) + + path += `?${qs.stringify(opts.body, qsOpts)}` + delete opts.body + } + // @TODO: better stringify here + else { + /* + * @NOTE using caseless means checking + * permutations of casings + * encouraging bad practice + * and doing a massive amount of loops + * when it just simply isn't in the headers + */ + const reqContentType = opts.headers ? getContentType(opts.headers) : false + + if (reqContentType && reqContentType.split(';')[0] === 'application/json') { + try { + opts.body = JSON.stringify(opts.body) + } + catch (err) { + this.handleError(err) + } + } + } + } + + // @TODO does this part here ever throw to wrap try catch? + const dofetch = async() => { + // console.log('do fetch', {path, opts}) + + const [error, ogRes] = await fetchIt(baseURI + path, opts) + + // console.log('do fetch - PASS') + + // simple error + if (!isNill(error)) { + // @TODO @DEV + // console.log('has error', {error}) + return this.handleError(error) + // return Promise.reject(error) + } + + let res = createFrisbeeResponse(ogRes) + const contentType = res.headers.get('Content-Type') + const contentTypeJSON = + isString(contentType) && + contentType.includes('application/json') + + // console.log('enhanced contentType') + const encasedParse = encase(parseFrisbeeResponseBody) + res = await encasedParse(res, contentTypeJSON) + + // console.log('parsed response body') + + if (!res.ok) res = formatFrisbeeResponseError(res, contentTypeJSON, baseURI) + + // console.log('formatted') + + return Promise.resolve(res) + } + + return dofetch() + } + } + + /** + * @TODO have option to allow .setEh .getEh & access as normal properties so never `eh()` + */ + delAuth() { + // @TODO this is kind of weird + delete this.headers.Authorization + return this.delete('headers.Authorization') + } + setAuth(Authorization) { + this.headers.Authorization = Authorization + return this.set('headers.Authorization', Authorization) + } + + auth(creditStringOrArray) { + let creds = creditStringOrArray + console.log({creditStringOrArray}) + // if it has :, split into array + if (isString(creds)) { + const index = creds.indexOf(':') + if (index !== -1) { + // aka creds.split(':') + creds = [creds.substr(0, index), creds.substr(index + 1)] + } + } + + // @TODO argumentor undefined, else array + // @TODO this is no good... + if (!isArray(creds)) creds = [].slice.call(arguments) + + // essentially padd out our credentials with empty + if (creds.length === 0) creds = ['', ''] + else if (creds.length === 1) creds.push('') + else if (creds.length !== 2) this.handleError('auth_keys') + creds = creds.map(cred => (isReal(cred) ? cred : '')) + + // console.log({creds}) + + // @TODO can do 1 step further with validation as in split plugin + if (!isString(creds[0])) this.handleError('str_user') + if (!isString(creds[1])) this.handleError('str_pass') + + if (!creds[0] && !creds[1]) this.delAuth() + else this.setAuth(`Basic ${new Buffer(creds.join(':')).toString('base64')}`) + + return this + } + + jwt(token) { + if (isNull(token)) return this.delAuth() + else if (isString(token)) return this.setAuth(`Bearer ${token}`) + else return this.handleError('str_jwt') + } +} + +module.exports = function Frisbees(opts) { + // console.log({opts}) + return new Frisbee(opts) +} diff --git a/_modules/frisbee/src/index.js b/_modules/frisbee/src/index.js new file mode 100644 index 0000000..8cf0a5d --- /dev/null +++ b/_modules/frisbee/src/index.js @@ -0,0 +1 @@ +module.exports = require('./frisbee') diff --git a/_modules/frisbee/test-setup.js b/_modules/frisbee/test-setup.js new file mode 100644 index 0000000..147f6b1 --- /dev/null +++ b/_modules/frisbee/test-setup.js @@ -0,0 +1,103 @@ +const log = require('fliplog') +const express = require('express') +const cors = require('cors') +const bodyParser = require('body-parser') + +const app = express() +const extended = {extended: false} + +// log.registerCatch() +app.use(cors()) + +// parse application/x-www-form-urlencoded +app.use(bodyParser.urlencoded(extended)) + +// parse application/json +app.use(bodyParser.json(extended)) + +app.all('/', (req, res, next) => { + /* + // HEAD request body must be 0 in length + if (req.method === 'HEAD' || req.method === 'OPTIONS') { + res.send(200, ''); + return; + } + */ + + res.json({ + message: 'OK', + }) +}) + +app.get('/400-with-message', (req, res, next) => { + res.status(400).json({message: 'Oops!'}) +}) + +app.get('/querystring', (req, res, next) => { + res.json(req.query) +}) + +app.delete('/querystring', (req, res, next) => { + res.json(req.query) +}) + +app.get('/404', (req, res, next) => { + // console.log('404...', {req, res, next}) + // throw new Error('404') + res.sendStatus(404) +}) + +app.get('/404-with-valid-json', (req, res, next) => { + res.set('Content-Type', 'application/json').status(400).send({foo: 'baz'}) +}) + +app.get('/404-with-invalid-json', (req, res, next) => { + console.log('404') + res.set('Content-Type', 'application/json').status(404).send('foobaz') +}) + +app.get('/404-with-stripe-error', (req, res, next) => { + res.status(404).json({ + error: { + message: 'Some error happened', + stack: {}, + code: 23, + param: 'hello_world', + }, + }) +}) + +global.app = {} +global._server = { + start() { + global.app = app.listen(8080) + }, + stop() { + return global.app.close() + }, +} + +// base URI for everything +global._options = { + baseURI: 'http://localhost:8080', + headers: { + 'Accept': 'application/json', + 'Content-Type': 'application/json', + }, +} + +// setup global chai methods +// import chai from 'chai'; +// import dirtyChai from 'dirty-chai'; +// chai.config.includeStack = true; +// chai.config.showDiff = true; +// // chai.use(dirtyChai); +// global.chai = chai; +// global.AssertionError = chai.AssertionError; +// global.Assertion = chai.Assertion; +// global.expect = chai.expect; +// global.assert = chai.assert; + +// setTimeout(() => { +// global._server.close +// }, 10000) diff --git a/_modules/frisbee/yarn.lock b/_modules/frisbee/yarn.lock new file mode 100644 index 0000000..477d231 --- /dev/null +++ b/_modules/frisbee/yarn.lock @@ -0,0 +1,2342 @@ +# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. +# yarn lockfile v1 + + +abab@^1.0.3: + version "1.0.3" + resolved "https://registry.yarnpkg.com/abab/-/abab-1.0.3.tgz#b81de5f7274ec4e756d797cd834f303642724e5d" + +accepts@~1.3.3: + version "1.3.3" + resolved "https://registry.yarnpkg.com/accepts/-/accepts-1.3.3.tgz#c3ca7434938648c3e0d9c1e328dd68b622c284ca" + dependencies: + mime-types "~2.1.11" + negotiator "0.6.1" + +acorn-globals@^3.1.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/acorn-globals/-/acorn-globals-3.1.0.tgz#fd8270f71fbb4996b004fa880ee5d46573a731bf" + dependencies: + acorn "^4.0.4" + +acorn@^4.0.4: + version "4.0.13" + resolved "https://registry.yarnpkg.com/acorn/-/acorn-4.0.13.tgz#105495ae5361d697bd195c825192e1ad7f253787" + +ajv@^4.9.1: + version "4.11.8" + resolved "https://registry.yarnpkg.com/ajv/-/ajv-4.11.8.tgz#82ffb02b29e662ae53bdc20af15947706739c536" + dependencies: + co "^4.6.0" + json-stable-stringify "^1.0.1" + +align-text@^0.1.1, align-text@^0.1.3: + version "0.1.4" + resolved "https://registry.yarnpkg.com/align-text/-/align-text-0.1.4.tgz#0cd90a561093f35d0a99256c22b7069433fad117" + dependencies: + kind-of "^3.0.2" + longest "^1.0.1" + repeat-string "^1.5.2" + +amdefine@>=0.0.4: + version "1.0.1" + resolved "https://registry.yarnpkg.com/amdefine/-/amdefine-1.0.1.tgz#4a5282ac164729e93619bcfd3ad151f817ce91f5" + +ansi-escapes@^1.4.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/ansi-escapes/-/ansi-escapes-1.4.0.tgz#d3a8a83b319aa67793662b13e761c7911422306e" + +ansi-regex@^2.0.0, ansi-regex@^2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-2.1.1.tgz#c3b33ab5ee360d86e0e628f0468ae7ef27d654df" + +ansi-styles@^2.2.1: + version "2.2.1" + resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-2.2.1.tgz#b432dd3358b634cf75e1e4664368240533c1ddbe" + +ansi-styles@^3.0.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-3.1.0.tgz#09c202d5c917ec23188caa5c9cb9179cd9547750" + dependencies: + color-convert "^1.0.0" + +anymatch@^1.3.0: + version "1.3.0" + resolved "https://registry.yarnpkg.com/anymatch/-/anymatch-1.3.0.tgz#a3e52fa39168c825ff57b0248126ce5a8ff95507" + dependencies: + arrify "^1.0.0" + micromatch "^2.1.5" + +append-transform@^0.4.0: + version "0.4.0" + resolved "https://registry.yarnpkg.com/append-transform/-/append-transform-0.4.0.tgz#d76ebf8ca94d276e247a36bad44a4b74ab611991" + dependencies: + default-require-extensions "^1.0.0" + +argparse@^1.0.7: + version "1.0.9" + resolved "https://registry.yarnpkg.com/argparse/-/argparse-1.0.9.tgz#73d83bc263f86e97f8cc4f6bae1b0e90a7d22c86" + dependencies: + sprintf-js "~1.0.2" + +arr-diff@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/arr-diff/-/arr-diff-2.0.0.tgz#8f3b827f955a8bd669697e4a4256ac3ceae356cf" + dependencies: + arr-flatten "^1.0.1" + +arr-flatten@^1.0.1: + version "1.1.0" + resolved "https://registry.yarnpkg.com/arr-flatten/-/arr-flatten-1.1.0.tgz#36048bbff4e7b47e136644316c99669ea5ae91f1" + +array-equal@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/array-equal/-/array-equal-1.0.0.tgz#8c2a5ef2472fd9ea742b04c77a75093ba2757c93" + +array-flatten@1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/array-flatten/-/array-flatten-1.1.1.tgz#9a5f699051b1e7073328f2a008968b64ea2955d2" + +array-unique@^0.2.1: + version "0.2.1" + resolved "https://registry.yarnpkg.com/array-unique/-/array-unique-0.2.1.tgz#a1d97ccafcbc2625cc70fadceb36a50c58b01a53" + +arrify@^1.0.0, arrify@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/arrify/-/arrify-1.0.1.tgz#898508da2226f380df904728456849c1501a4b0d" + +asn1@~0.2.3: + version "0.2.3" + resolved "https://registry.yarnpkg.com/asn1/-/asn1-0.2.3.tgz#dac8787713c9966849fc8180777ebe9c1ddf3b86" + +assert-plus@1.0.0, assert-plus@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/assert-plus/-/assert-plus-1.0.0.tgz#f12e0f3c5d77b0b1cdd9146942e4e96c1e4dd525" + +assert-plus@^0.2.0: + version "0.2.0" + resolved "https://registry.yarnpkg.com/assert-plus/-/assert-plus-0.2.0.tgz#d74e1b87e7affc0db8aadb7021f3fe48101ab234" + +async@^1.4.0: + version "1.5.2" + resolved "https://registry.yarnpkg.com/async/-/async-1.5.2.tgz#ec6a61ae56480c0c3cb241c95618e20892f9672a" + +async@^2.1.4: + version "2.5.0" + resolved "https://registry.yarnpkg.com/async/-/async-2.5.0.tgz#843190fd6b7357a0b9e1c956edddd5ec8462b54d" + dependencies: + lodash "^4.14.0" + +asynckit@^0.4.0: + version "0.4.0" + resolved "https://registry.yarnpkg.com/asynckit/-/asynckit-0.4.0.tgz#c79ed97f7f34cb8f2ba1bc9790bcc366474b4b79" + +aws-sign2@~0.6.0: + version "0.6.0" + resolved "https://registry.yarnpkg.com/aws-sign2/-/aws-sign2-0.6.0.tgz#14342dd38dbcc94d0e5b87d763cd63612c0e794f" + +aws4@^1.2.1: + version "1.6.0" + resolved "https://registry.yarnpkg.com/aws4/-/aws4-1.6.0.tgz#83ef5ca860b2b32e4a0deedee8c771b9db57471e" + +babel-code-frame@^6.22.0: + version "6.22.0" + resolved "https://registry.yarnpkg.com/babel-code-frame/-/babel-code-frame-6.22.0.tgz#027620bee567a88c32561574e7fd0801d33118e4" + dependencies: + chalk "^1.1.0" + esutils "^2.0.2" + js-tokens "^3.0.0" + +babel-core@^6.0.0, babel-core@^6.24.1: + version "6.25.0" + resolved "https://registry.yarnpkg.com/babel-core/-/babel-core-6.25.0.tgz#7dd42b0463c742e9d5296deb3ec67a9322dad729" + dependencies: + babel-code-frame "^6.22.0" + babel-generator "^6.25.0" + babel-helpers "^6.24.1" + babel-messages "^6.23.0" + babel-register "^6.24.1" + babel-runtime "^6.22.0" + babel-template "^6.25.0" + babel-traverse "^6.25.0" + babel-types "^6.25.0" + babylon "^6.17.2" + convert-source-map "^1.1.0" + debug "^2.1.1" + json5 "^0.5.0" + lodash "^4.2.0" + minimatch "^3.0.2" + path-is-absolute "^1.0.0" + private "^0.1.6" + slash "^1.0.0" + source-map "^0.5.0" + +babel-generator@^6.18.0, babel-generator@^6.25.0: + version "6.25.0" + resolved "https://registry.yarnpkg.com/babel-generator/-/babel-generator-6.25.0.tgz#33a1af70d5f2890aeb465a4a7793c1df6a9ea9fc" + dependencies: + babel-messages "^6.23.0" + babel-runtime "^6.22.0" + babel-types "^6.25.0" + detect-indent "^4.0.0" + jsesc "^1.3.0" + lodash "^4.2.0" + source-map "^0.5.0" + trim-right "^1.0.1" + +babel-helpers@^6.24.1: + version "6.24.1" + resolved "https://registry.yarnpkg.com/babel-helpers/-/babel-helpers-6.24.1.tgz#3471de9caec388e5c850e597e58a26ddf37602b2" + dependencies: + babel-runtime "^6.22.0" + babel-template "^6.24.1" + +babel-jest@^20.0.3: + version "20.0.3" + resolved "https://registry.yarnpkg.com/babel-jest/-/babel-jest-20.0.3.tgz#e4a03b13dc10389e140fc645d09ffc4ced301671" + dependencies: + babel-core "^6.0.0" + babel-plugin-istanbul "^4.0.0" + babel-preset-jest "^20.0.3" + +babel-messages@^6.23.0: + version "6.23.0" + resolved "https://registry.yarnpkg.com/babel-messages/-/babel-messages-6.23.0.tgz#f3cdf4703858035b2a2951c6ec5edf6c62f2630e" + dependencies: + babel-runtime "^6.22.0" + +babel-plugin-istanbul@^4.0.0: + version "4.1.4" + resolved "https://registry.yarnpkg.com/babel-plugin-istanbul/-/babel-plugin-istanbul-4.1.4.tgz#18dde84bf3ce329fddf3f4103fae921456d8e587" + dependencies: + find-up "^2.1.0" + istanbul-lib-instrument "^1.7.2" + test-exclude "^4.1.1" + +babel-plugin-jest-hoist@^20.0.3: + version "20.0.3" + resolved "https://registry.yarnpkg.com/babel-plugin-jest-hoist/-/babel-plugin-jest-hoist-20.0.3.tgz#afedc853bd3f8dc3548ea671fbe69d03cc2c1767" + +babel-preset-jest@^20.0.3: + version "20.0.3" + resolved "https://registry.yarnpkg.com/babel-preset-jest/-/babel-preset-jest-20.0.3.tgz#cbacaadecb5d689ca1e1de1360ebfc66862c178a" + dependencies: + babel-plugin-jest-hoist "^20.0.3" + +babel-register@^6.24.1: + version "6.24.1" + resolved "https://registry.yarnpkg.com/babel-register/-/babel-register-6.24.1.tgz#7e10e13a2f71065bdfad5a1787ba45bca6ded75f" + dependencies: + babel-core "^6.24.1" + babel-runtime "^6.22.0" + core-js "^2.4.0" + home-or-tmp "^2.0.0" + lodash "^4.2.0" + mkdirp "^0.5.1" + source-map-support "^0.4.2" + +babel-runtime@^6.22.0, babel-runtime@^6.9.2: + version "6.23.0" + resolved "https://registry.yarnpkg.com/babel-runtime/-/babel-runtime-6.23.0.tgz#0a9489f144de70efb3ce4300accdb329e2fc543b" + dependencies: + core-js "^2.4.0" + regenerator-runtime "^0.10.0" + +babel-template@^6.16.0, babel-template@^6.24.1, babel-template@^6.25.0: + version "6.25.0" + resolved "https://registry.yarnpkg.com/babel-template/-/babel-template-6.25.0.tgz#665241166b7c2aa4c619d71e192969552b10c071" + dependencies: + babel-runtime "^6.22.0" + babel-traverse "^6.25.0" + babel-types "^6.25.0" + babylon "^6.17.2" + lodash "^4.2.0" + +babel-traverse@^6.18.0, babel-traverse@^6.25.0: + version "6.25.0" + resolved "https://registry.yarnpkg.com/babel-traverse/-/babel-traverse-6.25.0.tgz#2257497e2fcd19b89edc13c4c91381f9512496f1" + dependencies: + babel-code-frame "^6.22.0" + babel-messages "^6.23.0" + babel-runtime "^6.22.0" + babel-types "^6.25.0" + babylon "^6.17.2" + debug "^2.2.0" + globals "^9.0.0" + invariant "^2.2.0" + lodash "^4.2.0" + +babel-types@^6.18.0, babel-types@^6.25.0: + version "6.25.0" + resolved "https://registry.yarnpkg.com/babel-types/-/babel-types-6.25.0.tgz#70afb248d5660e5d18f811d91c8303b54134a18e" + dependencies: + babel-runtime "^6.22.0" + esutils "^2.0.2" + lodash "^4.2.0" + to-fast-properties "^1.0.1" + +babylon@^6.17.2, babylon@^6.17.4: + version "6.17.4" + resolved "https://registry.yarnpkg.com/babylon/-/babylon-6.17.4.tgz#3e8b7402b88d22c3423e137a1577883b15ff869a" + +balanced-match@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.0.tgz#89b4d199ab2bee49de164ea02b89ce462d71b767" + +base64-js@^1.0.2: + version "1.2.1" + resolved "https://registry.yarnpkg.com/base64-js/-/base64-js-1.2.1.tgz#a91947da1f4a516ea38e5b4ec0ec3773675e0886" + +bcrypt-pbkdf@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/bcrypt-pbkdf/-/bcrypt-pbkdf-1.0.1.tgz#63bc5dcb61331b92bc05fd528953c33462a06f8d" + dependencies: + tweetnacl "^0.14.3" + +body-parser@*: + version "1.17.2" + resolved "https://registry.yarnpkg.com/body-parser/-/body-parser-1.17.2.tgz#f8892abc8f9e627d42aedafbca66bf5ab99104ee" + dependencies: + bytes "2.4.0" + content-type "~1.0.2" + debug "2.6.7" + depd "~1.1.0" + http-errors "~1.6.1" + iconv-lite "0.4.15" + on-finished "~2.3.0" + qs "6.4.0" + raw-body "~2.2.0" + type-is "~1.6.15" + +boom@2.x.x: + version "2.10.1" + resolved "https://registry.yarnpkg.com/boom/-/boom-2.10.1.tgz#39c8918ceff5799f83f9492a848f625add0c766f" + dependencies: + hoek "2.x.x" + +brace-expansion@^1.1.7: + version "1.1.8" + resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-1.1.8.tgz#c07b211c7c952ec1f8efd51a77ef0d1d3990a292" + dependencies: + balanced-match "^1.0.0" + concat-map "0.0.1" + +braces@^1.8.2: + version "1.8.5" + resolved "https://registry.yarnpkg.com/braces/-/braces-1.8.5.tgz#ba77962e12dff969d6b76711e914b737857bf6a7" + dependencies: + expand-range "^1.8.1" + preserve "^0.2.0" + repeat-element "^1.1.2" + +browser-resolve@^1.11.2: + version "1.11.2" + resolved "https://registry.yarnpkg.com/browser-resolve/-/browser-resolve-1.11.2.tgz#8ff09b0a2c421718a1051c260b32e48f442938ce" + dependencies: + resolve "1.1.7" + +bser@1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/bser/-/bser-1.0.2.tgz#381116970b2a6deea5646dd15dd7278444b56169" + dependencies: + node-int64 "^0.4.0" + +bser@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/bser/-/bser-2.0.0.tgz#9ac78d3ed5d915804fd87acb158bc797147a1719" + dependencies: + node-int64 "^0.4.0" + +buffer@^4.6.0: + version "4.9.1" + resolved "https://registry.yarnpkg.com/buffer/-/buffer-4.9.1.tgz#6d1bb601b07a4efced97094132093027c95bc298" + dependencies: + base64-js "^1.0.2" + ieee754 "^1.1.4" + isarray "^1.0.0" + +builtin-modules@^1.0.0: + version "1.1.1" + resolved "https://registry.yarnpkg.com/builtin-modules/-/builtin-modules-1.1.1.tgz#270f076c5a72c02f5b65a47df94c5fe3a278892f" + +bytes@2.4.0: + version "2.4.0" + resolved "https://registry.yarnpkg.com/bytes/-/bytes-2.4.0.tgz#7d97196f9d5baf7f6935e25985549edd2a6c2339" + +callsites@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/callsites/-/callsites-2.0.0.tgz#06eb84f00eea413da86affefacbffb36093b3c50" + +camelcase@^1.0.2: + version "1.2.1" + resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-1.2.1.tgz#9bb5304d2e0b56698b2c758b08a3eaa9daa58a39" + +camelcase@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-3.0.0.tgz#32fc4b9fcdaf845fcdf7e73bb97cac2261f0ab0a" + +caseless@^0.11.0: + version "0.11.0" + resolved "https://registry.yarnpkg.com/caseless/-/caseless-0.11.0.tgz#715b96ea9841593cc33067923f5ec60ebda4f7d7" + +caseless@~0.12.0: + version "0.12.0" + resolved "https://registry.yarnpkg.com/caseless/-/caseless-0.12.0.tgz#1b681c21ff84033c826543090689420d187151dc" + +center-align@^0.1.1: + version "0.1.3" + resolved "https://registry.yarnpkg.com/center-align/-/center-align-0.1.3.tgz#aa0d32629b6ee972200411cbd4461c907bc2b7ad" + dependencies: + align-text "^0.1.3" + lazy-cache "^1.0.3" + +chain-able@3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/chain-able/-/chain-able-3.0.0.tgz#dcffe8b04f3da210941a23843bc1332bb288ca9f" + +chalk@^1.1.0, chalk@^1.1.3: + version "1.1.3" + resolved "https://registry.yarnpkg.com/chalk/-/chalk-1.1.3.tgz#a8115c55e4a702fe4d150abd3872822a7e09fc98" + dependencies: + ansi-styles "^2.2.1" + escape-string-regexp "^1.0.2" + has-ansi "^2.0.0" + strip-ansi "^3.0.0" + supports-color "^2.0.0" + +ci-info@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/ci-info/-/ci-info-1.0.0.tgz#dc5285f2b4e251821683681c381c3388f46ec534" + +cliui@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/cliui/-/cliui-2.1.0.tgz#4b475760ff80264c762c3a1719032e91c7fea0d1" + dependencies: + center-align "^0.1.1" + right-align "^0.1.1" + wordwrap "0.0.2" + +cliui@^3.2.0: + version "3.2.0" + resolved "https://registry.yarnpkg.com/cliui/-/cliui-3.2.0.tgz#120601537a916d29940f934da3b48d585a39213d" + dependencies: + string-width "^1.0.1" + strip-ansi "^3.0.1" + wrap-ansi "^2.0.0" + +co@^4.6.0: + version "4.6.0" + resolved "https://registry.yarnpkg.com/co/-/co-4.6.0.tgz#6ea6bdf3d853ae54ccb8e47bfa0bf3f9031fb184" + +code-point-at@^1.0.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/code-point-at/-/code-point-at-1.1.0.tgz#0d070b4d043a5bea33a2f1a40e2edb3d9a4ccf77" + +color-convert@^1.0.0: + version "1.9.0" + resolved "https://registry.yarnpkg.com/color-convert/-/color-convert-1.9.0.tgz#1accf97dd739b983bf994d56fec8f95853641b7a" + dependencies: + color-name "^1.1.1" + +color-name@^1.1.1: + version "1.1.3" + resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.3.tgz#a7d0558bd89c42f795dd42328f740831ca53bc25" + +combined-stream@^1.0.5, combined-stream@~1.0.5: + version "1.0.5" + resolved "https://registry.yarnpkg.com/combined-stream/-/combined-stream-1.0.5.tgz#938370a57b4a51dea2c77c15d5c5fdf895164009" + dependencies: + delayed-stream "~1.0.0" + +concat-map@0.0.1: + version "0.0.1" + resolved "https://registry.yarnpkg.com/concat-map/-/concat-map-0.0.1.tgz#d8a96bd77fd68df7793a73036a3ba0d5405d477b" + +content-disposition@0.5.2: + version "0.5.2" + resolved "https://registry.yarnpkg.com/content-disposition/-/content-disposition-0.5.2.tgz#0cf68bb9ddf5f2be7961c3a85178cb85dba78cb4" + +content-type-parser@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/content-type-parser/-/content-type-parser-1.0.1.tgz#c3e56988c53c65127fb46d4032a3a900246fdc94" + +content-type@~1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/content-type/-/content-type-1.0.2.tgz#b7d113aee7a8dd27bd21133c4dc2529df1721eed" + +convert-source-map@^1.1.0, convert-source-map@^1.4.0: + version "1.5.0" + resolved "https://registry.yarnpkg.com/convert-source-map/-/convert-source-map-1.5.0.tgz#9acd70851c6d5dfdd93d9282e5edf94a03ff46b5" + +cookie-signature@1.0.6: + version "1.0.6" + resolved "https://registry.yarnpkg.com/cookie-signature/-/cookie-signature-1.0.6.tgz#e303a882b342cc3ee8ca513a79999734dab3ae2c" + +cookie@0.3.1: + version "0.3.1" + resolved "https://registry.yarnpkg.com/cookie/-/cookie-0.3.1.tgz#e7e0a1f9ef43b4c8ba925c5c5a96e806d16873bb" + +core-js@^2.4.0: + version "2.4.1" + resolved "https://registry.yarnpkg.com/core-js/-/core-js-2.4.1.tgz#4de911e667b0eae9124e34254b53aea6fc618d3e" + +cors@*: + version "2.8.4" + resolved "https://registry.yarnpkg.com/cors/-/cors-2.8.4.tgz#2bd381f2eb201020105cd50ea59da63090694686" + dependencies: + object-assign "^4" + vary "^1" + +cryptiles@2.x.x: + version "2.0.5" + resolved "https://registry.yarnpkg.com/cryptiles/-/cryptiles-2.0.5.tgz#3bdfecdc608147c1c67202fa291e7dca59eaa3b8" + dependencies: + boom "2.x.x" + +cssom@0.3.x, "cssom@>= 0.3.2 < 0.4.0": + version "0.3.2" + resolved "https://registry.yarnpkg.com/cssom/-/cssom-0.3.2.tgz#b8036170c79f07a90ff2f16e22284027a243848b" + +"cssstyle@>= 0.2.37 < 0.3.0": + version "0.2.37" + resolved "https://registry.yarnpkg.com/cssstyle/-/cssstyle-0.2.37.tgz#541097234cb2513c83ceed3acddc27ff27987d54" + dependencies: + cssom "0.3.x" + +dashdash@^1.12.0: + version "1.14.1" + resolved "https://registry.yarnpkg.com/dashdash/-/dashdash-1.14.1.tgz#853cfa0f7cbe2fed5de20326b8dd581035f6e2f0" + dependencies: + assert-plus "^1.0.0" + +debug@2.6.7: + version "2.6.7" + resolved "https://registry.yarnpkg.com/debug/-/debug-2.6.7.tgz#92bad1f6d05bbb6bba22cca88bcd0ec894c2861e" + dependencies: + ms "2.0.0" + +debug@^2.1.1, debug@^2.2.0, debug@^2.6.3: + version "2.6.8" + resolved "https://registry.yarnpkg.com/debug/-/debug-2.6.8.tgz#e731531ca2ede27d188222427da17821d68ff4fc" + dependencies: + ms "2.0.0" + +decamelize@^1.0.0, decamelize@^1.1.1: + version "1.2.0" + resolved "https://registry.yarnpkg.com/decamelize/-/decamelize-1.2.0.tgz#f6534d15148269b20352e7bee26f501f9a191290" + +deep-is@~0.1.3: + version "0.1.3" + resolved "https://registry.yarnpkg.com/deep-is/-/deep-is-0.1.3.tgz#b369d6fb5dbc13eecf524f91b070feedc357cf34" + +default-require-extensions@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/default-require-extensions/-/default-require-extensions-1.0.0.tgz#f37ea15d3e13ffd9b437d33e1a75b5fb97874cb8" + dependencies: + strip-bom "^2.0.0" + +delayed-stream@~1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/delayed-stream/-/delayed-stream-1.0.0.tgz#df3ae199acadfb7d440aaae0b29e2272b24ec619" + +depd@1.1.0, depd@~1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/depd/-/depd-1.1.0.tgz#e1bd82c6aab6ced965b97b88b17ed3e528ca18c3" + +destroy@~1.0.4: + version "1.0.4" + resolved "https://registry.yarnpkg.com/destroy/-/destroy-1.0.4.tgz#978857442c44749e4206613e37946205826abd80" + +detect-indent@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/detect-indent/-/detect-indent-4.0.0.tgz#f76d064352cdf43a1cb6ce619c4ee3a9475de208" + dependencies: + repeating "^2.0.0" + +diff@^3.2.0: + version "3.3.0" + resolved "https://registry.yarnpkg.com/diff/-/diff-3.3.0.tgz#056695150d7aa93237ca7e378ac3b1682b7963b9" + +ecc-jsbn@~0.1.1: + version "0.1.1" + resolved "https://registry.yarnpkg.com/ecc-jsbn/-/ecc-jsbn-0.1.1.tgz#0fc73a9ed5f0d53c38193398523ef7e543777505" + dependencies: + jsbn "~0.1.0" + +ee-first@1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/ee-first/-/ee-first-1.1.1.tgz#590c61156b0ae2f4f0255732a158b266bc56b21d" + +encodeurl@~1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/encodeurl/-/encodeurl-1.0.1.tgz#79e3d58655346909fe6f0f45a5de68103b294d20" + +encoding@^0.1.11: + version "0.1.12" + resolved "https://registry.yarnpkg.com/encoding/-/encoding-0.1.12.tgz#538b66f3ee62cd1ab51ec323829d1f9480c74beb" + dependencies: + iconv-lite "~0.4.13" + +errno@^0.1.4: + version "0.1.4" + resolved "https://registry.yarnpkg.com/errno/-/errno-0.1.4.tgz#b896e23a9e5e8ba33871fc996abd3635fc9a1c7d" + dependencies: + prr "~0.0.0" + +error-ex@^1.2.0: + version "1.3.1" + resolved "https://registry.yarnpkg.com/error-ex/-/error-ex-1.3.1.tgz#f855a86ce61adc4e8621c3cda21e7a7612c3a8dc" + dependencies: + is-arrayish "^0.2.1" + +escape-html@~1.0.3: + version "1.0.3" + resolved "https://registry.yarnpkg.com/escape-html/-/escape-html-1.0.3.tgz#0258eae4d3d0c0974de1c169188ef0051d1d1988" + +escape-string-regexp@^1.0.2: + version "1.0.5" + resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz#1b61c0562190a8dff6ae3bb2cf0200ca130b86d4" + +escodegen@^1.6.1: + version "1.8.1" + resolved "https://registry.yarnpkg.com/escodegen/-/escodegen-1.8.1.tgz#5a5b53af4693110bebb0867aa3430dd3b70a1018" + dependencies: + esprima "^2.7.1" + estraverse "^1.9.1" + esutils "^2.0.2" + optionator "^0.8.1" + optionalDependencies: + source-map "~0.2.0" + +esprima@^2.7.1: + version "2.7.3" + resolved "https://registry.yarnpkg.com/esprima/-/esprima-2.7.3.tgz#96e3b70d5779f6ad49cd032673d1c312767ba581" + +esprima@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/esprima/-/esprima-4.0.0.tgz#4499eddcd1110e0b218bacf2fa7f7f59f55ca804" + +estraverse@^1.9.1: + version "1.9.3" + resolved "https://registry.yarnpkg.com/estraverse/-/estraverse-1.9.3.tgz#af67f2dc922582415950926091a4005d29c9bb44" + +esutils@^2.0.2: + version "2.0.2" + resolved "https://registry.yarnpkg.com/esutils/-/esutils-2.0.2.tgz#0abf4f1caa5bcb1f7a9d8acc6dea4faaa04bac9b" + +etag@~1.8.0: + version "1.8.0" + resolved "https://registry.yarnpkg.com/etag/-/etag-1.8.0.tgz#6f631aef336d6c46362b51764044ce216be3c051" + +exec-sh@^0.2.0: + version "0.2.0" + resolved "https://registry.yarnpkg.com/exec-sh/-/exec-sh-0.2.0.tgz#14f75de3f20d286ef933099b2ce50a90359cef10" + dependencies: + merge "^1.1.3" + +expand-brackets@^0.1.4: + version "0.1.5" + resolved "https://registry.yarnpkg.com/expand-brackets/-/expand-brackets-0.1.5.tgz#df07284e342a807cd733ac5af72411e581d1177b" + dependencies: + is-posix-bracket "^0.1.0" + +expand-range@^1.8.1: + version "1.8.2" + resolved "https://registry.yarnpkg.com/expand-range/-/expand-range-1.8.2.tgz#a299effd335fe2721ebae8e257ec79644fc85337" + dependencies: + fill-range "^2.1.0" + +express@*: + version "4.15.3" + resolved "https://registry.yarnpkg.com/express/-/express-4.15.3.tgz#bab65d0f03aa80c358408972fc700f916944b662" + dependencies: + accepts "~1.3.3" + array-flatten "1.1.1" + content-disposition "0.5.2" + content-type "~1.0.2" + cookie "0.3.1" + cookie-signature "1.0.6" + debug "2.6.7" + depd "~1.1.0" + encodeurl "~1.0.1" + escape-html "~1.0.3" + etag "~1.8.0" + finalhandler "~1.0.3" + fresh "0.5.0" + merge-descriptors "1.0.1" + methods "~1.1.2" + on-finished "~2.3.0" + parseurl "~1.3.1" + path-to-regexp "0.1.7" + proxy-addr "~1.1.4" + qs "6.4.0" + range-parser "~1.2.0" + send "0.15.3" + serve-static "1.12.3" + setprototypeof "1.0.3" + statuses "~1.3.1" + type-is "~1.6.15" + utils-merge "1.0.0" + vary "~1.1.1" + +extend@~3.0.0: + version "3.0.1" + resolved "https://registry.yarnpkg.com/extend/-/extend-3.0.1.tgz#a755ea7bc1adfcc5a31ce7e762dbaadc5e636444" + +extglob@^0.3.1: + version "0.3.2" + resolved "https://registry.yarnpkg.com/extglob/-/extglob-0.3.2.tgz#2e18ff3d2f49ab2765cec9023f011daa8d8349a1" + dependencies: + is-extglob "^1.0.0" + +extsprintf@1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/extsprintf/-/extsprintf-1.0.2.tgz#e1080e0658e300b06294990cc70e1502235fd550" + +fast-levenshtein@~2.0.4: + version "2.0.6" + resolved "https://registry.yarnpkg.com/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz#3d8a5c66883a16a30ca8643e851f19baa7797917" + +fb-watchman@^1.8.0: + version "1.9.2" + resolved "https://registry.yarnpkg.com/fb-watchman/-/fb-watchman-1.9.2.tgz#a24cf47827f82d38fb59a69ad70b76e3b6ae7383" + dependencies: + bser "1.0.2" + +fb-watchman@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/fb-watchman/-/fb-watchman-2.0.0.tgz#54e9abf7dfa2f26cd9b1636c588c1afc05de5d58" + dependencies: + bser "^2.0.0" + +filename-regex@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/filename-regex/-/filename-regex-2.0.1.tgz#c1c4b9bee3e09725ddb106b75c1e301fe2f18b26" + +fileset@^2.0.2: + version "2.0.3" + resolved "https://registry.yarnpkg.com/fileset/-/fileset-2.0.3.tgz#8e7548a96d3cc2327ee5e674168723a333bba2a0" + dependencies: + glob "^7.0.3" + minimatch "^3.0.3" + +fill-range@^2.1.0: + version "2.2.3" + resolved "https://registry.yarnpkg.com/fill-range/-/fill-range-2.2.3.tgz#50b77dfd7e469bc7492470963699fe7a8485a723" + dependencies: + is-number "^2.1.0" + isobject "^2.0.0" + randomatic "^1.1.3" + repeat-element "^1.1.2" + repeat-string "^1.5.2" + +finalhandler@~1.0.3: + version "1.0.3" + resolved "https://registry.yarnpkg.com/finalhandler/-/finalhandler-1.0.3.tgz#ef47e77950e999780e86022a560e3217e0d0cc89" + dependencies: + debug "2.6.7" + encodeurl "~1.0.1" + escape-html "~1.0.3" + on-finished "~2.3.0" + parseurl "~1.3.1" + statuses "~1.3.1" + unpipe "~1.0.0" + +find-up@^1.0.0: + version "1.1.2" + resolved "https://registry.yarnpkg.com/find-up/-/find-up-1.1.2.tgz#6b2e9822b1a2ce0a60ab64d610eccad53cb24d0f" + dependencies: + path-exists "^2.0.0" + pinkie-promise "^2.0.0" + +find-up@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/find-up/-/find-up-2.1.0.tgz#45d1b7e506c717ddd482775a2b77920a3c0c57a7" + dependencies: + locate-path "^2.0.0" + +fliplog@^1.0.4: + version "1.0.4" + resolved "https://registry.yarnpkg.com/fliplog/-/fliplog-1.0.4.tgz#c66e064e1cb95473c0e037cb5855ab5da46b4441" + dependencies: + chain-able "3.0.0" + +for-in@^1.0.1: + version "1.0.2" + resolved "https://registry.yarnpkg.com/for-in/-/for-in-1.0.2.tgz#81068d295a8142ec0ac726c6e2200c30fb6d5e80" + +for-own@^0.1.4: + version "0.1.5" + resolved "https://registry.yarnpkg.com/for-own/-/for-own-0.1.5.tgz#5265c681a4f294dabbf17c9509b6763aa84510ce" + dependencies: + for-in "^1.0.1" + +forever-agent@~0.6.1: + version "0.6.1" + resolved "https://registry.yarnpkg.com/forever-agent/-/forever-agent-0.6.1.tgz#fbc71f0c41adeb37f96c577ad1ed42d8fdacca91" + +form-data@~2.1.1: + version "2.1.4" + resolved "https://registry.yarnpkg.com/form-data/-/form-data-2.1.4.tgz#33c183acf193276ecaa98143a69e94bfee1750d1" + dependencies: + asynckit "^0.4.0" + combined-stream "^1.0.5" + mime-types "^2.1.12" + +forwarded@~0.1.0: + version "0.1.0" + resolved "https://registry.yarnpkg.com/forwarded/-/forwarded-0.1.0.tgz#19ef9874c4ae1c297bcf078fde63a09b66a84363" + +fresh@0.5.0: + version "0.5.0" + resolved "https://registry.yarnpkg.com/fresh/-/fresh-0.5.0.tgz#f474ca5e6a9246d6fd8e0953cfa9b9c805afa78e" + +frisbee@^1.5.0: + version "1.5.0" + resolved "https://registry.yarnpkg.com/frisbee/-/frisbee-1.5.0.tgz#ae507b76f0fc092dfe208ced1513f2726cb555f5" + dependencies: + babel-runtime "^6.9.2" + buffer "^4.6.0" + caseless "^0.11.0" + qs "^6.2.0" + +fs.realpath@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/fs.realpath/-/fs.realpath-1.0.0.tgz#1504ad2523158caa40db4a2787cb01411994ea4f" + +get-caller-file@^1.0.1: + version "1.0.2" + resolved "https://registry.yarnpkg.com/get-caller-file/-/get-caller-file-1.0.2.tgz#f702e63127e7e231c160a80c1554acb70d5047e5" + +getpass@^0.1.1: + version "0.1.7" + resolved "https://registry.yarnpkg.com/getpass/-/getpass-0.1.7.tgz#5eff8e3e684d569ae4cb2b1282604e8ba62149fa" + dependencies: + assert-plus "^1.0.0" + +glob-base@^0.3.0: + version "0.3.0" + resolved "https://registry.yarnpkg.com/glob-base/-/glob-base-0.3.0.tgz#dbb164f6221b1c0b1ccf82aea328b497df0ea3c4" + dependencies: + glob-parent "^2.0.0" + is-glob "^2.0.0" + +glob-parent@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/glob-parent/-/glob-parent-2.0.0.tgz#81383d72db054fcccf5336daa902f182f6edbb28" + dependencies: + is-glob "^2.0.0" + +glob@^7.0.3, glob@^7.0.5, glob@^7.1.1: + version "7.1.2" + resolved "https://registry.yarnpkg.com/glob/-/glob-7.1.2.tgz#c19c9df9a028702d678612384a6552404c636d15" + dependencies: + fs.realpath "^1.0.0" + inflight "^1.0.4" + inherits "2" + minimatch "^3.0.4" + once "^1.3.0" + path-is-absolute "^1.0.0" + +globals@^9.0.0: + version "9.18.0" + resolved "https://registry.yarnpkg.com/globals/-/globals-9.18.0.tgz#aa3896b3e69b487f17e31ed2143d69a8e30c2d8a" + +graceful-fs@^4.1.11, graceful-fs@^4.1.2: + version "4.1.11" + resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.1.11.tgz#0e8bdfe4d1ddb8854d64e04ea7c00e2a026e5658" + +growly@^1.3.0: + version "1.3.0" + resolved "https://registry.yarnpkg.com/growly/-/growly-1.3.0.tgz#f10748cbe76af964b7c96c93c6bcc28af120c081" + +handlebars@^4.0.3: + version "4.0.10" + resolved "https://registry.yarnpkg.com/handlebars/-/handlebars-4.0.10.tgz#3d30c718b09a3d96f23ea4cc1f403c4d3ba9ff4f" + dependencies: + async "^1.4.0" + optimist "^0.6.1" + source-map "^0.4.4" + optionalDependencies: + uglify-js "^2.6" + +har-schema@^1.0.5: + version "1.0.5" + resolved "https://registry.yarnpkg.com/har-schema/-/har-schema-1.0.5.tgz#d263135f43307c02c602afc8fe95970c0151369e" + +har-validator@~4.2.1: + version "4.2.1" + resolved "https://registry.yarnpkg.com/har-validator/-/har-validator-4.2.1.tgz#33481d0f1bbff600dd203d75812a6a5fba002e2a" + dependencies: + ajv "^4.9.1" + har-schema "^1.0.5" + +has-ansi@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/has-ansi/-/has-ansi-2.0.0.tgz#34f5049ce1ecdf2b0649af3ef24e45ed35416d91" + dependencies: + ansi-regex "^2.0.0" + +has-flag@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/has-flag/-/has-flag-1.0.0.tgz#9d9e793165ce017a00f00418c43f942a7b1d11fa" + +hawk@~3.1.3: + version "3.1.3" + resolved "https://registry.yarnpkg.com/hawk/-/hawk-3.1.3.tgz#078444bd7c1640b0fe540d2c9b73d59678e8e1c4" + dependencies: + boom "2.x.x" + cryptiles "2.x.x" + hoek "2.x.x" + sntp "1.x.x" + +hoek@2.x.x: + version "2.16.3" + resolved "https://registry.yarnpkg.com/hoek/-/hoek-2.16.3.tgz#20bb7403d3cea398e91dc4710a8ff1b8274a25ed" + +home-or-tmp@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/home-or-tmp/-/home-or-tmp-2.0.0.tgz#e36c3f2d2cae7d746a857e38d18d5f32a7882db8" + dependencies: + os-homedir "^1.0.0" + os-tmpdir "^1.0.1" + +hosted-git-info@^2.1.4: + version "2.5.0" + resolved "https://registry.yarnpkg.com/hosted-git-info/-/hosted-git-info-2.5.0.tgz#6d60e34b3abbc8313062c3b798ef8d901a07af3c" + +html-encoding-sniffer@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/html-encoding-sniffer/-/html-encoding-sniffer-1.0.1.tgz#79bf7a785ea495fe66165e734153f363ff5437da" + dependencies: + whatwg-encoding "^1.0.1" + +http-errors@~1.6.1: + version "1.6.1" + resolved "https://registry.yarnpkg.com/http-errors/-/http-errors-1.6.1.tgz#5f8b8ed98aca545656bf572997387f904a722257" + dependencies: + depd "1.1.0" + inherits "2.0.3" + setprototypeof "1.0.3" + statuses ">= 1.3.1 < 2" + +http-signature@~1.1.0: + version "1.1.1" + resolved "https://registry.yarnpkg.com/http-signature/-/http-signature-1.1.1.tgz#df72e267066cd0ac67fb76adf8e134a8fbcf91bf" + dependencies: + assert-plus "^0.2.0" + jsprim "^1.2.2" + sshpk "^1.7.0" + +iconv-lite@0.4.13: + version "0.4.13" + resolved "https://registry.yarnpkg.com/iconv-lite/-/iconv-lite-0.4.13.tgz#1f88aba4ab0b1508e8312acc39345f36e992e2f2" + +iconv-lite@0.4.15: + version "0.4.15" + resolved "https://registry.yarnpkg.com/iconv-lite/-/iconv-lite-0.4.15.tgz#fe265a218ac6a57cfe854927e9d04c19825eddeb" + +iconv-lite@~0.4.13: + version "0.4.18" + resolved "https://registry.yarnpkg.com/iconv-lite/-/iconv-lite-0.4.18.tgz#23d8656b16aae6742ac29732ea8f0336a4789cf2" + +ieee754@^1.1.4: + version "1.1.8" + resolved "https://registry.yarnpkg.com/ieee754/-/ieee754-1.1.8.tgz#be33d40ac10ef1926701f6f08a2d86fbfd1ad3e4" + +inflight@^1.0.4: + version "1.0.6" + resolved "https://registry.yarnpkg.com/inflight/-/inflight-1.0.6.tgz#49bd6331d7d02d0c09bc910a1075ba8165b56df9" + dependencies: + once "^1.3.0" + wrappy "1" + +inherits@2, inherits@2.0.3: + version "2.0.3" + resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.3.tgz#633c2c83e3da42a502f52466022480f4208261de" + +invariant@^2.2.0: + version "2.2.2" + resolved "https://registry.yarnpkg.com/invariant/-/invariant-2.2.2.tgz#9e1f56ac0acdb6bf303306f338be3b204ae60360" + dependencies: + loose-envify "^1.0.0" + +invert-kv@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/invert-kv/-/invert-kv-1.0.0.tgz#104a8e4aaca6d3d8cd157a8ef8bfab2d7a3ffdb6" + +ipaddr.js@1.3.0: + version "1.3.0" + resolved "https://registry.yarnpkg.com/ipaddr.js/-/ipaddr.js-1.3.0.tgz#1e03a52fdad83a8bbb2b25cbf4998b4cffcd3dec" + +is-arrayish@^0.2.1: + version "0.2.1" + resolved "https://registry.yarnpkg.com/is-arrayish/-/is-arrayish-0.2.1.tgz#77c99840527aa8ecb1a8ba697b80645a7a926a9d" + +is-buffer@^1.1.5: + version "1.1.5" + resolved "https://registry.yarnpkg.com/is-buffer/-/is-buffer-1.1.5.tgz#1f3b26ef613b214b88cbca23cc6c01d87961eecc" + +is-builtin-module@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/is-builtin-module/-/is-builtin-module-1.0.0.tgz#540572d34f7ac3119f8f76c30cbc1b1e037affbe" + dependencies: + builtin-modules "^1.0.0" + +is-ci@^1.0.10: + version "1.0.10" + resolved "https://registry.yarnpkg.com/is-ci/-/is-ci-1.0.10.tgz#f739336b2632365061a9d48270cd56ae3369318e" + dependencies: + ci-info "^1.0.0" + +is-dotfile@^1.0.0: + version "1.0.3" + resolved "https://registry.yarnpkg.com/is-dotfile/-/is-dotfile-1.0.3.tgz#a6a2f32ffd2dfb04f5ca25ecd0f6b83cf798a1e1" + +is-equal-shallow@^0.1.3: + version "0.1.3" + resolved "https://registry.yarnpkg.com/is-equal-shallow/-/is-equal-shallow-0.1.3.tgz#2238098fc221de0bcfa5d9eac4c45d638aa1c534" + dependencies: + is-primitive "^2.0.0" + +is-extendable@^0.1.1: + version "0.1.1" + resolved "https://registry.yarnpkg.com/is-extendable/-/is-extendable-0.1.1.tgz#62b110e289a471418e3ec36a617d472e301dfc89" + +is-extglob@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/is-extglob/-/is-extglob-1.0.0.tgz#ac468177c4943405a092fc8f29760c6ffc6206c0" + +is-finite@^1.0.0: + version "1.0.2" + resolved "https://registry.yarnpkg.com/is-finite/-/is-finite-1.0.2.tgz#cc6677695602be550ef11e8b4aa6305342b6d0aa" + dependencies: + number-is-nan "^1.0.0" + +is-fullwidth-code-point@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/is-fullwidth-code-point/-/is-fullwidth-code-point-1.0.0.tgz#ef9e31386f031a7f0d643af82fde50c457ef00cb" + dependencies: + number-is-nan "^1.0.0" + +is-glob@^2.0.0, is-glob@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/is-glob/-/is-glob-2.0.1.tgz#d096f926a3ded5600f3fdfd91198cb0888c2d863" + dependencies: + is-extglob "^1.0.0" + +is-number@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/is-number/-/is-number-2.1.0.tgz#01fcbbb393463a548f2f466cce16dece49db908f" + dependencies: + kind-of "^3.0.2" + +is-number@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/is-number/-/is-number-3.0.0.tgz#24fd6201a4782cf50561c810276afc7d12d71195" + dependencies: + kind-of "^3.0.2" + +is-posix-bracket@^0.1.0: + version "0.1.1" + resolved "https://registry.yarnpkg.com/is-posix-bracket/-/is-posix-bracket-0.1.1.tgz#3334dc79774368e92f016e6fbc0a88f5cd6e6bc4" + +is-primitive@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/is-primitive/-/is-primitive-2.0.0.tgz#207bab91638499c07b2adf240a41a87210034575" + +is-stream@^1.0.1: + version "1.1.0" + resolved "https://registry.yarnpkg.com/is-stream/-/is-stream-1.1.0.tgz#12d4a3dd4e68e0b79ceb8dbc84173ae80d91ca44" + +is-typedarray@~1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/is-typedarray/-/is-typedarray-1.0.0.tgz#e479c80858df0c1b11ddda6940f96011fcda4a9a" + +is-utf8@^0.2.0: + version "0.2.1" + resolved "https://registry.yarnpkg.com/is-utf8/-/is-utf8-0.2.1.tgz#4b0da1442104d1b336340e80797e865cf39f7d72" + +isarray@1.0.0, isarray@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/isarray/-/isarray-1.0.0.tgz#bb935d48582cba168c06834957a54a3e07124f11" + +isexe@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/isexe/-/isexe-2.0.0.tgz#e8fbf374dc556ff8947a10dcb0572d633f2cfa10" + +isobject@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/isobject/-/isobject-2.1.0.tgz#f065561096a3f1da2ef46272f815c840d87e0c89" + dependencies: + isarray "1.0.0" + +isomorphic-fetch@*: + version "2.2.1" + resolved "https://registry.yarnpkg.com/isomorphic-fetch/-/isomorphic-fetch-2.2.1.tgz#611ae1acf14f5e81f729507472819fe9733558a9" + dependencies: + node-fetch "^1.0.1" + whatwg-fetch ">=0.10.0" + +isstream@~0.1.2: + version "0.1.2" + resolved "https://registry.yarnpkg.com/isstream/-/isstream-0.1.2.tgz#47e63f7af55afa6f92e1500e690eb8b8529c099a" + +istanbul-api@^1.1.1: + version "1.1.11" + resolved "https://registry.yarnpkg.com/istanbul-api/-/istanbul-api-1.1.11.tgz#fcc0b461e2b3bda71e305155138238768257d9de" + dependencies: + async "^2.1.4" + fileset "^2.0.2" + istanbul-lib-coverage "^1.1.1" + istanbul-lib-hook "^1.0.7" + istanbul-lib-instrument "^1.7.4" + istanbul-lib-report "^1.1.1" + istanbul-lib-source-maps "^1.2.1" + istanbul-reports "^1.1.1" + js-yaml "^3.7.0" + mkdirp "^0.5.1" + once "^1.4.0" + +istanbul-lib-coverage@^1.0.1, istanbul-lib-coverage@^1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/istanbul-lib-coverage/-/istanbul-lib-coverage-1.1.1.tgz#73bfb998885299415c93d38a3e9adf784a77a9da" + +istanbul-lib-hook@^1.0.7: + version "1.0.7" + resolved "https://registry.yarnpkg.com/istanbul-lib-hook/-/istanbul-lib-hook-1.0.7.tgz#dd6607f03076578fe7d6f2a630cf143b49bacddc" + dependencies: + append-transform "^0.4.0" + +istanbul-lib-instrument@^1.4.2, istanbul-lib-instrument@^1.7.2, istanbul-lib-instrument@^1.7.4: + version "1.7.4" + resolved "https://registry.yarnpkg.com/istanbul-lib-instrument/-/istanbul-lib-instrument-1.7.4.tgz#e9fd920e4767f3d19edc765e2d6b3f5ccbd0eea8" + dependencies: + babel-generator "^6.18.0" + babel-template "^6.16.0" + babel-traverse "^6.18.0" + babel-types "^6.18.0" + babylon "^6.17.4" + istanbul-lib-coverage "^1.1.1" + semver "^5.3.0" + +istanbul-lib-report@^1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/istanbul-lib-report/-/istanbul-lib-report-1.1.1.tgz#f0e55f56655ffa34222080b7a0cd4760e1405fc9" + dependencies: + istanbul-lib-coverage "^1.1.1" + mkdirp "^0.5.1" + path-parse "^1.0.5" + supports-color "^3.1.2" + +istanbul-lib-source-maps@^1.1.0, istanbul-lib-source-maps@^1.2.1: + version "1.2.1" + resolved "https://registry.yarnpkg.com/istanbul-lib-source-maps/-/istanbul-lib-source-maps-1.2.1.tgz#a6fe1acba8ce08eebc638e572e294d267008aa0c" + dependencies: + debug "^2.6.3" + istanbul-lib-coverage "^1.1.1" + mkdirp "^0.5.1" + rimraf "^2.6.1" + source-map "^0.5.3" + +istanbul-reports@^1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/istanbul-reports/-/istanbul-reports-1.1.1.tgz#042be5c89e175bc3f86523caab29c014e77fee4e" + dependencies: + handlebars "^4.0.3" + +jest-changed-files@^20.0.3: + version "20.0.3" + resolved "https://registry.yarnpkg.com/jest-changed-files/-/jest-changed-files-20.0.3.tgz#9394d5cc65c438406149bef1bf4d52b68e03e3f8" + +jest-cli@^20.0.4: + version "20.0.4" + resolved "https://registry.yarnpkg.com/jest-cli/-/jest-cli-20.0.4.tgz#e532b19d88ae5bc6c417e8b0593a6fe954b1dc93" + dependencies: + ansi-escapes "^1.4.0" + callsites "^2.0.0" + chalk "^1.1.3" + graceful-fs "^4.1.11" + is-ci "^1.0.10" + istanbul-api "^1.1.1" + istanbul-lib-coverage "^1.0.1" + istanbul-lib-instrument "^1.4.2" + istanbul-lib-source-maps "^1.1.0" + jest-changed-files "^20.0.3" + jest-config "^20.0.4" + jest-docblock "^20.0.3" + jest-environment-jsdom "^20.0.3" + jest-haste-map "^20.0.4" + jest-jasmine2 "^20.0.4" + jest-message-util "^20.0.3" + jest-regex-util "^20.0.3" + jest-resolve-dependencies "^20.0.3" + jest-runtime "^20.0.4" + jest-snapshot "^20.0.3" + jest-util "^20.0.3" + micromatch "^2.3.11" + node-notifier "^5.0.2" + pify "^2.3.0" + slash "^1.0.0" + string-length "^1.0.1" + throat "^3.0.0" + which "^1.2.12" + worker-farm "^1.3.1" + yargs "^7.0.2" + +jest-config@^20.0.4: + version "20.0.4" + resolved "https://registry.yarnpkg.com/jest-config/-/jest-config-20.0.4.tgz#e37930ab2217c913605eff13e7bd763ec48faeea" + dependencies: + chalk "^1.1.3" + glob "^7.1.1" + jest-environment-jsdom "^20.0.3" + jest-environment-node "^20.0.3" + jest-jasmine2 "^20.0.4" + jest-matcher-utils "^20.0.3" + jest-regex-util "^20.0.3" + jest-resolve "^20.0.4" + jest-validate "^20.0.3" + pretty-format "^20.0.3" + +jest-diff@^20.0.3: + version "20.0.3" + resolved "https://registry.yarnpkg.com/jest-diff/-/jest-diff-20.0.3.tgz#81f288fd9e675f0fb23c75f1c2b19445fe586617" + dependencies: + chalk "^1.1.3" + diff "^3.2.0" + jest-matcher-utils "^20.0.3" + pretty-format "^20.0.3" + +jest-docblock@^20.0.3: + version "20.0.3" + resolved "https://registry.yarnpkg.com/jest-docblock/-/jest-docblock-20.0.3.tgz#17bea984342cc33d83c50fbe1545ea0efaa44712" + +jest-environment-jsdom@^20.0.3: + version "20.0.3" + resolved "https://registry.yarnpkg.com/jest-environment-jsdom/-/jest-environment-jsdom-20.0.3.tgz#048a8ac12ee225f7190417713834bb999787de99" + dependencies: + jest-mock "^20.0.3" + jest-util "^20.0.3" + jsdom "^9.12.0" + +jest-environment-node@^20.0.3: + version "20.0.3" + resolved "https://registry.yarnpkg.com/jest-environment-node/-/jest-environment-node-20.0.3.tgz#d488bc4612af2c246e986e8ae7671a099163d403" + dependencies: + jest-mock "^20.0.3" + jest-util "^20.0.3" + +jest-haste-map@^20.0.4: + version "20.0.4" + resolved "https://registry.yarnpkg.com/jest-haste-map/-/jest-haste-map-20.0.4.tgz#653eb55c889ce3c021f7b94693f20a4159badf03" + dependencies: + fb-watchman "^2.0.0" + graceful-fs "^4.1.11" + jest-docblock "^20.0.3" + micromatch "^2.3.11" + sane "~1.6.0" + worker-farm "^1.3.1" + +jest-jasmine2@^20.0.4: + version "20.0.4" + resolved "https://registry.yarnpkg.com/jest-jasmine2/-/jest-jasmine2-20.0.4.tgz#fcc5b1411780d911d042902ef1859e852e60d5e1" + dependencies: + chalk "^1.1.3" + graceful-fs "^4.1.11" + jest-diff "^20.0.3" + jest-matcher-utils "^20.0.3" + jest-matchers "^20.0.3" + jest-message-util "^20.0.3" + jest-snapshot "^20.0.3" + once "^1.4.0" + p-map "^1.1.1" + +jest-matcher-utils@^20.0.3: + version "20.0.3" + resolved "https://registry.yarnpkg.com/jest-matcher-utils/-/jest-matcher-utils-20.0.3.tgz#b3a6b8e37ca577803b0832a98b164f44b7815612" + dependencies: + chalk "^1.1.3" + pretty-format "^20.0.3" + +jest-matchers@^20.0.3: + version "20.0.3" + resolved "https://registry.yarnpkg.com/jest-matchers/-/jest-matchers-20.0.3.tgz#ca69db1c32db5a6f707fa5e0401abb55700dfd60" + dependencies: + jest-diff "^20.0.3" + jest-matcher-utils "^20.0.3" + jest-message-util "^20.0.3" + jest-regex-util "^20.0.3" + +jest-message-util@^20.0.3: + version "20.0.3" + resolved "https://registry.yarnpkg.com/jest-message-util/-/jest-message-util-20.0.3.tgz#6aec2844306fcb0e6e74d5796c1006d96fdd831c" + dependencies: + chalk "^1.1.3" + micromatch "^2.3.11" + slash "^1.0.0" + +jest-mock@^20.0.3: + version "20.0.3" + resolved "https://registry.yarnpkg.com/jest-mock/-/jest-mock-20.0.3.tgz#8bc070e90414aa155c11a8d64c869a0d5c71da59" + +jest-regex-util@^20.0.3: + version "20.0.3" + resolved "https://registry.yarnpkg.com/jest-regex-util/-/jest-regex-util-20.0.3.tgz#85bbab5d133e44625b19faf8c6aa5122d085d762" + +jest-resolve-dependencies@^20.0.3: + version "20.0.3" + resolved "https://registry.yarnpkg.com/jest-resolve-dependencies/-/jest-resolve-dependencies-20.0.3.tgz#6e14a7b717af0f2cb3667c549de40af017b1723a" + dependencies: + jest-regex-util "^20.0.3" + +jest-resolve@^20.0.4: + version "20.0.4" + resolved "https://registry.yarnpkg.com/jest-resolve/-/jest-resolve-20.0.4.tgz#9448b3e8b6bafc15479444c6499045b7ffe597a5" + dependencies: + browser-resolve "^1.11.2" + is-builtin-module "^1.0.0" + resolve "^1.3.2" + +jest-runtime@^20.0.4: + version "20.0.4" + resolved "https://registry.yarnpkg.com/jest-runtime/-/jest-runtime-20.0.4.tgz#a2c802219c4203f754df1404e490186169d124d8" + dependencies: + babel-core "^6.0.0" + babel-jest "^20.0.3" + babel-plugin-istanbul "^4.0.0" + chalk "^1.1.3" + convert-source-map "^1.4.0" + graceful-fs "^4.1.11" + jest-config "^20.0.4" + jest-haste-map "^20.0.4" + jest-regex-util "^20.0.3" + jest-resolve "^20.0.4" + jest-util "^20.0.3" + json-stable-stringify "^1.0.1" + micromatch "^2.3.11" + strip-bom "3.0.0" + yargs "^7.0.2" + +jest-snapshot@^20.0.3: + version "20.0.3" + resolved "https://registry.yarnpkg.com/jest-snapshot/-/jest-snapshot-20.0.3.tgz#5b847e1adb1a4d90852a7f9f125086e187c76566" + dependencies: + chalk "^1.1.3" + jest-diff "^20.0.3" + jest-matcher-utils "^20.0.3" + jest-util "^20.0.3" + natural-compare "^1.4.0" + pretty-format "^20.0.3" + +jest-util@^20.0.3: + version "20.0.3" + resolved "https://registry.yarnpkg.com/jest-util/-/jest-util-20.0.3.tgz#0c07f7d80d82f4e5a67c6f8b9c3fe7f65cfd32ad" + dependencies: + chalk "^1.1.3" + graceful-fs "^4.1.11" + jest-message-util "^20.0.3" + jest-mock "^20.0.3" + jest-validate "^20.0.3" + leven "^2.1.0" + mkdirp "^0.5.1" + +jest-validate@^20.0.3: + version "20.0.3" + resolved "https://registry.yarnpkg.com/jest-validate/-/jest-validate-20.0.3.tgz#d0cfd1de4f579f298484925c280f8f1d94ec3cab" + dependencies: + chalk "^1.1.3" + jest-matcher-utils "^20.0.3" + leven "^2.1.0" + pretty-format "^20.0.3" + +jest@*: + version "20.0.4" + resolved "https://registry.yarnpkg.com/jest/-/jest-20.0.4.tgz#3dd260c2989d6dad678b1e9cc4d91944f6d602ac" + dependencies: + jest-cli "^20.0.4" + +js-tokens@^3.0.0: + version "3.0.2" + resolved "https://registry.yarnpkg.com/js-tokens/-/js-tokens-3.0.2.tgz#9866df395102130e38f7f996bceb65443209c25b" + +js-yaml@^3.7.0: + version "3.9.0" + resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.9.0.tgz#4ffbbf25c2ac963b8299dc74da7e3740de1c18ce" + dependencies: + argparse "^1.0.7" + esprima "^4.0.0" + +jsbn@~0.1.0: + version "0.1.1" + resolved "https://registry.yarnpkg.com/jsbn/-/jsbn-0.1.1.tgz#a5e654c2e5a2deb5f201d96cefbca80c0ef2f513" + +jsdom@^9.12.0: + version "9.12.0" + resolved "https://registry.yarnpkg.com/jsdom/-/jsdom-9.12.0.tgz#e8c546fffcb06c00d4833ca84410fed7f8a097d4" + dependencies: + abab "^1.0.3" + acorn "^4.0.4" + acorn-globals "^3.1.0" + array-equal "^1.0.0" + content-type-parser "^1.0.1" + cssom ">= 0.3.2 < 0.4.0" + cssstyle ">= 0.2.37 < 0.3.0" + escodegen "^1.6.1" + html-encoding-sniffer "^1.0.1" + nwmatcher ">= 1.3.9 < 2.0.0" + parse5 "^1.5.1" + request "^2.79.0" + sax "^1.2.1" + symbol-tree "^3.2.1" + tough-cookie "^2.3.2" + webidl-conversions "^4.0.0" + whatwg-encoding "^1.0.1" + whatwg-url "^4.3.0" + xml-name-validator "^2.0.1" + +jsesc@^1.3.0: + version "1.3.0" + resolved "https://registry.yarnpkg.com/jsesc/-/jsesc-1.3.0.tgz#46c3fec8c1892b12b0833db9bc7622176dbab34b" + +json-schema@0.2.3: + version "0.2.3" + resolved "https://registry.yarnpkg.com/json-schema/-/json-schema-0.2.3.tgz#b480c892e59a2f05954ce727bd3f2a4e882f9e13" + +json-stable-stringify@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/json-stable-stringify/-/json-stable-stringify-1.0.1.tgz#9a759d39c5f2ff503fd5300646ed445f88c4f9af" + dependencies: + jsonify "~0.0.0" + +json-stringify-safe@~5.0.1: + version "5.0.1" + resolved "https://registry.yarnpkg.com/json-stringify-safe/-/json-stringify-safe-5.0.1.tgz#1296a2d58fd45f19a0f6ce01d65701e2c735b6eb" + +json5@^0.5.0: + version "0.5.1" + resolved "https://registry.yarnpkg.com/json5/-/json5-0.5.1.tgz#1eade7acc012034ad84e2396767ead9fa5495821" + +jsonify@~0.0.0: + version "0.0.0" + resolved "https://registry.yarnpkg.com/jsonify/-/jsonify-0.0.0.tgz#2c74b6ee41d93ca51b7b5aaee8f503631d252a73" + +jsprim@^1.2.2: + version "1.4.0" + resolved "https://registry.yarnpkg.com/jsprim/-/jsprim-1.4.0.tgz#a3b87e40298d8c380552d8cc7628a0bb95a22918" + dependencies: + assert-plus "1.0.0" + extsprintf "1.0.2" + json-schema "0.2.3" + verror "1.3.6" + +kind-of@^3.0.2: + version "3.2.2" + resolved "https://registry.yarnpkg.com/kind-of/-/kind-of-3.2.2.tgz#31ea21a734bab9bbb0f32466d893aea51e4a3c64" + dependencies: + is-buffer "^1.1.5" + +kind-of@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/kind-of/-/kind-of-4.0.0.tgz#20813df3d712928b207378691a45066fae72dd57" + dependencies: + is-buffer "^1.1.5" + +lazy-cache@^1.0.3: + version "1.0.4" + resolved "https://registry.yarnpkg.com/lazy-cache/-/lazy-cache-1.0.4.tgz#a1d78fc3a50474cb80845d3b3b6e1da49a446e8e" + +lcid@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/lcid/-/lcid-1.0.0.tgz#308accafa0bc483a3867b4b6f2b9506251d1b835" + dependencies: + invert-kv "^1.0.0" + +leven@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/leven/-/leven-2.1.0.tgz#c2e7a9f772094dee9d34202ae8acce4687875580" + +levn@~0.3.0: + version "0.3.0" + resolved "https://registry.yarnpkg.com/levn/-/levn-0.3.0.tgz#3b09924edf9f083c0490fdd4c0bc4421e04764ee" + dependencies: + prelude-ls "~1.1.2" + type-check "~0.3.2" + +load-json-file@^1.0.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/load-json-file/-/load-json-file-1.1.0.tgz#956905708d58b4bab4c2261b04f59f31c99374c0" + dependencies: + graceful-fs "^4.1.2" + parse-json "^2.2.0" + pify "^2.0.0" + pinkie-promise "^2.0.0" + strip-bom "^2.0.0" + +locate-path@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/locate-path/-/locate-path-2.0.0.tgz#2b568b265eec944c6d9c0de9c3dbbbca0354cd8e" + dependencies: + p-locate "^2.0.0" + path-exists "^3.0.0" + +lodash@^4.14.0, lodash@^4.2.0: + version "4.17.4" + resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.4.tgz#78203a4d1c328ae1d86dca6460e369b57f4055ae" + +longest@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/longest/-/longest-1.0.1.tgz#30a0b2da38f73770e8294a0d22e6625ed77d0097" + +loose-envify@^1.0.0: + version "1.3.1" + resolved "https://registry.yarnpkg.com/loose-envify/-/loose-envify-1.3.1.tgz#d1a8ad33fa9ce0e713d65fdd0ac8b748d478c848" + dependencies: + js-tokens "^3.0.0" + +makeerror@1.0.x: + version "1.0.11" + resolved "https://registry.yarnpkg.com/makeerror/-/makeerror-1.0.11.tgz#e01a5c9109f2af79660e4e8b9587790184f5a96c" + dependencies: + tmpl "1.0.x" + +media-typer@0.3.0: + version "0.3.0" + resolved "https://registry.yarnpkg.com/media-typer/-/media-typer-0.3.0.tgz#8710d7af0aa626f8fffa1ce00168545263255748" + +merge-descriptors@1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/merge-descriptors/-/merge-descriptors-1.0.1.tgz#b00aaa556dd8b44568150ec9d1b953f3f90cbb61" + +merge@^1.1.3: + version "1.2.0" + resolved "https://registry.yarnpkg.com/merge/-/merge-1.2.0.tgz#7531e39d4949c281a66b8c5a6e0265e8b05894da" + +methods@~1.1.2: + version "1.1.2" + resolved "https://registry.yarnpkg.com/methods/-/methods-1.1.2.tgz#5529a4d67654134edcc5266656835b0f851afcee" + +micromatch@^2.1.5, micromatch@^2.3.11: + version "2.3.11" + resolved "https://registry.yarnpkg.com/micromatch/-/micromatch-2.3.11.tgz#86677c97d1720b363431d04d0d15293bd38c1565" + dependencies: + arr-diff "^2.0.0" + array-unique "^0.2.1" + braces "^1.8.2" + expand-brackets "^0.1.4" + extglob "^0.3.1" + filename-regex "^2.0.0" + is-extglob "^1.0.0" + is-glob "^2.0.1" + kind-of "^3.0.2" + normalize-path "^2.0.1" + object.omit "^2.0.0" + parse-glob "^3.0.4" + regex-cache "^0.4.2" + +mime-db@~1.27.0: + version "1.27.0" + resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.27.0.tgz#820f572296bbd20ec25ed55e5b5de869e5436eb1" + +mime-types@^2.1.12, mime-types@~2.1.11, mime-types@~2.1.15, mime-types@~2.1.7: + version "2.1.15" + resolved "https://registry.yarnpkg.com/mime-types/-/mime-types-2.1.15.tgz#a4ebf5064094569237b8cf70046776d09fc92aed" + dependencies: + mime-db "~1.27.0" + +mime@1.3.4: + version "1.3.4" + resolved "https://registry.yarnpkg.com/mime/-/mime-1.3.4.tgz#115f9e3b6b3daf2959983cb38f149a2d40eb5d53" + +minimatch@^3.0.2, minimatch@^3.0.3, minimatch@^3.0.4: + version "3.0.4" + resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.0.4.tgz#5166e286457f03306064be5497e8dbb0c3d32083" + dependencies: + brace-expansion "^1.1.7" + +minimist@0.0.8: + version "0.0.8" + resolved "https://registry.yarnpkg.com/minimist/-/minimist-0.0.8.tgz#857fcabfc3397d2625b8228262e86aa7a011b05d" + +minimist@^1.1.1: + version "1.2.0" + resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.0.tgz#a35008b20f41383eec1fb914f4cd5df79a264284" + +minimist@~0.0.1: + version "0.0.10" + resolved "https://registry.yarnpkg.com/minimist/-/minimist-0.0.10.tgz#de3f98543dbf96082be48ad1a0c7cda836301dcf" + +mkdirp@^0.5.1: + version "0.5.1" + resolved "https://registry.yarnpkg.com/mkdirp/-/mkdirp-0.5.1.tgz#30057438eac6cf7f8c4767f38648d6697d75c903" + dependencies: + minimist "0.0.8" + +ms@2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/ms/-/ms-2.0.0.tgz#5608aeadfc00be6c2901df5f9861788de0d597c8" + +natural-compare@^1.4.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/natural-compare/-/natural-compare-1.4.0.tgz#4abebfeed7541f2c27acfb29bdbbd15c8d5ba4f7" + +negotiator@0.6.1: + version "0.6.1" + resolved "https://registry.yarnpkg.com/negotiator/-/negotiator-0.6.1.tgz#2b327184e8992101177b28563fb5e7102acd0ca9" + +node-fetch@^1.0.1, node-fetch@^1.7.1: + version "1.7.1" + resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-1.7.1.tgz#899cb3d0a3c92f952c47f1b876f4c8aeabd400d5" + dependencies: + encoding "^0.1.11" + is-stream "^1.0.1" + +node-int64@^0.4.0: + version "0.4.0" + resolved "https://registry.yarnpkg.com/node-int64/-/node-int64-0.4.0.tgz#87a9065cdb355d3182d8f94ce11188b825c68a3b" + +node-notifier@^5.0.2: + version "5.1.2" + resolved "https://registry.yarnpkg.com/node-notifier/-/node-notifier-5.1.2.tgz#2fa9e12605fa10009d44549d6fcd8a63dde0e4ff" + dependencies: + growly "^1.3.0" + semver "^5.3.0" + shellwords "^0.1.0" + which "^1.2.12" + +normalize-package-data@^2.3.2: + version "2.4.0" + resolved "https://registry.yarnpkg.com/normalize-package-data/-/normalize-package-data-2.4.0.tgz#12f95a307d58352075a04907b84ac8be98ac012f" + dependencies: + hosted-git-info "^2.1.4" + is-builtin-module "^1.0.0" + semver "2 || 3 || 4 || 5" + validate-npm-package-license "^3.0.1" + +normalize-path@^2.0.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/normalize-path/-/normalize-path-2.1.1.tgz#1ab28b556e198363a8c1a6f7e6fa20137fe6aed9" + dependencies: + remove-trailing-separator "^1.0.1" + +number-is-nan@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/number-is-nan/-/number-is-nan-1.0.1.tgz#097b602b53422a522c1afb8790318336941a011d" + +"nwmatcher@>= 1.3.9 < 2.0.0": + version "1.4.1" + resolved "https://registry.yarnpkg.com/nwmatcher/-/nwmatcher-1.4.1.tgz#7ae9b07b0ea804db7e25f05cb5fe4097d4e4949f" + +oauth-sign@~0.8.1: + version "0.8.2" + resolved "https://registry.yarnpkg.com/oauth-sign/-/oauth-sign-0.8.2.tgz#46a6ab7f0aead8deae9ec0565780b7d4efeb9d43" + +object-assign@^4, object-assign@^4.1.0: + version "4.1.1" + resolved "https://registry.yarnpkg.com/object-assign/-/object-assign-4.1.1.tgz#2109adc7965887cfc05cbbd442cac8bfbb360863" + +object.omit@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/object.omit/-/object.omit-2.0.1.tgz#1a9c744829f39dbb858c76ca3579ae2a54ebd1fa" + dependencies: + for-own "^0.1.4" + is-extendable "^0.1.1" + +on-finished@~2.3.0: + version "2.3.0" + resolved "https://registry.yarnpkg.com/on-finished/-/on-finished-2.3.0.tgz#20f1336481b083cd75337992a16971aa2d906947" + dependencies: + ee-first "1.1.1" + +once@^1.3.0, once@^1.4.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/once/-/once-1.4.0.tgz#583b1aa775961d4b113ac17d9c50baef9dd76bd1" + dependencies: + wrappy "1" + +optimist@^0.6.1: + version "0.6.1" + resolved "https://registry.yarnpkg.com/optimist/-/optimist-0.6.1.tgz#da3ea74686fa21a19a111c326e90eb15a0196686" + dependencies: + minimist "~0.0.1" + wordwrap "~0.0.2" + +optionator@^0.8.1: + version "0.8.2" + resolved "https://registry.yarnpkg.com/optionator/-/optionator-0.8.2.tgz#364c5e409d3f4d6301d6c0b4c05bba50180aeb64" + dependencies: + deep-is "~0.1.3" + fast-levenshtein "~2.0.4" + levn "~0.3.0" + prelude-ls "~1.1.2" + type-check "~0.3.2" + wordwrap "~1.0.0" + +os-homedir@^1.0.0: + version "1.0.2" + resolved "https://registry.yarnpkg.com/os-homedir/-/os-homedir-1.0.2.tgz#ffbc4988336e0e833de0c168c7ef152121aa7fb3" + +os-locale@^1.4.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/os-locale/-/os-locale-1.4.0.tgz#20f9f17ae29ed345e8bde583b13d2009803c14d9" + dependencies: + lcid "^1.0.0" + +os-tmpdir@^1.0.1: + version "1.0.2" + resolved "https://registry.yarnpkg.com/os-tmpdir/-/os-tmpdir-1.0.2.tgz#bbe67406c79aa85c5cfec766fe5734555dfa1274" + +p-limit@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/p-limit/-/p-limit-1.1.0.tgz#b07ff2d9a5d88bec806035895a2bab66a27988bc" + +p-locate@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/p-locate/-/p-locate-2.0.0.tgz#20a0103b222a70c8fd39cc2e580680f3dde5ec43" + dependencies: + p-limit "^1.1.0" + +p-map@^1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/p-map/-/p-map-1.1.1.tgz#05f5e4ae97a068371bc2a5cc86bfbdbc19c4ae7a" + +parse-glob@^3.0.4: + version "3.0.4" + resolved "https://registry.yarnpkg.com/parse-glob/-/parse-glob-3.0.4.tgz#b2c376cfb11f35513badd173ef0bb6e3a388391c" + dependencies: + glob-base "^0.3.0" + is-dotfile "^1.0.0" + is-extglob "^1.0.0" + is-glob "^2.0.0" + +parse-json@^2.2.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/parse-json/-/parse-json-2.2.0.tgz#f480f40434ef80741f8469099f8dea18f55a4dc9" + dependencies: + error-ex "^1.2.0" + +parse5@^1.5.1: + version "1.5.1" + resolved "https://registry.yarnpkg.com/parse5/-/parse5-1.5.1.tgz#9b7f3b0de32be78dc2401b17573ccaf0f6f59d94" + +parseurl@~1.3.1: + version "1.3.1" + resolved "https://registry.yarnpkg.com/parseurl/-/parseurl-1.3.1.tgz#c8ab8c9223ba34888aa64a297b28853bec18da56" + +path-exists@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-2.1.0.tgz#0feb6c64f0fc518d9a754dd5efb62c7022761f4b" + dependencies: + pinkie-promise "^2.0.0" + +path-exists@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-3.0.0.tgz#ce0ebeaa5f78cb18925ea7d810d7b59b010fd515" + +path-is-absolute@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/path-is-absolute/-/path-is-absolute-1.0.1.tgz#174b9268735534ffbc7ace6bf53a5a9e1b5c5f5f" + +path-parse@^1.0.5: + version "1.0.5" + resolved "https://registry.yarnpkg.com/path-parse/-/path-parse-1.0.5.tgz#3c1adf871ea9cd6c9431b6ea2bd74a0ff055c4c1" + +path-to-regexp@0.1.7: + version "0.1.7" + resolved "https://registry.yarnpkg.com/path-to-regexp/-/path-to-regexp-0.1.7.tgz#df604178005f522f15eb4490e7247a1bfaa67f8c" + +path-type@^1.0.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/path-type/-/path-type-1.1.0.tgz#59c44f7ee491da704da415da5a4070ba4f8fe441" + dependencies: + graceful-fs "^4.1.2" + pify "^2.0.0" + pinkie-promise "^2.0.0" + +performance-now@^0.2.0: + version "0.2.0" + resolved "https://registry.yarnpkg.com/performance-now/-/performance-now-0.2.0.tgz#33ef30c5c77d4ea21c5a53869d91b56d8f2555e5" + +pify@^2.0.0, pify@^2.3.0: + version "2.3.0" + resolved "https://registry.yarnpkg.com/pify/-/pify-2.3.0.tgz#ed141a6ac043a849ea588498e7dca8b15330e90c" + +pinkie-promise@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/pinkie-promise/-/pinkie-promise-2.0.1.tgz#2135d6dfa7a358c069ac9b178776288228450ffa" + dependencies: + pinkie "^2.0.0" + +pinkie@^2.0.0: + version "2.0.4" + resolved "https://registry.yarnpkg.com/pinkie/-/pinkie-2.0.4.tgz#72556b80cfa0d48a974e80e77248e80ed4f7f870" + +prelude-ls@~1.1.2: + version "1.1.2" + resolved "https://registry.yarnpkg.com/prelude-ls/-/prelude-ls-1.1.2.tgz#21932a549f5e52ffd9a827f570e04be62a97da54" + +preserve@^0.2.0: + version "0.2.0" + resolved "https://registry.yarnpkg.com/preserve/-/preserve-0.2.0.tgz#815ed1f6ebc65926f865b310c0713bcb3315ce4b" + +pretty-format@^20.0.3: + version "20.0.3" + resolved "https://registry.yarnpkg.com/pretty-format/-/pretty-format-20.0.3.tgz#020e350a560a1fe1a98dc3beb6ccffb386de8b14" + dependencies: + ansi-regex "^2.1.1" + ansi-styles "^3.0.0" + +private@^0.1.6: + version "0.1.7" + resolved "https://registry.yarnpkg.com/private/-/private-0.1.7.tgz#68ce5e8a1ef0a23bb570cc28537b5332aba63ef1" + +proxy-addr@~1.1.4: + version "1.1.4" + resolved "https://registry.yarnpkg.com/proxy-addr/-/proxy-addr-1.1.4.tgz#27e545f6960a44a627d9b44467e35c1b6b4ce2f3" + dependencies: + forwarded "~0.1.0" + ipaddr.js "1.3.0" + +prr@~0.0.0: + version "0.0.0" + resolved "https://registry.yarnpkg.com/prr/-/prr-0.0.0.tgz#1a84b85908325501411853d0081ee3fa86e2926a" + +punycode@^1.4.1: + version "1.4.1" + resolved "https://registry.yarnpkg.com/punycode/-/punycode-1.4.1.tgz#c0d5a63b2718800ad8e1eb0fa5269c84dd41845e" + +qs@*, qs@^6.2.0: + version "6.5.0" + resolved "https://registry.yarnpkg.com/qs/-/qs-6.5.0.tgz#8d04954d364def3efc55b5a0793e1e2c8b1e6e49" + +qs@6.4.0, qs@~6.4.0: + version "6.4.0" + resolved "https://registry.yarnpkg.com/qs/-/qs-6.4.0.tgz#13e26d28ad6b0ffaa91312cd3bf708ed351e7233" + +randomatic@^1.1.3: + version "1.1.7" + resolved "https://registry.yarnpkg.com/randomatic/-/randomatic-1.1.7.tgz#c7abe9cc8b87c0baa876b19fde83fd464797e38c" + dependencies: + is-number "^3.0.0" + kind-of "^4.0.0" + +range-parser@~1.2.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/range-parser/-/range-parser-1.2.0.tgz#f49be6b487894ddc40dcc94a322f611092e00d5e" + +raw-body@~2.2.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/raw-body/-/raw-body-2.2.0.tgz#994976cf6a5096a41162840492f0bdc5d6e7fb96" + dependencies: + bytes "2.4.0" + iconv-lite "0.4.15" + unpipe "1.0.0" + +read-pkg-up@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/read-pkg-up/-/read-pkg-up-1.0.1.tgz#9d63c13276c065918d57f002a57f40a1b643fb02" + dependencies: + find-up "^1.0.0" + read-pkg "^1.0.0" + +read-pkg@^1.0.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/read-pkg/-/read-pkg-1.1.0.tgz#f5ffaa5ecd29cb31c0474bca7d756b6bb29e3f28" + dependencies: + load-json-file "^1.0.0" + normalize-package-data "^2.3.2" + path-type "^1.0.0" + +regenerator-runtime@^0.10.0: + version "0.10.5" + resolved "https://registry.yarnpkg.com/regenerator-runtime/-/regenerator-runtime-0.10.5.tgz#336c3efc1220adcedda2c9fab67b5a7955a33658" + +regex-cache@^0.4.2: + version "0.4.3" + resolved "https://registry.yarnpkg.com/regex-cache/-/regex-cache-0.4.3.tgz#9b1a6c35d4d0dfcef5711ae651e8e9d3d7114145" + dependencies: + is-equal-shallow "^0.1.3" + is-primitive "^2.0.0" + +remove-trailing-separator@^1.0.1: + version "1.0.2" + resolved "https://registry.yarnpkg.com/remove-trailing-separator/-/remove-trailing-separator-1.0.2.tgz#69b062d978727ad14dc6b56ba4ab772fd8d70511" + +repeat-element@^1.1.2: + version "1.1.2" + resolved "https://registry.yarnpkg.com/repeat-element/-/repeat-element-1.1.2.tgz#ef089a178d1483baae4d93eb98b4f9e4e11d990a" + +repeat-string@^1.5.2: + version "1.6.1" + resolved "https://registry.yarnpkg.com/repeat-string/-/repeat-string-1.6.1.tgz#8dcae470e1c88abc2d600fff4a776286da75e637" + +repeating@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/repeating/-/repeating-2.0.1.tgz#5214c53a926d3552707527fbab415dbc08d06dda" + dependencies: + is-finite "^1.0.0" + +request@^2.79.0: + version "2.81.0" + resolved "https://registry.yarnpkg.com/request/-/request-2.81.0.tgz#c6928946a0e06c5f8d6f8a9333469ffda46298a0" + dependencies: + aws-sign2 "~0.6.0" + aws4 "^1.2.1" + caseless "~0.12.0" + combined-stream "~1.0.5" + extend "~3.0.0" + forever-agent "~0.6.1" + form-data "~2.1.1" + har-validator "~4.2.1" + hawk "~3.1.3" + http-signature "~1.1.0" + is-typedarray "~1.0.0" + isstream "~0.1.2" + json-stringify-safe "~5.0.1" + mime-types "~2.1.7" + oauth-sign "~0.8.1" + performance-now "^0.2.0" + qs "~6.4.0" + safe-buffer "^5.0.1" + stringstream "~0.0.4" + tough-cookie "~2.3.0" + tunnel-agent "^0.6.0" + uuid "^3.0.0" + +require-directory@^2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/require-directory/-/require-directory-2.1.1.tgz#8c64ad5fd30dab1c976e2344ffe7f792a6a6df42" + +require-main-filename@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/require-main-filename/-/require-main-filename-1.0.1.tgz#97f717b69d48784f5f526a6c5aa8ffdda055a4d1" + +resolve@1.1.7: + version "1.1.7" + resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.1.7.tgz#203114d82ad2c5ed9e8e0411b3932875e889e97b" + +resolve@^1.3.2: + version "1.3.3" + resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.3.3.tgz#655907c3469a8680dc2de3a275a8fdd69691f0e5" + dependencies: + path-parse "^1.0.5" + +right-align@^0.1.1: + version "0.1.3" + resolved "https://registry.yarnpkg.com/right-align/-/right-align-0.1.3.tgz#61339b722fe6a3515689210d24e14c96148613ef" + dependencies: + align-text "^0.1.1" + +rimraf@^2.6.1: + version "2.6.1" + resolved "https://registry.yarnpkg.com/rimraf/-/rimraf-2.6.1.tgz#c2338ec643df7a1b7fe5c54fa86f57428a55f33d" + dependencies: + glob "^7.0.5" + +safe-buffer@^5.0.1: + version "5.1.1" + resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.1.1.tgz#893312af69b2123def71f57889001671eeb2c853" + +sane@~1.6.0: + version "1.6.0" + resolved "https://registry.yarnpkg.com/sane/-/sane-1.6.0.tgz#9610c452307a135d29c1fdfe2547034180c46775" + dependencies: + anymatch "^1.3.0" + exec-sh "^0.2.0" + fb-watchman "^1.8.0" + minimatch "^3.0.2" + minimist "^1.1.1" + walker "~1.0.5" + watch "~0.10.0" + +sax@^1.2.1: + version "1.2.4" + resolved "https://registry.yarnpkg.com/sax/-/sax-1.2.4.tgz#2816234e2378bddc4e5354fab5caa895df7100d9" + +"semver@2 || 3 || 4 || 5", semver@^5.3.0: + version "5.3.0" + resolved "https://registry.yarnpkg.com/semver/-/semver-5.3.0.tgz#9b2ce5d3de02d17c6012ad326aa6b4d0cf54f94f" + +send@0.15.3: + version "0.15.3" + resolved "https://registry.yarnpkg.com/send/-/send-0.15.3.tgz#5013f9f99023df50d1bd9892c19e3defd1d53309" + dependencies: + debug "2.6.7" + depd "~1.1.0" + destroy "~1.0.4" + encodeurl "~1.0.1" + escape-html "~1.0.3" + etag "~1.8.0" + fresh "0.5.0" + http-errors "~1.6.1" + mime "1.3.4" + ms "2.0.0" + on-finished "~2.3.0" + range-parser "~1.2.0" + statuses "~1.3.1" + +serve-static@1.12.3: + version "1.12.3" + resolved "https://registry.yarnpkg.com/serve-static/-/serve-static-1.12.3.tgz#9f4ba19e2f3030c547f8af99107838ec38d5b1e2" + dependencies: + encodeurl "~1.0.1" + escape-html "~1.0.3" + parseurl "~1.3.1" + send "0.15.3" + +set-blocking@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/set-blocking/-/set-blocking-2.0.0.tgz#045f9782d011ae9a6803ddd382b24392b3d890f7" + +setprototypeof@1.0.3: + version "1.0.3" + resolved "https://registry.yarnpkg.com/setprototypeof/-/setprototypeof-1.0.3.tgz#66567e37043eeb4f04d91bd658c0cbefb55b8e04" + +shellwords@^0.1.0: + version "0.1.0" + resolved "https://registry.yarnpkg.com/shellwords/-/shellwords-0.1.0.tgz#66afd47b6a12932d9071cbfd98a52e785cd0ba14" + +slash@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/slash/-/slash-1.0.0.tgz#c41f2f6c39fc16d1cd17ad4b5d896114ae470d55" + +sntp@1.x.x: + version "1.0.9" + resolved "https://registry.yarnpkg.com/sntp/-/sntp-1.0.9.tgz#6541184cc90aeea6c6e7b35e2659082443c66198" + dependencies: + hoek "2.x.x" + +source-map-support@^0.4.2: + version "0.4.15" + resolved "https://registry.yarnpkg.com/source-map-support/-/source-map-support-0.4.15.tgz#03202df65c06d2bd8c7ec2362a193056fef8d3b1" + dependencies: + source-map "^0.5.6" + +source-map@^0.4.4: + version "0.4.4" + resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.4.4.tgz#eba4f5da9c0dc999de68032d8b4f76173652036b" + dependencies: + amdefine ">=0.0.4" + +source-map@^0.5.0, source-map@^0.5.3, source-map@^0.5.6, source-map@~0.5.1: + version "0.5.6" + resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.5.6.tgz#75ce38f52bf0733c5a7f0c118d81334a2bb5f412" + +source-map@~0.2.0: + version "0.2.0" + resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.2.0.tgz#dab73fbcfc2ba819b4de03bd6f6eaa48164b3f9d" + dependencies: + amdefine ">=0.0.4" + +spdx-correct@~1.0.0: + version "1.0.2" + resolved "https://registry.yarnpkg.com/spdx-correct/-/spdx-correct-1.0.2.tgz#4b3073d933ff51f3912f03ac5519498a4150db40" + dependencies: + spdx-license-ids "^1.0.2" + +spdx-expression-parse@~1.0.0: + version "1.0.4" + resolved "https://registry.yarnpkg.com/spdx-expression-parse/-/spdx-expression-parse-1.0.4.tgz#9bdf2f20e1f40ed447fbe273266191fced51626c" + +spdx-license-ids@^1.0.2: + version "1.2.2" + resolved "https://registry.yarnpkg.com/spdx-license-ids/-/spdx-license-ids-1.2.2.tgz#c9df7a3424594ade6bd11900d596696dc06bac57" + +sprintf-js@~1.0.2: + version "1.0.3" + resolved "https://registry.yarnpkg.com/sprintf-js/-/sprintf-js-1.0.3.tgz#04e6926f662895354f3dd015203633b857297e2c" + +sshpk@^1.7.0: + version "1.13.1" + resolved "https://registry.yarnpkg.com/sshpk/-/sshpk-1.13.1.tgz#512df6da6287144316dc4c18fe1cf1d940739be3" + dependencies: + asn1 "~0.2.3" + assert-plus "^1.0.0" + dashdash "^1.12.0" + getpass "^0.1.1" + optionalDependencies: + bcrypt-pbkdf "^1.0.0" + ecc-jsbn "~0.1.1" + jsbn "~0.1.0" + tweetnacl "~0.14.0" + +"statuses@>= 1.3.1 < 2", statuses@~1.3.1: + version "1.3.1" + resolved "https://registry.yarnpkg.com/statuses/-/statuses-1.3.1.tgz#faf51b9eb74aaef3b3acf4ad5f61abf24cb7b93e" + +string-length@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/string-length/-/string-length-1.0.1.tgz#56970fb1c38558e9e70b728bf3de269ac45adfac" + dependencies: + strip-ansi "^3.0.0" + +string-width@^1.0.1, string-width@^1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/string-width/-/string-width-1.0.2.tgz#118bdf5b8cdc51a2a7e70d211e07e2b0b9b107d3" + dependencies: + code-point-at "^1.0.0" + is-fullwidth-code-point "^1.0.0" + strip-ansi "^3.0.0" + +stringstream@~0.0.4: + version "0.0.5" + resolved "https://registry.yarnpkg.com/stringstream/-/stringstream-0.0.5.tgz#4e484cd4de5a0bbbee18e46307710a8a81621878" + +strip-ansi@^3.0.0, strip-ansi@^3.0.1: + version "3.0.1" + resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-3.0.1.tgz#6a385fb8853d952d5ff05d0e8aaf94278dc63dcf" + dependencies: + ansi-regex "^2.0.0" + +strip-bom@3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/strip-bom/-/strip-bom-3.0.0.tgz#2334c18e9c759f7bdd56fdef7e9ae3d588e68ed3" + +strip-bom@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/strip-bom/-/strip-bom-2.0.0.tgz#6219a85616520491f35788bdbf1447a99c7e6b0e" + dependencies: + is-utf8 "^0.2.0" + +supports-color@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-2.0.0.tgz#535d045ce6b6363fa40117084629995e9df324c7" + +supports-color@^3.1.2: + version "3.2.3" + resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-3.2.3.tgz#65ac0504b3954171d8a64946b2ae3cbb8a5f54f6" + dependencies: + has-flag "^1.0.0" + +symbol-tree@^3.2.1: + version "3.2.2" + resolved "https://registry.yarnpkg.com/symbol-tree/-/symbol-tree-3.2.2.tgz#ae27db38f660a7ae2e1c3b7d1bc290819b8519e6" + +test-exclude@^4.1.1: + version "4.1.1" + resolved "https://registry.yarnpkg.com/test-exclude/-/test-exclude-4.1.1.tgz#4d84964b0966b0087ecc334a2ce002d3d9341e26" + dependencies: + arrify "^1.0.1" + micromatch "^2.3.11" + object-assign "^4.1.0" + read-pkg-up "^1.0.1" + require-main-filename "^1.0.1" + +throat@^3.0.0: + version "3.2.0" + resolved "https://registry.yarnpkg.com/throat/-/throat-3.2.0.tgz#50cb0670edbc40237b9e347d7e1f88e4620af836" + +tmpl@1.0.x: + version "1.0.4" + resolved "https://registry.yarnpkg.com/tmpl/-/tmpl-1.0.4.tgz#23640dd7b42d00433911140820e5cf440e521dd1" + +to-fast-properties@^1.0.1: + version "1.0.3" + resolved "https://registry.yarnpkg.com/to-fast-properties/-/to-fast-properties-1.0.3.tgz#b83571fa4d8c25b82e231b06e3a3055de4ca1a47" + +tough-cookie@^2.3.2, tough-cookie@~2.3.0: + version "2.3.2" + resolved "https://registry.yarnpkg.com/tough-cookie/-/tough-cookie-2.3.2.tgz#f081f76e4c85720e6c37a5faced737150d84072a" + dependencies: + punycode "^1.4.1" + +tr46@~0.0.3: + version "0.0.3" + resolved "https://registry.yarnpkg.com/tr46/-/tr46-0.0.3.tgz#8184fd347dac9cdc185992f3a6622e14b9d9ab6a" + +trim-right@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/trim-right/-/trim-right-1.0.1.tgz#cb2e1203067e0c8de1f614094b9fe45704ea6003" + +tunnel-agent@^0.6.0: + version "0.6.0" + resolved "https://registry.yarnpkg.com/tunnel-agent/-/tunnel-agent-0.6.0.tgz#27a5dea06b36b04a0a9966774b290868f0fc40fd" + dependencies: + safe-buffer "^5.0.1" + +tweetnacl@^0.14.3, tweetnacl@~0.14.0: + version "0.14.5" + resolved "https://registry.yarnpkg.com/tweetnacl/-/tweetnacl-0.14.5.tgz#5ae68177f192d4456269d108afa93ff8743f4f64" + +type-check@~0.3.2: + version "0.3.2" + resolved "https://registry.yarnpkg.com/type-check/-/type-check-0.3.2.tgz#5884cab512cf1d355e3fb784f30804b2b520db72" + dependencies: + prelude-ls "~1.1.2" + +type-is@~1.6.15: + version "1.6.15" + resolved "https://registry.yarnpkg.com/type-is/-/type-is-1.6.15.tgz#cab10fb4909e441c82842eafe1ad646c81804410" + dependencies: + media-typer "0.3.0" + mime-types "~2.1.15" + +uglify-js@^2.6: + version "2.8.29" + resolved "https://registry.yarnpkg.com/uglify-js/-/uglify-js-2.8.29.tgz#29c5733148057bb4e1f75df35b7a9cb72e6a59dd" + dependencies: + source-map "~0.5.1" + yargs "~3.10.0" + optionalDependencies: + uglify-to-browserify "~1.0.0" + +uglify-to-browserify@~1.0.0: + version "1.0.2" + resolved "https://registry.yarnpkg.com/uglify-to-browserify/-/uglify-to-browserify-1.0.2.tgz#6e0924d6bda6b5afe349e39a6d632850a0f882b7" + +unpipe@1.0.0, unpipe@~1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/unpipe/-/unpipe-1.0.0.tgz#b2bf4ee8514aae6165b4817829d21b2ef49904ec" + +utils-merge@1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/utils-merge/-/utils-merge-1.0.0.tgz#0294fb922bb9375153541c4f7096231f287c8af8" + +uuid@^3.0.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/uuid/-/uuid-3.1.0.tgz#3dd3d3e790abc24d7b0d3a034ffababe28ebbc04" + +validate-npm-package-license@^3.0.1: + version "3.0.1" + resolved "https://registry.yarnpkg.com/validate-npm-package-license/-/validate-npm-package-license-3.0.1.tgz#2804babe712ad3379459acfbe24746ab2c303fbc" + dependencies: + spdx-correct "~1.0.0" + spdx-expression-parse "~1.0.0" + +vary@^1, vary@~1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/vary/-/vary-1.1.1.tgz#67535ebb694c1d52257457984665323f587e8d37" + +verror@1.3.6: + version "1.3.6" + resolved "https://registry.yarnpkg.com/verror/-/verror-1.3.6.tgz#cff5df12946d297d2baaefaa2689e25be01c005c" + dependencies: + extsprintf "1.0.2" + +walker@~1.0.5: + version "1.0.7" + resolved "https://registry.yarnpkg.com/walker/-/walker-1.0.7.tgz#2f7f9b8fd10d677262b18a884e28d19618e028fb" + dependencies: + makeerror "1.0.x" + +watch@~0.10.0: + version "0.10.0" + resolved "https://registry.yarnpkg.com/watch/-/watch-0.10.0.tgz#77798b2da0f9910d595f1ace5b0c2258521f21dc" + +webidl-conversions@^3.0.0: + version "3.0.1" + resolved "https://registry.yarnpkg.com/webidl-conversions/-/webidl-conversions-3.0.1.tgz#24534275e2a7bc6be7bc86611cc16ae0a5654871" + +webidl-conversions@^4.0.0: + version "4.0.1" + resolved "https://registry.yarnpkg.com/webidl-conversions/-/webidl-conversions-4.0.1.tgz#8015a17ab83e7e1b311638486ace81da6ce206a0" + +whatwg-encoding@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/whatwg-encoding/-/whatwg-encoding-1.0.1.tgz#3c6c451a198ee7aec55b1ec61d0920c67801a5f4" + dependencies: + iconv-lite "0.4.13" + +whatwg-fetch@>=0.10.0: + version "2.0.3" + resolved "https://registry.yarnpkg.com/whatwg-fetch/-/whatwg-fetch-2.0.3.tgz#9c84ec2dcf68187ff00bc64e1274b442176e1c84" + +whatwg-url@^4.3.0: + version "4.8.0" + resolved "https://registry.yarnpkg.com/whatwg-url/-/whatwg-url-4.8.0.tgz#d2981aa9148c1e00a41c5a6131166ab4683bbcc0" + dependencies: + tr46 "~0.0.3" + webidl-conversions "^3.0.0" + +which-module@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/which-module/-/which-module-1.0.0.tgz#bba63ca861948994ff307736089e3b96026c2a4f" + +which@^1.2.12: + version "1.2.14" + resolved "https://registry.yarnpkg.com/which/-/which-1.2.14.tgz#9a87c4378f03e827cecaf1acdf56c736c01c14e5" + dependencies: + isexe "^2.0.0" + +window-size@0.1.0: + version "0.1.0" + resolved "https://registry.yarnpkg.com/window-size/-/window-size-0.1.0.tgz#5438cd2ea93b202efa3a19fe8887aee7c94f9c9d" + +wordwrap@0.0.2: + version "0.0.2" + resolved "https://registry.yarnpkg.com/wordwrap/-/wordwrap-0.0.2.tgz#b79669bb42ecb409f83d583cad52ca17eaa1643f" + +wordwrap@~0.0.2: + version "0.0.3" + resolved "https://registry.yarnpkg.com/wordwrap/-/wordwrap-0.0.3.tgz#a3d5da6cd5c0bc0008d37234bbaf1bed63059107" + +wordwrap@~1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/wordwrap/-/wordwrap-1.0.0.tgz#27584810891456a4171c8d0226441ade90cbcaeb" + +worker-farm@^1.3.1: + version "1.4.1" + resolved "https://registry.yarnpkg.com/worker-farm/-/worker-farm-1.4.1.tgz#a438bc993a7a7d133bcb6547c95eca7cff4897d8" + dependencies: + errno "^0.1.4" + xtend "^4.0.1" + +wrap-ansi@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-2.1.0.tgz#d8fc3d284dd05794fe84973caecdd1cf824fdd85" + dependencies: + string-width "^1.0.1" + strip-ansi "^3.0.1" + +wrappy@1: + version "1.0.2" + resolved "https://registry.yarnpkg.com/wrappy/-/wrappy-1.0.2.tgz#b5243d8f3ec1aa35f1364605bc0d1036e30ab69f" + +xml-name-validator@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/xml-name-validator/-/xml-name-validator-2.0.1.tgz#4d8b8f1eccd3419aa362061becef515e1e559635" + +xmlhttprequest@^1.8.0: + version "1.8.0" + resolved "https://registry.yarnpkg.com/xmlhttprequest/-/xmlhttprequest-1.8.0.tgz#67fe075c5c24fef39f9d65f5f7b7fe75171968fc" + +xtend@^4.0.1: + version "4.0.1" + resolved "https://registry.yarnpkg.com/xtend/-/xtend-4.0.1.tgz#a5c6d532be656e23db820efb943a1f04998d63af" + +y18n@^3.2.1: + version "3.2.1" + resolved "https://registry.yarnpkg.com/y18n/-/y18n-3.2.1.tgz#6d15fba884c08679c0d77e88e7759e811e07fa41" + +yargs-parser@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-5.0.0.tgz#275ecf0d7ffe05c77e64e7c86e4cd94bf0e1228a" + dependencies: + camelcase "^3.0.0" + +yargs@^7.0.2: + version "7.1.0" + resolved "https://registry.yarnpkg.com/yargs/-/yargs-7.1.0.tgz#6ba318eb16961727f5d284f8ea003e8d6154d0c8" + dependencies: + camelcase "^3.0.0" + cliui "^3.2.0" + decamelize "^1.1.1" + get-caller-file "^1.0.1" + os-locale "^1.4.0" + read-pkg-up "^1.0.1" + require-directory "^2.1.1" + require-main-filename "^1.0.1" + set-blocking "^2.0.0" + string-width "^1.0.2" + which-module "^1.0.0" + y18n "^3.2.1" + yargs-parser "^5.0.0" + +yargs@~3.10.0: + version "3.10.0" + resolved "https://registry.yarnpkg.com/yargs/-/yargs-3.10.0.tgz#f7ee7bd857dd7c1d2d38c0e74efbd681d1431fd1" + dependencies: + camelcase "^1.0.2" + cliui "^2.1.0" + decamelize "^1.0.0" + window-size "0.1.0" diff --git a/_modules/lego-cli/async.js b/_modules/lego-cli/async.js new file mode 100644 index 0000000..3ac9878 --- /dev/null +++ b/_modules/lego-cli/async.js @@ -0,0 +1 @@ +// https://github.com/MatAtBread/nodent-compiler/blob/master/lib/output.js diff --git a/_modules/lego-cli/index.js b/_modules/lego-cli/index.js new file mode 100644 index 0000000..8631cb1 --- /dev/null +++ b/_modules/lego-cli/index.js @@ -0,0 +1,54 @@ +// @TODO can also use `on-the-fly` to compile into a bundle on the fly + +// this file is just when using in dev mode so huge relative paths aren't required +const {resolve} = require('path') +const moduleAlias = require('module-alias') + +const res = rel => resolve(__dirname, rel) +moduleAlias.addPath(res('../../../')) +moduleAlias.addPath(res('../../')) +moduleAlias.addPath(res('../../src')) +moduleAlias.addPath(res('./node_modules')) + +// const CLI = require('fluent-cli') +// const File = require('file-chain') + +const {exists, read, write} = require('flipfile') +const Script = require('script-chain') +const execa = require('execa') +const find = require('chain-able-find') +const fwf = require('funwithflags') +const log = require('fliplog') +const {Chain, isUndefined} = require('chain-able') +const pkg = require('../../package.json') + +const deps = { + find, + execa, + Script, + // CLI, + resolve, + fwf, + log, + exists, + read, + write, + pkg, + Chain, + // File, + script: () => new Script(), +} + +// @TODO: needs yarn-or-npm script +/** + * @prop {string} dir directory to resolve everything to + * @type {ChainedMap} + */ +class AppCLI extends Chain { + dep(name) { + return isUndefined(name) ? deps : deps[name] + } + script() { + return new Script() + } +} diff --git a/_modules/lego-cli/plugins/ast/babel.js b/_modules/lego-cli/plugins/ast/babel.js new file mode 100644 index 0000000..d2c7b42 --- /dev/null +++ b/_modules/lego-cli/plugins/ast/babel.js @@ -0,0 +1,17 @@ +module.exports = { + /** + * @since 0.0.1 + * @tutorial https://github.com/babel + * @param {string} string code source + * @param {Object} [config=null] babel options + * @return {string} transformed babel output + */ + babel(string, config = null) { + // return new Script().add().bin('babel').raw('src/ --out-dir dist').run() + const babel = require('babel-core') + // result = babel.transform(str, {allowReturnOutsideFunction: true}); + const parsedAst = babel.parse(string, {allowReturnOutsideFunction: true}) + const {code, map, ast} = babel.transformFromAst(parsedAst, string, config) + return code + }, +} diff --git a/_modules/lego-cli/plugins/ast/buble.js b/_modules/lego-cli/plugins/ast/buble.js new file mode 100644 index 0000000..6fb5bf5 --- /dev/null +++ b/_modules/lego-cli/plugins/ast/buble.js @@ -0,0 +1,13 @@ +module.exports = { + buble() { + const sourcemaps = true + const scripts = this.script() + .add() + .bin('buble') + .raw('-i dist') + .raw('-o dist') + .raw('--no forOf,dangerousForOf,computedProperty,spreadRest') + if (sourcemaps) scripts.raw('-m inline') + return scripts.run() + }, +} diff --git a/_modules/lego-cli/plugins/ast/lebab.js b/_modules/lego-cli/plugins/ast/lebab.js new file mode 100644 index 0000000..9464b80 --- /dev/null +++ b/_modules/lego-cli/plugins/ast/lebab.js @@ -0,0 +1,647 @@ +const {resolve} = require('path') +const {execSync} = require('child_process') +const log = require('fliplog') +const lebab = require('lebab') +const {read, write, del} = require('flipfile') +const {GlobSync} = require('flipfile/glob') +const ChainedMap = require('chain-able') + +/** + * @TODO: + * - [ ] should put the transformers as middleware + * - [ ] use file-chain now that it is extracted + * - [ ] run eslint on transformed files + */ +class File { + /** + * @param {Object} obj + */ + constructor(obj) { + const {debug, abs} = obj + this.abs = abs + this._debug = !!debug + } + + /** + * reads file + * @see File.contents + * @param {boolean} [force=false] + * @return {File} + */ + load(force = false) { + if (this.contents !== undefined && force === false) { + return this + } + + this.contents = read(this.abs) + + log.blue('loaded content').data(this.abs, this.contents).echo(this._debug) + + return this + } + + del() { + del(this.abs) + return this + } + + /** + * @return {File} + */ + lebab() { + const features = ['let', 'arrow', 'commonjs', 'includes'] + const {code, warnings} = lebab.transform(this.contents, features) + + log.bold('label-ed').verbose().data({code, warnings}).echo(this._debug) + + this.contents = code + + return this + } + + /** + * @param {string} from + * @param {string} to + * @return {File} + */ + changeExtension(from, to) { + const abs = this.abs + + this.abs = this.abs.replace(from, to).replace('//', '/') + + log + .underline('changed path') + .data({from: abs, to: this.abs}) + .echo(this._debug) + + return this + } + + /** + * @param {string} from + * @param {string} to + * @return {File} + */ + changeDir(from, to) { + // const {input, temp} = dirs + + const abs = this.abs + + this.abs = this.abs.replace(from, to) + // const toDir = resolve(dir, './ts') .replace(dir, './') + + log + .underline('changed dir') + .data({before: abs, after: this.abs, from, to}) + .echo(this._debug) + + return this + } + + /** + * removes public/private/protected class properties + * since babel does not like them, currently + * + * @return {Magic} + */ + removeModifiers() { + log.blue('data').verbose().data().echo(this._debug) + + this.contents = this.contents.replace( + /( {0,4}public|private|protected )/gim, + '' + ) + + return this + } + + /** + * @return {File} + */ + write() { + const {abs, contents} = this + + log.green('writing').data({abs, contents}).echo(this._debug) + + write(abs, contents) + + return this + } +} + +class Magic extends ChainedMap { + /** + * @param {any} parent + */ + constructor(parent) { + super(parent) + + this.globs = {} + + this.files = { + js: [], + other: [], + } + + this.dirs = {} + this._debug = false + } + + /** + * @param {Boolean} [should=true] + * @return {Magic} + */ + debug(should = true) { + return this.set('debug', should) + } + + /** + * @param {string} glob + * @return {Magic} + */ + setGlob(glob) { + this.globs = { + glob, + opts: {stat: true, absolute: true}, + } + + return this + } + + /** + * @param {Object} dirs + * @return {Magic} + */ + setDirs(dirs) { + let {js, ts, temp, dist, dir} = dirs + + // if not a single folder, split n pop + // if (js.includes('/')) js = js.split('/').pop() + // if (ts.includes('/')) ts = ts.split('/').pop() + // if (temp.includes('/')) temp = temp.split('/').pop() + + // store on instance + this.dirs = {js, ts, temp, dir} + + return this + } + + /** + * @see Magic.files, Magic.globs, File + * @return {Magic} + */ + gatherFiles() { + // extract variables + const {glob, opts} = this.globs + + // do globbing + const found = new GlobSync(glob, opts).found + + const debug = this.get('debug') + + // add to instance + this.files = found.map(abs => new File({abs, debug})) + + // const otherGlob = new GlobSync(other, opts).found + // other: otherGlob + // .filter(abs => !abs.includes('.js')) + // .map(abs => new File({abs, debug})), + + return this + } + + // --- handle + + /** + * @see File.lebab + * @return {Magic} + */ + lebab() { + this.files.forEach(file => { + file.load().lebab().write() + }) + + return this + } + + /** + * @see Magic.gatherFiles, Magic.setDirs + * @return {Magic} + */ + toTypeScript() { + // clean + execSync(`rm -f -r ${this.dirs.ts}/`, {stdio: 'inherit'}) + + // copy js dir to typescript dir + execSync(`cp -R -f ${this.dirs.js} ${this.dirs.ts}/`, {stdio: 'inherit'}) + + this.setGlob(this.dirs.ts + '/**/*.js') + + return this + } + saveTypeScript() { + // then convert the js files + this.files.forEach(file => { + // file._debug = true + file + .load() + .del() // del .js, we already loaded contents + .changeExtension('.js', '.ts') + .write() + }) + } + + /** + * @see Magic.gatherFiles, Magic.setDirs + * @return {Magic} + */ + toTemp() { + // clean + execSync(`rm -f -r ${this.dirs.temp}/`, {stdio: 'inherit'}) + + // copy ts dir to temp dir + execSync(`cp -R -f ${this.dirs.ts} ${this.dirs.temp}/`, {stdio: 'inherit'}) + + this.setGlob(this.dirs.temp + '/**/*.ts') + + return this + } + saveTemp() { + this.files.forEach(file => { + file.load().del().changeExtension('.ts', '.js').removeModifiers().write() + }) + return this + } +} + +// @TODO: add options +// @TODO: also add scripts with scriptflip... +// const dirs = { +// dir: __dirname, +// js: 'test', +// ts: 'typescript', +// temp: 'temp', +// dist: 'dist', +// } + +const dirs = { + dir: __dirname, + ts: 'three/src', + temp: 'three/temp', + dist: 'three/dist', +} + +let toTypescript = false +let toTemp = false + +// toTypescript = true +// toTemp = false + +if (toTypescript !== false) { + const magic = new Magic() + + magic + .debug(false) + .setDirs(dirs) + .toTypeScript() + .gatherFiles() + .lebab() + .saveTypeScript() +} + +if (toTemp !== false) { + const magic = new Magic() + + magic.setDirs(dirs).toTemp().gatherFiles().saveTemp() +} + +if (dirs.dist) { + const execa = require('execa') + execa('babel', [dirs.temp, '--out-dir=' + dirs.dist], {stdio: 'inherit'}) +} + +module.exports = Magic + +const {resolve} = require('path') +const {execSync} = require('child_process') +const log = require('fliplog') +const lebab = require('lebab') +const {read, write, del} = require('flipfile') +const {GlobSync} = require('flipfile/glob') +const ChainedMap = require('chain-able') + +/** + * @TODO: + * - [ ] should put the transformers as middleware + * - [ ] use file-chain now that it is extracted + * - [ ] run eslint on transformed files + */ +class File { + /** + * @param {Object} obj + */ + constructor(obj) { + const {debug, abs} = obj + this.abs = abs + this._debug = !!debug + } + + /** + * reads file + * @see File.contents + * @param {boolean} [force=false] + * @return {File} + */ + load(force = false) { + if (this.contents !== undefined && force === false) { + return this + } + + this.contents = read(this.abs) + + log.blue('loaded content').data(this.abs, this.contents).echo(this._debug) + + return this + } + + del() { + del(this.abs) + return this + } + + /** + * @return {File} + */ + lebab() { + const features = ['let', 'arrow', 'commonjs', 'includes'] + const {code, warnings} = lebab.transform(this.contents, features) + + log.bold('label-ed').verbose().data({code, warnings}).echo(this._debug) + + this.contents = code + + return this + } + + /** + * @param {string} from + * @param {string} to + * @return {File} + */ + changeExtension(from, to) { + const abs = this.abs + + this.abs = this.abs.replace(from, to).replace('//', '/') + + log + .underline('changed path') + .data({from: abs, to: this.abs}) + .echo(this._debug) + + return this + } + + /** + * @param {string} from + * @param {string} to + * @return {File} + */ + changeDir(from, to) { + // const {input, temp} = dirs + + const abs = this.abs + + this.abs = this.abs.replace(from, to) + // const toDir = resolve(dir, './ts') .replace(dir, './') + + log + .underline('changed dir') + .data({before: abs, after: this.abs, from, to}) + .echo(this._debug) + + return this + } + + /** + * removes public/private/protected class properties + * since babel does not like them, currently + * + * @return {Magic} + */ + removeModifiers() { + log.blue('data').verbose().data().echo(this._debug) + + this.contents = this.contents.replace( + /( {0,4}public|private|protected )/gim, + '' + ) + + return this + } + + /** + * @return {File} + */ + write() { + const {abs, contents} = this + + log.green('writing').data({abs, contents}).echo(this._debug) + + write(abs, contents) + + return this + } +} + +class Magic extends ChainedMap { + /** + * @param {any} parent + */ + constructor(parent) { + super(parent) + + this.globs = {} + + this.files = { + js: [], + other: [], + } + + this.dirs = {} + this._debug = false + } + + /** + * @param {Boolean} [should=true] + * @return {Magic} + */ + debug(should = true) { + return this.set('debug', should) + } + + /** + * @param {string} glob + * @return {Magic} + */ + setGlob(glob) { + this.globs = { + glob, + opts: {stat: true, absolute: true}, + } + + return this + } + + /** + * @param {Object} dirs + * @return {Magic} + */ + setDirs(dirs) { + let {js, ts, temp, dist, dir} = dirs + + // if not a single folder, split n pop + // if (js.includes('/')) js = js.split('/').pop() + // if (ts.includes('/')) ts = ts.split('/').pop() + // if (temp.includes('/')) temp = temp.split('/').pop() + + // store on instance + this.dirs = {js, ts, temp, dir} + + return this + } + + /** + * @see Magic.files, Magic.globs, File + * @return {Magic} + */ + gatherFiles() { + // extract variables + const {glob, opts} = this.globs + + // do globbing + const found = new GlobSync(glob, opts).found + + const debug = this.get('debug') + + // add to instance + this.files = found.map(abs => new File({abs, debug})) + + // const otherGlob = new GlobSync(other, opts).found + // other: otherGlob + // .filter(abs => !abs.includes('.js')) + // .map(abs => new File({abs, debug})), + + return this + } + + // --- handle + + /** + * @see File.lebab + * @return {Magic} + */ + lebab() { + this.files.forEach(file => { + file.load().lebab().write() + }) + + return this + } + + /** + * @see Magic.gatherFiles, Magic.setDirs + * @return {Magic} + */ + toTypeScript() { + // clean + execSync(`rm -f -r ${this.dirs.ts}/`, {stdio: 'inherit'}) + + // copy js dir to typescript dir + execSync(`cp -R -f ${this.dirs.js} ${this.dirs.ts}/`, {stdio: 'inherit'}) + + this.setGlob(this.dirs.ts + '/**/*.js') + + return this + } + saveTypeScript() { + // then convert the js files + this.files.forEach(file => { + // file._debug = true + file + .load() + .del() // del .js, we already loaded contents + .changeExtension('.js', '.ts') + .write() + }) + } + + /** + * @see Magic.gatherFiles, Magic.setDirs + * @return {Magic} + */ + toTemp() { + // clean + execSync(`rm -f -r ${this.dirs.temp}/`, {stdio: 'inherit'}) + + // copy ts dir to temp dir + execSync(`cp -R -f ${this.dirs.ts} ${this.dirs.temp}/`, {stdio: 'inherit'}) + + this.setGlob(this.dirs.temp + '/**/*.ts') + + return this + } + saveTemp() { + this.files.forEach(file => { + file.load().del().changeExtension('.ts', '.js').removeModifiers().write() + }) + return this + } +} + +// @TODO: add options +// @TODO: also add scripts with scriptflip... +// const dirs = { +// dir: __dirname, +// js: 'test', +// ts: 'typescript', +// temp: 'temp', +// dist: 'dist', +// } + +const dirs = { + dir: __dirname, + ts: 'three/src', + temp: 'three/temp', + dist: 'three/dist', +} + +let toTypescript = false +let toTemp = false + +// toTypescript = true +// toTemp = false + +if (toTypescript !== false) { + const magic = new Magic() + + magic + .debug(false) + .setDirs(dirs) + .toTypeScript() + .gatherFiles() + .lebab() + .saveTypeScript() +} + +if (toTemp !== false) { + const magic = new Magic() + + magic.setDirs(dirs).toTemp().gatherFiles().saveTemp() +} + +if (dirs.dist) { + const execa = require('execa') + execa('babel', [dirs.temp, '--out-dir=' + dirs.dist], {stdio: 'inherit'}) +} + +module.exports = Magic diff --git a/_modules/lego-cli/plugins/ast/typescript.js b/_modules/lego-cli/plugins/ast/typescript.js new file mode 100644 index 0000000..800d811 --- /dev/null +++ b/_modules/lego-cli/plugins/ast/typescript.js @@ -0,0 +1,25 @@ +module.exports = { + ts(TSC_SOURCE, TSC_OUT) { + const {read, write} = this.dep() + const ts = require('typescript') + const source = read(TSC_SOURCE) + + let result = ts.transpileModule(source, { + compilerOptions: {module: ts.ModuleKind.CommonJS}, + }) + write(require.resolve(TSC_OUT), result.outputText) + + console.log(JSON.stringify(result)) + process.exit() + }, + tsc(buildTests = false) { + const {script} = this.dep() + + if (buildTests) { + const flags = + '--pretty --sourceMap --allowJs --project test --outDir test-dist' + return script('tsc', flags) + } + return script('tsc') + }, +} diff --git a/_modules/lego-cli/plugins/bundle/browserify.js b/_modules/lego-cli/plugins/bundle/browserify.js new file mode 100644 index 0000000..431d841 --- /dev/null +++ b/_modules/lego-cli/plugins/bundle/browserify.js @@ -0,0 +1,6 @@ +module.exports = { + name: 'browserify', + browserify() { + // browserify src -o dists/browserified/index.js + }, +} diff --git a/_modules/lego-cli/plugins/bundle/optimizejs.js b/_modules/lego-cli/plugins/bundle/optimizejs.js new file mode 100644 index 0000000..8626bc8 --- /dev/null +++ b/_modules/lego-cli/plugins/bundle/optimizejs.js @@ -0,0 +1,16 @@ +module.exports = { + name: 'optimizejs', + + /** + * @since 0.0.1 + * @tutorial https://github.com/nolanlawson/optimize-js + * @param {string} input + * @return {string} optimized output + */ + optimize(input) { + const optimizeJs = require('optimize-js') + return optimizeJs(input, { + sourceMap: true, + }) + }, +} diff --git a/_modules/lego-cli/plugins/bundle/rollup.js b/_modules/lego-cli/plugins/bundle/rollup.js new file mode 100644 index 0000000..35b5587 --- /dev/null +++ b/_modules/lego-cli/plugins/bundle/rollup.js @@ -0,0 +1,14 @@ +module.exports = { + name: 'rollup', + + rollup(flags = '', ROLLUP_CONFIG_CLI) { + if (Array.isArray(flags)) return flags.map(flag => this.rollup(flag)) + const config = ROLLUP_CONFIG_CLI + const {script} = this.dep() + + return script('rollup', '-c ' + require.resolve(config) + ' ' + flags) + }, + rollupNode(buildFile = './build', overrides = {}) { + return require(buildFile)(overrides) + }, +} diff --git a/_modules/lego-cli/plugins/docs/README.md b/_modules/lego-cli/plugins/docs/README.md new file mode 100644 index 0000000..5257695 --- /dev/null +++ b/_modules/lego-cli/plugins/docs/README.md @@ -0,0 +1 @@ +https://github.com/jsdoc3/jsdoc/issues/250 diff --git a/_modules/lego-cli/plugins/docs/doctrine.js b/_modules/lego-cli/plugins/docs/doctrine.js new file mode 100644 index 0000000..c7ef175 --- /dev/null +++ b/_modules/lego-cli/plugins/docs/doctrine.js @@ -0,0 +1,165 @@ +var doctrineAPI = require('doctrine') + +var parsed = doctrineAPI.parse( + [ + ` + /** + * @classdesc this is to avoid circular requires + * because MergeChain & MethodChain extend this + * yet .method & .merge use those chains + * + * @since 4.0.0-alpha.1 + * @inheritdoc + * @class ChainedMapBase + * @member ChainedMapBase + * @category Chainable + * @extends {Chainable} + * @type {Chainable} + * + * @types ChainedMapBase + * @tests ChainedMap + * + * @prop {Meta} meta + * @prop {Map} store + * + * {@link https://ponyfoo.com/articles/es6-maps-in-depth pony-map} + * {@link https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Map mozilla-map} + * @see {@link pony-map} + * @see {@link mozilla-map} + * + * @see ChainedMap + * @see Chainable + * @see MergeChain + * @see MethodChain + * @see ChainedMap + * + */ + `, + ` + /** + * @param {*} x value + * @return {boolean} isDate + * + * @since 3.0.0 + * @memberOf is + * @func isDate + * + * @example + * + * isDate(new Date()) + * //=> true + * isDate(Date.now()) + * //=> false + * isDate(1) + * //=> false + * isDate('') + * //=> false + * + * @example + * + * const e = {} + * eh[Symbol.toStringTag] = '[Object Date]' + * isDate(eh) + * //=> true + * + * @example + * + * class Eh extends Date() + * isDate(new Eh()) + * //=> true + */ + `, + // '/**', + // ' * This function comment is parsed by doctrine', + // ' * @param {{ok:String}} userName', + // '*/', + ].join('\n'), + {unwrap: true} +) + +var ast = { + description: '/**', + tags: [ + { + title: 'classdesc', + description: + 'this is to avoid circular requires\n because MergeChain & MethodChain extend this\n yet .method & .merge use those chains', + }, + {title: 'since', description: '4.0.0-alpha.1'}, + {title: 'inheritdoc', description: null}, + { + title: 'class', + description: null, + type: null, + name: 'ChainedMapBase', + }, + { + title: 'member', + description: null, + type: null, + name: 'ChainedMapBase', + }, + {title: 'category', description: 'Chainable'}, + { + title: 'extends', + description: null, + type: {type: 'NameExpression', name: 'Chainable'}, + name: null, + }, + { + title: 'type', + description: null, + type: {type: 'NameExpression', name: 'Chainable'}, + }, + {title: 'types', description: 'ChainedMapBase'}, + {title: 'tests', description: 'ChainedMap'}, + { + title: 'prop', + description: null, + type: {type: 'NameExpression', name: 'Meta'}, + name: 'meta', + }, + { + title: 'prop', + description: + '{@link https://ponyfoo.com/articles/es6-maps-in-depth pony-map}\n{@link https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Map mozilla-map}', + type: {type: 'NameExpression', name: 'Map'}, + name: 'store', + }, + {title: 'see', description: '{@link pony-map}'}, + {title: 'see', description: '{@link mozilla-map}'}, + {title: 'see', description: 'ChainedMap'}, + {title: 'see', description: 'Chainable'}, + {title: 'see', description: 'MergeChain'}, + {title: 'see', description: 'MethodChain'}, + {title: 'see', description: 'ChainedMap\n\n/\n\n\n/**'}, + { + title: 'param', + description: 'value', + type: {type: 'AllLiteral'}, + name: 'x', + }, + { + title: 'return', + description: 'isDate', + type: {type: 'NameExpression', name: 'boolean'}, + }, + {title: 'since', description: '3.0.0'}, + {title: 'memberOf', description: 'is'}, + {title: 'func', description: null, name: 'isDate'}, + { + title: 'example', + description: + 'isDate(new Date())\n //=> true\n isDate(Date.now())\n //=> false\n isDate(1)\n //=> false\n isDate(\'\')\n //=> false', + }, + { + title: 'example', + description: + 'const e = {}\n eh[Symbol.toStringTag] = \'[Object Date]\'\n isDate(eh)\n //=> true', + }, + { + title: 'example', + description: 'class Eh extends Date()\n isDate(new Eh())\n //=> true\n/', + }, + ], +} diff --git a/_modules/lego-cli/plugins/docs/dox.js b/_modules/lego-cli/plugins/docs/dox.js new file mode 100644 index 0000000..5a3d7b6 --- /dev/null +++ b/_modules/lego-cli/plugins/docs/dox.js @@ -0,0 +1,53 @@ +// const dox = require('dox') +const dox = require('../../../../_modules/_dox') +const log = require('fliplog') + +const docblock = ` +/** + * @classdesc this is to avoid circular requires + * because MergeChain & MethodChain extend this + * yet .method & .merge use those chains + * + * @since 4.0.0-alpha.1 + * @inheritdoc + * @class ChainedMapBase + * @member ChainedMapBase + * @category Chainable + * @extends {Chainable} + * @type {Chainable} + * + * @types ChainedMapBase + * @tests ChainedMap + * + * @prop {Meta} meta + * @prop {Map} store + * + * {@link https://ponyfoo.com/articles/es6-maps-in-depth pony-map} + * {@link https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Map mozilla-map} + * @see {@link pony-map} + * @see {@link mozilla-map} + * + * @see ChainedMap + * @see Chainable + * @see MergeChain + * @see MethodChain + * @see ChainedMap + * + */ +// function eh() {} +` + +/** + * + */ +function doxPlugin() { + const files = [docblock] + files.forEach(file => { + const obj = dox.parseComments(file) + log.json({obj}).echo() + }) + + return this +} + +doxPlugin() diff --git a/_modules/lego-cli/plugins/docs/doxdox.js b/_modules/lego-cli/plugins/docs/doxdox.js new file mode 100644 index 0000000..78ce5bd --- /dev/null +++ b/_modules/lego-cli/plugins/docs/doxdox.js @@ -0,0 +1,70 @@ +module.exports = { + /** + * https://github.com/nhnent/tui.jsdoc-template + * @param {Array} files + * @return {AppCli} @chainable + */ + doxdox(files) { + console.log( + 'had issue with requiring absolute before, but should be fixed in latest' + ) + console.log( + `doxdox 'src/**/*.js' --layout markdown --output docs/doxdox.md` + ) + return this + // jsdoc2md --config=jsdoc.json + // jsdoc2md --source src --config=jsdoc.json + // https://github.com/jsdoc3/jsdoc/blob/master/lib/jsdoc/env.js + // https://github.com/jsdoc3/jsdoc/blob/master/cli.js + // jsdoc src --recurse --template='node_modules/tui-jsdoc-template' --destination='docgen' --readme='README.md' ENV.conf.plugins="['node_modules/jsdoc-babel', 'plugins/markdown']" + // jsdoc --include 'src' --recurse --template='node_modules/tui-jsdoc-template' --destination='docgen' --readme='README.md' + // + // --template 'node_modules/tui-jsdoc-template' + // jsdoc src --recurse --destination 'docgen' + // + // require('fliplog').trackConsole(); + // + // * @module jsdoc/opts/args + // * @requires jsdoc/opts/argparser + // + // + // ./jsdoc/jsdoc src --recurse --destination 'docgen' --plugins "node_modules/jsdoc-babel,plugins/markdown" + // node ./node_modules/jsdoc/jsdoc src --recurse --destination 'docgen' --plugins "node_modules/jsdoc-babel,node_modules/jsdoc/plugins/markdown.js" + + // const doxdox = require('doxdox') + const doxdox = require('../../../nofundocs/doxdox') + files = this.docFiles(files) + + log + .data({ + files, + config: { + // parser: 'dox', + // layout: 'Markdown', + pkg: this.pkgjson, + }, + }) + .echo() + + log.white('files: ').data(files).echo() + + // stupid paths + doxdox + .parseInputs(files, { + // parser: 'dox', + // layout: 'markdown', + parser: require.resolve('doxdox-parser-dox').replace(process.cwd(), ''), + layout: require + .resolve('doxdox-plugin-markdown') + .replace(process.cwd(), ''), + pkg: this.pkgjson, + }) + .then(content => { + log.cyan('writing docs').echo() + log.white('content: ' + content).echo() + File.src('./docs/docs.md', this.dir).setContent(content).write() + }) + + return this + }, +} diff --git a/_modules/lego-cli/plugins/docs/esdoc.js b/_modules/lego-cli/plugins/docs/esdoc.js new file mode 100644 index 0000000..93f2487 --- /dev/null +++ b/_modules/lego-cli/plugins/docs/esdoc.js @@ -0,0 +1,9 @@ +module.exports = { + /** + * https://github.com/esdoc/esdoc + * https://github.com/jsdoc3/jsdoc/issues/833 + * http://stackoverflow.com/questions/25314979/documenting-side-effects-of-javascript-methods + * https://github.com/google/closure-compiler/wiki/Annotating-JavaScript-for-the-Closure-Compiler#nosideeffects-modifies-thisarguments + */ + esdoc() {}, +} diff --git a/_modules/lego-cli/plugins/docs/flowdoc.js b/_modules/lego-cli/plugins/docs/flowdoc.js new file mode 100644 index 0000000..8ce76e8 --- /dev/null +++ b/_modules/lego-cli/plugins/docs/flowdoc.js @@ -0,0 +1,25 @@ +module.exports = { + name: 'flowdocs', + /** + * @since 0.0.1 + * https://github.com/Kegsay/flow-jsdoc + * @desc jsdocs with flow support + * @param {Array} files + * @return {AppCli} @chainable + */ + flowdocs(files) { + files = this.docFiles(files) + + const babel = require('babel-core') + files.forEach(file => { + const {code} = babel.transform('code', { + plugins: ['jsdoc'], + }) + const content = code + + log.cyan('writing docs').echo() + log.white('content: ' + content).data(file).echo() + }) + return this + }, +} diff --git a/_modules/lego-cli/plugins/docs/jsdoc.js b/_modules/lego-cli/plugins/docs/jsdoc.js new file mode 100644 index 0000000..ee56dd8 --- /dev/null +++ b/_modules/lego-cli/plugins/docs/jsdoc.js @@ -0,0 +1,26 @@ +module.exports = { + /** + * @since 0.0.1 + * @see https://github.com/nhnent/tui.jsdoc-template + * @param {Array} files + * @return {AppCli} @chainable + */ + jsdocs(files) { + files = this.docFiles(files) + + const jsdoc = require('jsdoc-api') + let jsdocOpts = this.getPkg().jsdoc || this.getPkg().jsdocs + + if (!jsdocOpts && exists(resolve(this.dir, './jsdoc.js'))) { + jsdocOpts = require(resolve(this.dir, './jsdoc.js')) // eslint-disable-line + } + if (!jsdocOpts && exists(resolve(this.dir, './jsdoc.json'))) { + jsdocOpts = require(resolve(this.dir, './jsdoc.json')) // eslint-disable-line + } + + jsdocOpts.files = files + log.data({jsdocOpts}).text('jsdoc opts').echo() + jsdoc.explainSync(jsdocOpts) + return this + }, +} diff --git a/_modules/lego-cli/plugins/docs/jsdoc2md.js b/_modules/lego-cli/plugins/docs/jsdoc2md.js new file mode 100644 index 0000000..d8956c7 --- /dev/null +++ b/_modules/lego-cli/plugins/docs/jsdoc2md.js @@ -0,0 +1,16 @@ +module.exports = { + /** + * @since 0.0.1 + * @param {Array} pattern array of glob patterns + * @return {AppCli} @chainable + */ + jsdoc2md(pattern = ['disted/**/*.js']) { + const {log} = this.deps() + const jsdoc2md = require('jsdoc-to-markdown') + + const docs = jsdoc2md.renderSync({files: pattern}) + log.quick(docs) + + return this + }, +} diff --git a/_modules/lego-cli/plugins/docs/jsdox.js b/_modules/lego-cli/plugins/docs/jsdox.js new file mode 100644 index 0000000..a926251 --- /dev/null +++ b/_modules/lego-cli/plugins/docs/jsdox.js @@ -0,0 +1,17 @@ +module.exports = { + /** + * @tutorial http://jsdox.org/ + * @param {Array} files + * @return {AppCli} @chainable + */ + jsdox(files) { + const jsdox = require('jsdox') + + files.forEach(file => { + // , templateDir, cb, fileCb + jsdox.generateForDir(file, this.getPkg().folders.docs || 'docgen') + }) + + return this + }, +} diff --git a/_modules/lego-cli/plugins/docs/tsdoc.js b/_modules/lego-cli/plugins/docs/tsdoc.js new file mode 100644 index 0000000..666075d --- /dev/null +++ b/_modules/lego-cli/plugins/docs/tsdoc.js @@ -0,0 +1,13 @@ +module.exports = { + /** + * @TODO `typedoc --exclude 'loader/LoaderAPI.ts' --target es6 --excludeExternals --includeDeclarations --out tsdox src` + * @since 0.0.1 + * @see https://www.npmjs.com/package/tsd-jsdoc + * @see http://ts2jsdoc.js.org/ + * @param {Array} files + * @return {AppCli} @chainable + */ + tsdocs(files) { + return this + }, +} diff --git a/_modules/lego-cli/plugins/fs/copy.js b/_modules/lego-cli/plugins/fs/copy.js new file mode 100644 index 0000000..b6c7131 --- /dev/null +++ b/_modules/lego-cli/plugins/fs/copy.js @@ -0,0 +1,36 @@ +module.exports = { + /* prettier-ignore */ + copy(root = false) { + const script = this.deps().script + + // @TODO: dist & root (does it ever need to be in dist except for buble?) + const scripts = script() + .add() + .bin('flow-remove-types') + .raw('src/') + .flag('pretty') + .flag('quiet') + .flag('all') + .flag('out-dir') + .arg('./dist') + + if (root) { + scripts + .add() + .bin('flow-remove-types') + .raw('src/' + .flag('pretty') + .flag('quiet') + .flag('all') + .flag('out-dir') + .arg('./') + } + + scripts.remember = { + start() {}, + finish() {}, + } + + scripts.toString() + } +} diff --git a/_modules/lego-cli/plugins/fs/find.js b/_modules/lego-cli/plugins/fs/find.js new file mode 100644 index 0000000..c2b0678 --- /dev/null +++ b/_modules/lego-cli/plugins/fs/find.js @@ -0,0 +1,35 @@ +module.exports = { + /** + * @since 0.0.1 + * @desc finds docfiles using a glob + * @param {Array} pattern array of glob patterns + * @return {Array} file + */ + docFiles(pattern = ['disted/**/*.js']) { + const {log, globby, find} = this.deps() + + if (Array.isArray(pattern) === false) { + // pattern = ['disted/**/*.js'] + pattern = [pattern] + } + log.blue('docs pattern').json({pattern, dir: this.dir}).echo(true) + + const files = globby.sync(pattern, { + cwd: this.dir, + absolute: true, + }) + + return files + }, + + /** + * @since 0.0.1 + * @param {Array} pattern array of glob patterns + * @return {AppCli} @chainable + */ + docs(pattern = ['disted/**/*.js']) { + this.doxdox([pattern]) + // this.docFiles(pattern) + return this + }, +} diff --git a/_modules/lego-cli/plugins/generate/doc-to-assert.js b/_modules/lego-cli/plugins/generate/doc-to-assert.js new file mode 100644 index 0000000..ef89066 --- /dev/null +++ b/_modules/lego-cli/plugins/generate/doc-to-assert.js @@ -0,0 +1 @@ +// https://www.npmjs.com/package/jsdoc-to-assert diff --git a/_modules/lego-cli/plugins/generate/dojo.js b/_modules/lego-cli/plugins/generate/dojo.js new file mode 100644 index 0000000..1b9c32e --- /dev/null +++ b/_modules/lego-cli/plugins/generate/dojo.js @@ -0,0 +1 @@ +// https://github.com/dojo/meta diff --git a/_modules/lego-cli/plugins/generate/skeleton.js b/_modules/lego-cli/plugins/generate/skeleton.js new file mode 100644 index 0000000..35439c2 --- /dev/null +++ b/_modules/lego-cli/plugins/generate/skeleton.js @@ -0,0 +1,21 @@ +module.exports = { + /** + * @since 0.0.1 + * @desc regenerate interactively + * @return {AppCLI} @chainable + */ + skeleton() { + const gen = require('../interactive/interactive') + gen(this.dir) + return this + }, + + /** + * @since 0.0.1 + * @param {string} dir + * @return {AppCLI} @chainable + */ + // static init(dir) { + // return new AppCLI(dir) + // } +} diff --git a/_modules/lego-cli/plugins/lint/autofix.js b/_modules/lego-cli/plugins/lint/autofix.js new file mode 100644 index 0000000..41eb25d --- /dev/null +++ b/_modules/lego-cli/plugins/lint/autofix.js @@ -0,0 +1,104 @@ +const {resolve} = require('path') +const {read, write, isDir} = require('flipfile') +const globby = require('globby') +const log = require('fliplog') + +class CLI { + constructor(dir) { + this.dir = dir + } + + find(pattern = ['src/**/*.js', '!node_modules']) { + this.found = globby.sync(pattern, { + cwd: this.dir, + absolute: true, + }) + return this.found + } + + mapFiles() { + const mapped = this.found + .map(abs => { + if (isDir(abs)) return null + return { + source: read(abs), + filename: abs, + } + }) + .filter(file => file) + .map(file => ({source: this.prettier(file), abs: file.abs})) + .map(file => this.eslint(file)) + log.quick(mapped) + } + + eslint(file, config = require('../../.eslintrc.js')) { + const {source, filename} = file + const eslint = require('eslint') + const {linter} = eslint + + const colored = log.colored(source, 'cyan') + log.cyan('before\n').data(colored).echo() // "var foo = bar;" + + const messages = linter.verify(source, config, {filename}) + const code = linter.getSourceCode() + + log.yellow('messages').data(messages).echo() + if (!code || !code.text) { + log.red('could not handle this file ').data({filename}).echo() + return source + } + // log.yellow('code').fmtobj(code).echo() + log.blue(code.text).echo() // "var foo = bar;" + return code.text + } + + /** + * @since 0.0.1 + * @tutorial https://github.com/prettier/prettier + * @param {string} code + * @param {Object} [config=null] prettier options + * @return {string} prettified output + */ + prettier(file, config = null) { + const {filename, source} = file + const prettier = require('prettier') + + return prettier.format(source, { + // Indent lines with tabs + useTabs: false, + + // Fit code within this line limit + printWidth: 80, + + // Number of spaces it should use per tab + tabWidth: 2, + + // If true, will use single instead of double quotes + singleQuote: true, + + // Controls the printing of trailing commas wherever possible. Valid options: + // "none" - No trailing commas + // "es5" - Trailing commas where valid in ES5 (objects, arrays, etc) + // "all" - Trailing commas wherever possible (function arguments) + trailingComma: 'es5', + + // Controls the printing of spaces inside object literals + bracketSpacing: true, + + // If true, puts the `>` of a multi-line jsx element at the end of + // the last line instead of being alone on the next line + jsxBracketSameLine: false, + + // Which parser to use. Valid options are "flow" and "babylon" + parser: 'babylon', + + // Whether to add a semicolon at the end of every line (semi: true), + // or only at the beginning of lines that may introduce ASI failures (semi: false) + semi: false, + }) + } +} + +const cli = new CLI(resolve('../../')) +cli.find() +cli.mapFiles() diff --git a/_modules/lego-cli/plugins/lint/prettier.js b/_modules/lego-cli/plugins/lint/prettier.js new file mode 100644 index 0000000..348b536 --- /dev/null +++ b/_modules/lego-cli/plugins/lint/prettier.js @@ -0,0 +1,46 @@ +module.exports = { + /** + * @since 0.0.1 + * @tutorial https://github.com/prettier/prettier + * @param {string} code + * @param {Object} [config=null] prettier options + * @return {string} prettified output + */ + prettier(code, config = null) { + const prettier = require('prettier') + + return prettier.format(code, { + // Indent lines with tabs + useTabs: false, + + // Fit code within this line limit + printWidth: 80, + + // Number of spaces it should use per tab + tabWidth: 2, + + // If true, will use single instead of double quotes + singleQuote: true, + + // Controls the printing of trailing commas wherever possible. Valid options: + // "none" - No trailing commas + // "es5" - Trailing commas where valid in ES5 (objects, arrays, etc) + // "all" - Trailing commas wherever possible (function arguments) + trailingComma: 'es5', + + // Controls the printing of spaces inside object literals + bracketSpacing: true, + + // If true, puts the `>` of a multi-line jsx element at the end of + // the last line instead of being alone on the next line + jsxBracketSameLine: false, + + // Which parser to use. Valid options are "flow" and "babylon" + parser: 'babylon', + + // Whether to add a semicolon at the end of every line (semi: true), + // or only at the beginning of lines that may introduce ASI failures (semi: false) + semi: false, + }) + }, +} diff --git a/_modules/lego-cli/plugins/make/Makefile.1 b/_modules/lego-cli/plugins/make/Makefile.1 new file mode 100644 index 0000000..31e74c4 --- /dev/null +++ b/_modules/lego-cli/plugins/make/Makefile.1 @@ -0,0 +1,17 @@ +GITBOOK = node_modules/.bin/gitbook +JSDOC = node_modules/.bin/jsdoc +LESS = node_modules/.bin/lessc + + +JSDOC_FILES := $(shell find jsdoc -type f | sort) +LESS_FILES := $(shell find less -name '*.less' | sort) + +docs/%: $(VERSION)/docs/% + mkdir -p '$(@D)' + cp '$<' '$@' + +.PHONY: gitbook +gitbook: check-version + $(GITBOOK) build manual './manual' + find './manual' -name '*.html' -print0 \ + | xargs -0 perl -p -i -e 's/ data-revision="[^"]*"//g' diff --git a/_modules/lego-cli/plugins/minify/butternut.js b/_modules/lego-cli/plugins/minify/butternut.js new file mode 100644 index 0000000..f1bcba3 --- /dev/null +++ b/_modules/lego-cli/plugins/minify/butternut.js @@ -0,0 +1 @@ +// https://github.com/Rich-Harris/butternut diff --git a/_modules/lego-cli/plugins/scripts/argv.js b/_modules/lego-cli/plugins/scripts/argv.js new file mode 100644 index 0000000..38ab238 --- /dev/null +++ b/_modules/lego-cli/plugins/scripts/argv.js @@ -0,0 +1,52 @@ +const argvs = fwf(process.argv.slice(2)) + +/** + * http://blog.millermedeiros.com/inline-docs/ + * http://dailyjs.com/post/framework-part-46 + * https://documentjs.com/docs/index.html (too old) + * + * @see https://github.com/yeoman/generator/blob/master/jsdoc.json + * @desc takes in argv, calls method on CLI + * @param {AppCli} cli + * @return {void} + * @type {Function} + */ +function handle(cli) { + log.registerCatch() + + delete argvs._ + + const argv = Object.values(argvs) + const argk = Object.keys(argvs) + + log.emoji('flag').cyan('argv/flags:').data(argvs).echo() + + argk.forEach((method, i) => { + const val = argv[i] + log.emoji('phone').blue('cli: ' + method).data(val).echo(true) + + if (cli[method]) { + cli[method](val, argvs) + } + else { + log.emoji('find').blue('no method for: ' + method).data(val).echo(true) + } + }) +} + + + + +// --- docs --- + + + + +/** + * @since 0.0.1 + * @return {AppCli} @chainable + */ +handle() { + handle(this) + return this +} diff --git a/_modules/lego-cli/plugins/scripts/cmd.js b/_modules/lego-cli/plugins/scripts/cmd.js new file mode 100644 index 0000000..0aaea89 --- /dev/null +++ b/_modules/lego-cli/plugins/scripts/cmd.js @@ -0,0 +1,11 @@ +module.exports = { + /** + * @since 0.0.1 + * @param {ChainedMap | *} parent + */ + constructor(parent) { + super(parent) + + this.scriptChain = () => new Script() + }, +} diff --git a/_modules/lego-cli/plugins/scripts/npm.js b/_modules/lego-cli/plugins/scripts/npm.js new file mode 100644 index 0000000..378759a --- /dev/null +++ b/_modules/lego-cli/plugins/scripts/npm.js @@ -0,0 +1,15 @@ +module.exports = { + /** + * @since 0.0.1 + * @param {any} names npm scripts to run + * @return {CLI} @chainable + */ + npm(names = null) { + const scripts = this.scriptChain().debug(false) + + toarr(names).forEach(name => scripts.add().npm(name)) + scripts.run() + + return this + }, +} diff --git a/_modules/lego-cli/plugins/scripts/open.js b/_modules/lego-cli/plugins/scripts/open.js new file mode 100644 index 0000000..6d29164 --- /dev/null +++ b/_modules/lego-cli/plugins/scripts/open.js @@ -0,0 +1,6 @@ +module.exports = { + // https://github.com/sindresorhus/open-editor + openFile(files, editor = 'atom') { + require('open-editor')(files) + }, +} diff --git a/_modules/lego-cli/plugins/scripts/pkg.js b/_modules/lego-cli/plugins/scripts/pkg.js new file mode 100644 index 0000000..ad07582 --- /dev/null +++ b/_modules/lego-cli/plugins/scripts/pkg.js @@ -0,0 +1,33 @@ +module.exports = { + /** + * @since 0.0.1 + * @desc requires pkgjson using this.dir + * @return {AppCLI} @chainable + */ + setup() { + const pkgPath = resolve(this.dir, './package.json') + + log.green('pkg: ').data({pkgPath, dir: this.dir}).echo(this.get('debug')) + + // eslint-disable-next-line + this.pkgjson = require(pkgPath) + + return this + }, + + /** + * @protected + * @since 0.0.1 + * @see this.setup + * @desc regenerate interactively + * @return {AppCLI} @chainable + */ + getPkg() { + if (!this.pkgjson) this.setup() + + // defaults + if (!this.pkgjson) this.pkgjson.folders = {} + + return this.pkgjson + }, +} diff --git a/_modules/lego-cli/plugins/scripts/test.js b/_modules/lego-cli/plugins/scripts/test.js new file mode 100644 index 0000000..f9c4a0c --- /dev/null +++ b/_modules/lego-cli/plugins/scripts/test.js @@ -0,0 +1,6 @@ +module.exports = { + test(built = false) { + return script('ava', !built ? '--verbose' : 'test-dist/built.js') + // return script('test') + }, +} diff --git a/_modules/lego-cli/plugins/scripts/yarn.js b/_modules/lego-cli/plugins/scripts/yarn.js new file mode 100644 index 0000000..ac20470 --- /dev/null +++ b/_modules/lego-cli/plugins/scripts/yarn.js @@ -0,0 +1 @@ +console.log('todo') diff --git a/build/README.md b/build/README.md new file mode 100644 index 0000000..d92e6c0 --- /dev/null +++ b/build/README.md @@ -0,0 +1,19 @@ + https://github.com/facebook/react/tree/master/scripts/rollup +https://github.com/ramda/ramda/blob/master/scripts/build + +# two options: +1. copy same folder structure +2. custom copy, folders do not matter + +## copy same +... .copy ha + +## custom copy +1. find +2. store metadata +3. transform - + if function, use that, + if string, + if relative & isFilename, resolve filename + else if relative + else if absolute, use instead diff --git a/build/cli.js b/build/cli.js index 8a2eb45..bf9acbf 100644 --- a/build/cli.js +++ b/build/cli.js @@ -20,17 +20,22 @@ const fwf = require('funwithflags') const Script = require('script-chain') const log = require('fliplog') const {read, write} = require('flipfile') -const {del} = require('./util') +const {del, _res} = require('./util') // const docdown = require('docdown') const {stripRollup} = require('./plugins/ast') const find = require('chain-able-find') +const {replace} = require('../src') +// @TODO export more on /exports.js +const dot = require('../src/deps/dot') +const traverse = require('../src/deps/traverse') +const uniq = require('../src/deps/array/uniq') -const res = rel => resolve(__dirname, rel) -const resRoot = rel => resolve(res('../'), rel) +const res = _res(__dirname) +const resRoot = _res('../') // https://github.com/chalk/ansi-regex/blob/master/index.js const ansiRegex = /[\u001b\u009b][[()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-PRZcf-nqry=><]/g -const stripAnsi = str => str.replace(ansiRegex, '') +const stripAnsi = replace(ansiRegex, '') const timer = log.fliptime() timer.start('cli') @@ -151,9 +156,6 @@ const testFiles = find .results() const toRel = filepath => filepath.replace(root, '').replace(entry, '') -const dot = require('../src/deps/dot') -const traverse = require('../src/deps/traverse') -const uniq = require('../src/deps/array/uniq') const repoPath = 'https://github.com/fluents/chain-able/blob/master' const repoDocPath = diff --git a/build/easy-npm-files.js b/build/easy-npm-files.js new file mode 100644 index 0000000..421ef97 --- /dev/null +++ b/build/easy-npm-files.js @@ -0,0 +1,510 @@ +// const ffs = require('../_modules/fluent-fs') +const log = require('fliplog') +const jetpack = require('fs-jetpack') +const ConfigStore = require('configstore') +const find = require('chain-able-find') +const {_res} = require('./util') +const {read, write} = require('flipfile') +const { + curry, + not, + includes, + includesCount, + camelCase, + replace, + first, + isMatch, + isString, + isTrue, + isFunction, + isArray, + isEmpty, + remove, + reverse, + pipe, + toMatcher, + construct, + invoke, + hasOwnProperty, + toArr, + escapeDot, + includesAny, + includesAll, + all, + and, + firstToUpperCase, +} = require('../index.all') +const { + forEach, + wrapForEach, + replaceLast, + isNegative, + // find + findIndexAt, + findMatching, + findKey, + findValue, + findValues, + findFirstMatch, + // remap + remapKeys, + remapValues, + remapToMatch, +} = require('./util/__fixme') +const { + getFolderName, getFileName, getFolderAndFileName, +} = require('./util/_filefolder') + +const has = x => includes('_', x) + +// includesAny('_', ['/', 'require']) +// const hasRequire = and(includes('/'), includes('require')) +// const hasRequire = and(includes('/'), includes('require')) +const hasRequire = and(has('/'), has('require')) + +// log.quick(hasRequire, hasRequire(`require('./eh')`)) +// log.quick([hasRequire('/require'), hasRequire('require'), hasRequire('/'), hasRequire('/eh')]) + +// SO EASY +// ....... or ....... way better ....... just replace any `require('./')` + + +// NOW +// !!!!! SHOULD NOT TRANSFORM FILENAMES WITH THE FOLDERNAME === FILENAME +// E.G. UTIL/UTIL, IS/IS! +// ------- ugh forgot +// +// 0. [ ] !!!!!!!!! NEED TO READ CODE, AND CHANGE ALL KNOWN PATHS TO NEW OUTPUT +// READ CONTENT +// ITERATE THROUGH ABSOLUTE FILENAMES +// USE IS_MATCH +// E.G. ./deps/is/undefined +// MATCH AGAINST FILE, PERMUTATE / IF NEEDED +// RESOLVE TO ONE OF THE OUTPUT FILENAMES +// +// +// +// 1. [x] TOROOT +// 2. [x] PUT IN KEY-VAL AS [FROM]: TO +// 3. [x] SAVE FILE WITH FROM-TO AS .JSON +// 4. [ ] READ .JSON +// 5. [ ] DELETE FILES (IN CLI.JS) +// 6. [x] DO A TEST RUN ON A SUBFOLDER +// 7. [ ] !!! add aliases, so it gets copied to multiple output names + +// - [ ] could make docs expandable sections +// - [ ] fix fuzzy search -> the `h2`s are always shown + +const entry = process.cwd() +const cwd = process.cwd() +const cwdRes = _res(cwd) +const res = _res(__dirname) + +// @HACK @TODO just emulating +// const resRoot = _res(res('../')) +const resRoot = _res(res('./FAKEROOT')) + +// @TODO pipe? +const src = cwdRes('./src') + +const defaultCopied = { /* ['absFrom']: 'absTo' */ } +const store = new ConfigStore('easy-exports', {copied: defaultCopied}) +const fromToFilePath = res('./fromTo.json') + +const isRel = has('./') +const isAbs = has('/Users') +const isSrc = has('/src/') + +const toRoot = x => { + // @TODO relative-to + if (isSrc(x)) return resRoot('./' + x.split('/src/').pop()) + else if (isAbs(x)) return x + else if (isRel(x)) return resRoot(x) + else return resRoot('./' + x) +} + +// only copying .js ['!*package.json', '!*.DS_Store'] +const isNotIndex = not(has('index.js')) +const isIzzez = has('/is/') + +const remapKeysToArr = remapKeys(toArr) +const remapValuesToArr = remapValues(toArr) + +// when we have files with the same name, .onConflict, log? +const found = find + .init() + .recursive(true) + .ignoreDirs(['ignant', 'node_modules']) + .abs(true) + .sync(true) + // all folders have a filename with the same name as the folder + // if they did not, we could also rename all index.js files + // , '!*index.js' + .matchFiles(['**/*.js']) + .find(src) + .results() + .filter(isNotIndex) + // .map(file => { + // return { + // og: file, + // remapped: file.replace(regex, dest), + // rel: file.replace(regex, '.'), + // } + // }) + // .filter(file => { + // if (exists(file.remapped)) return false + // + // log.dim('copying:').data(file).echo(this.parent.debug) + // copied.push(file.rel) + // + // return true + // }) + // .filter(uniq) + + +const filesObj = {} +const founds = wrapForEach(found) +const hasDupeFileName = abs => { + // prop, pipe, lense? + const rel = filesObj[abs] + const rels = Object.values(filesObj) + const count = includesCount(rels, rel) + // console.log({[rel]: count}) + if (count >= 2) { + console.log(count, abs) + } + return count >= 2 +} + +const transformFolderAndFileCamel = (abs, folder, filename) => { + const folderFile = folder + '/' + filename + const transformed = camelCase(folder + '_' + filename) + '.js' + return replace(folderFile, transformed, abs) +} + + +// @TODO either replaceLast, or toRel then replace +const transformIzzes = (abs, folder, filename) => { + const fileName = getFileName(abs) + const transformedFileName = camelCase('is_' + fileName) + // @TODO: replaceLast (could .reverse.replace.reverse) + let transformedAbs = replaceLast(fileName, transformedFileName, abs) + return transformedAbs +} + +// (x.includes('/deps/') ? x.split('/deps/').pop() : x.split('/src/').pop()) +// pipe(replace('/src/', '/'), replace('/deps/', '/')) +const transformToFileName = x => x.split('/').pop() + +const transformSymbol = (abs, folder, fileName) => { + const beginning = abs.split(`/${folder}/`).shift() + return beginning + '/Symbol.' + firstToUpperCase(fileName) + '.js' +} + +// @TODO !!!!!!!!!!!!!!!!!!! TRANSFORM, THIS-AS-A-CHAIN +// key to matcher +const map = { + // 'eh': 'eh', + '/conditional/all': 'all', + '/to/*.js': transformFolderAndFileCamel, + '/is/*.js': transformIzzes, + '/symbols/*.js': transformSymbol, + '*': transformToFileName, +} + +// log.quick(findMatching('src/conditional/all')) + +// const firstIsFunction = pipe(first, isFunction) +const firstIsFunction = x => isFunction(x[0]) + +// (['.', '-', '_']).map(has) +const isNotCamelCase = x => + x.includes('.') || x.includes('-') || x.includes('_') + +const fromTo = {} + +const doubleExtHACK = has('.js.js') + +// isLast, isFirst ? kind of is .before .after if it's only flat... +let remapped = founds + .forEach(abs => { + filesObj[abs] = getFileName(abs) + }) + .map(abs => { + // start remap + let remappedAbs = fromTo[abs] || [] + fromTo[abs] = remappedAbs + const alreadyHas = includes(remappedAbs) + const add = x => { + toArr(x).forEach(value => { + const rootValue = toRoot(value) + if (alreadyHas(rootValue)) return + // remappedAbs.push(value) + remappedAbs.push(rootValue) + }) + remappedAbs.forEach((value, index) => { + remappedAbs[index] = toRoot(value) + if (doubleExtHACK(remappedAbs[index])) { + remappedAbs[index] = remappedAbs[index].split('.js').shift() + '.js' + } + }) + + // if (isNotCamelCase(x)) add(camelCase(escapeDot(x))) + } + + // find if we need to remap and how we will do so + const matchFound = findMatching(map, abs) + if (matchFound) { + let [key, value, keys] = matchFound + + // console.log('found matching', {abs, key, value, keys}) + let [folderName, fileName] = getFolderAndFileName(abs) + + if (isArray(value) && !isEmpty(value)) { + if (value.length > 1) { + value = value.map(x => (isString(x) ? replace(key, value) : x)) + + // @TODO was pipe, need best name + // what's the name for this? reducing with each value updating? + let transformed = abs + value.forEach(val => { + [folderName, fileName] = getFolderAndFileName(abs) + transformed = val(transformed, folderName, fileName) + }) + + add(transformed) + } + else if (firstIsFunction(value)) { + const transformed = value[0](abs, folderName, fileName) + add(transformed) + } + else { + console.log('first is not a function', {value: value[0]}) + } + } + else { + const transformed = replace(key, value, abs) + add(transformed) + } + } + else if (isIzzez(abs)) { + const transformed = transformIzzes(abs) + add(transformed) + } + // @TODO default the one to use + else if (hasDupeFileName(abs)) { + const folderName = getFolderName(abs) + const fileName = getFileName(abs) + const folder_file = folderName + '_' + fileName + const folderWithSlashes = '/' + folderName + '/' + const beforeFolder = abs.split(folderWithSlashes).shift() + let transformed = beforeFolder + camelCase(folder_file) + + // if (!transformedAbs.endsWith('js')) transformedAbs += '.js' + // console.log('hasDupe', {transformed}) + + add(transformed) + } + else { + add(abs) + } + + const fileName = getFileName(abs) + + // @TODO all snake & all camel + if (isNotCamelCase(fileName)) { + const beginning = abs.split(`/${fileName}`).shift() + let transformed = beginning + '/' + camelCase(fileName) + // let transformed = replace(fileName, camelCase(fileName), abs) + // log.data({transformed, camel: camelCase(fileName), fileName, abs}).echo() + add(transformed) + } + + if (!hasDupeFileName(abs)) { + // add(abs) <- keeps nested folders which is meh + add(transformToFileName(abs)) + + const [folderName] = getFolderAndFileName(abs) + const [alpha, omega] = abs.split(folderName) + const transformed = alpha + omega + // add(transformed) + } + + return remappedAbs + // return abs + }) + + +const fromToJSON = JSON.stringify(fromTo, null, 2) +write(fromToFilePath, fromToJSON) + +// use when needed +// const fromToRead = read.json(fromToFilePath) +// log.quick(fromTo) + +// would just be .toMatcher... +// const __map = (obj, transformer) => obj.map(transformer) +// const _map = curry(2, __map) +// const replaceAll = curry(3, (patterns, replacements, str) => { +// _map(patterns) +// } + +const remapRequire = contents => contents + .split('\n') + .map(line => { + // line.includes('/') && line.includes('require') + if (!hasRequire(line)) return line + + const parts = line.split('=') + const name = parts.shift().trim() + + // remove all initial dots, and the first slash + const sanitizeRequire = x => x.replace(/[.]/g, '').replace('/', '') + + const requireReplacer = (match, p1, offset, string) => { + match = sanitizeRequire(match) + + const findFrom = () => { + return Object.keys(fromTo).filter(x => { + const matches = + isMatch(match, x) || + isMatch(x, match) || + x.includes(match) || + match.includes(x) + + // if (!matches) log.quick(({x, match, matches})) + + return matches + }) + } + + const requireFoundInFromTo = findFrom() + // log.data({requireFoundInFromTo}).echo() + return requireFoundInFromTo + // findMatching(map, match) + // return match + // p1 is nondigits, p2 digits, and p3 non-alphanumerics + // return [p1, p2, p3].join(' - ') + } + + if (parts.length === 0) return line + + const ogRequire = parts.pop().trim() + + // @TODO right here can use a new name matching the parts, bingo bango bongo + const remappedRequire = ogRequire + .replace(`require('`, '') + .replace(')', '') + .replace(`'`, '') + .replace(/.*/, requireReplacer) + .split('/') + .pop() + + const comment = `/* remapped from ${ogRequire} */` + return `${name} = require('./${remappedRequire}') ${comment}` + }) + .join('\n') + + +// @TODO file-chain better here +Object.keys(fromTo).forEach(key => { + const fileNames = fromTo[key] + + let contents = read(key) + contents = `/* FROM-TO: ${key.split('/chain-able/').pop()} */\n${contents}` + contents = remapRequire(contents) + + log.bold(key).data(fileNames).echo() + + fileNames.forEach(fileName => { + if (fileName.includes('/src/')) { + const bad = new Error(fileName) + log.red('bad filename').data(bad).echo() + return + } + + // log.bold(fileName).echo() + // log.green(contents).echo() + // log.underline('__________ \n').echo() + + // log.data({[fileName]: contents}).echo() + write(fileName, contents) + }) +}) + +// remapped = remapValuesToArr(remapped) +// remapped.forEach(transformed => log.bold(transformed).echo()) +// log.verbose(200).data({entry}).exit() + + +// const from = 'foo_1' +// const to = 'foo_final' +// +// // Copies files from folder foo_1 to foo_final, but overwrites in +// // foo_final only files which are newer in foo_1. +// jetpack.copy(from, to, { +// overwrite: (srcInspectData, destInspectData) => { +// console.log('had conflict') +// return false +// // return srcInspectData.modifyTime > destInspectData.modifyTime; +// } +// }); + +// find.up +// const res = _res(__dirname) +// const resRoot = _res(entry) + +// +// +// ----- restructure for copying all to flat! --- +// +// // just have keyval map like I was doing with emoji +// // +// /// helpful for mapping all `toarr` +// // MapValues of object +// // MapKeys +// // MapObjOrArr +// // +// // have each value be a string[], or Transformer which returns say +// // function transformIs(folder, filename) { +// // return folder + ucFirst(filename) +// // } +// // or false to ignore +// +// // string to upper how to do best? +// // map string? +// // finish !!!!!! chain-able-fs with data chains +// // +// const firstToUpper = str => str.charAt(0).toUpperCase() + str.slice(1) +// +// // treeshake should also add an index with EVERY FILE +// // put as es6 exports.name +// // then easy to remove unused exports +// +// // finish proxy example +// +// ------------------- +// +// add test to `require` each file just for errors sake +// add +// +// +// ------------------- +// +// perf +// - argumentor +// - gc +// - obj-pooler? +// +// +// arr/ +// - to-arr || to/arr -> **copy-as('to-arr)** +// - concat +// +// // can also be `coerce` +// to/ +// +// traverse/ +// - index +// - Traverse +// - traversers diff --git a/build/plugins/comments.js b/build/plugins/comments.js new file mode 100644 index 0000000..65c3017 --- /dev/null +++ b/build/plugins/comments.js @@ -0,0 +1,22 @@ +const log = require('fliplog') + +function commentsPlugin(options = {}) { + return { + name: 'comments', + transform(code, id) { + if (id.includes('index.js')) return null + const parts = id.split('chain-able/') + if (parts.length <= 1) return null + + + const filename = parts.pop() || 'missing-filename' + const filenameComment = '/* ___filename___: ' + filename + ' */\n' + if (code.includes(filenameComment)) return null + console.log({filename}) + + return filenameComment + code + }, + } +} + +module.exports = options => commentsPlugin(options) diff --git a/build/plugins/index.js b/build/plugins/index.js index 1c9a390..3a1713c 100644 --- a/build/plugins/index.js +++ b/build/plugins/index.js @@ -5,6 +5,7 @@ const optimizejs = require('./optimizejs') const filesize = require('./filesize') const replace = require('./replace') const falafelPlugin = require('./ast') +const commentsPlugin = require('./comments') module.exports = (version, options) => { if (options.env === 'development') { @@ -17,6 +18,8 @@ module.exports = (version, options) => { const plugins = [] const add = plugin => plugins.push(plugin) + add(commentsPlugin(options)) + if (options.falafel) add(falafelPlugin(options)) if (options.replace) add(replace(options)) diff --git a/build/plugins/uglify.js b/build/plugins/uglify.js index ad3d4e7..6fecba5 100644 --- a/build/plugins/uglify.js +++ b/build/plugins/uglify.js @@ -5,7 +5,11 @@ const {minify} = require('uglify-es') // https://github.com/mishoo/UglifyJS2#minify-options-structure // should mangle... module.exports = options => { - const mangles = options.mangles === undefined ? true : options.mangles + let mangles = options.mangles === undefined ? true : options.mangles + + // @TODO hard to keep it mangling top-level, so ugly with 1 letter fns + // mangles = false + const beautify = !!options.beautify const uglifyOptions = { @@ -49,10 +53,12 @@ module.exports = options => { // @TODO: // pure_funcs: true, side_effects: false, - keep_fargs: beautify, + + // @NOTE we need this one for fp/arity + keep_fargs: true, + keep_fnames: beautify, // for now - // keep_fargs: false, // keep_fnames: false, // for now passes: 10, }, diff --git a/build/size-over-time.txt b/build/size-over-time.txt index 9cad971..11ee264 100644 --- a/build/size-over-time.txt +++ b/build/size-over-time.txt @@ -834,3 +834,243 @@ $ gzip-size "dists/umd/index.js" "--raw" Done in 0.68s. 2017:15:07/12/17:19:15:45 --- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +8774 +Done in 0.53s. +2017:30:07/13/17:00:30:48 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +2357 <- traverser only (along with deps) (before any size optimization) +Done in 0.56s. +2017:55:07/13/17:03:55:41 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +2080 <- original traverse-js size (along with deps) (with all deopts) +Done in 0.53s. +2017:59:07/13/17:03:59:39 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +8780 +Done in 0.54s. +2017:01:07/13/17:04:01:49 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +8835 +Done in 0.51s. +2017:59:07/15/17:01:59:43 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9162 +Done in 0.61s. +2017:34:07/16/17:19:34:30 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9161 +Done in 0.47s. +2017:14:07/16/17:20:14:21 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9161 +Done in 0.55s. +2017:51:07/17/17:20:51:34 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9161 +Done in 0.59s. +2017:58:07/17/17:20:58:46 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9161 +Done in 0.56s. +2017:23:07/17/17:21:23:44 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9161 +Done in 0.61s. +2017:02:07/17/17:22:02:19 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9161 +Done in 0.58s. +2017:48:07/18/17:00:48:19 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9161 +Done in 0.54s. +2017:50:07/18/17:00:50:01 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9161 +Done in 0.55s. +2017:50:07/18/17:00:50:43 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9161 +Done in 0.54s. +2017:51:07/18/17:00:51:39 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9161 +Done in 0.54s. +2017:52:07/18/17:00:52:12 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9161 +Done in 0.58s. +2017:53:07/18/17:00:53:59 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9161 +Done in 0.54s. +2017:54:07/18/17:00:54:51 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9161 +Done in 0.55s. +2017:55:07/18/17:00:55:15 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9161 +Done in 0.58s. +2017:55:07/18/17:00:55:52 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9161 +Done in 0.55s. +2017:56:07/18/17:00:56:24 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9161 +Done in 0.70s. +2017:57:07/18/17:00:57:27 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +12612 <- not uglified top level +Done in 0.53s. +2017:00:07/18/17:01:00:43 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9183 <- before trying curry in tryCatch +Done in 0.49s. +2017:27:07/18/17:15:27:26 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9219 <- with curry, sad +Done in 0.57s. +2017:28:07/18/17:15:28:24 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9216 <- currying tryCatch, so minor, why bigger for the other one? because they are both curried? sheesh +Done in 0.56s. +2017:30:07/18/17:15:30:38 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9371 +Done in 0.75s. +2017:40:07/18/17:17:40:52 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9379 +Done in 0.62s. +2017:34:07/19/17:19:34:43 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9379 +Done in 0.52s. +2017:20:07/19/17:20:20:37 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9261 +Done in 0.56s. +2017:55:07/19/17:21:55:07 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9303 <- refactor .equals +Done in 0.58s. +2017:36:07/20/17:02:36:25 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9308 +Done in 0.69s. +2017:43:07/20/17:02:43:10 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9308 +Done in 0.54s. +2017:54:07/20/17:02:54:35 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9308 +Done in 0.58s. +2017:58:07/20/17:02:58:53 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9161 <- minor easy util usage (props in gc, remove if > 100 parents in traverse, remove isArray && !isArray since it is covered already, ) +Done in 0.54s. +2017:21:07/20/17:03:21:48 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9153 <- more minor utils (or in str or num), rename .iteratee to .node, ternary in transform.remap +Done in 0.62s. +2017:12:07/20/17:18:12:51 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9153 +Done in 0.53s. +2017:20:07/20/17:18:20:28 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9153 +Done in 0.59s. +2017:24:07/20/17:18:24:16 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9153 +Done in 0.58s. +2017:32:07/20/17:18:32:48 +--- +yarn run v0.27.5 +$ gzip-size "dists/umd/index.js" "--raw" +9269 +Done in 0.54s. +2017:38:07/22/17:03:38:19 +--- diff --git a/build/util/__fixme.js b/build/util/__fixme.js new file mode 100644 index 0000000..22d1728 --- /dev/null +++ b/build/util/__fixme.js @@ -0,0 +1,203 @@ +const { + curry, + not, + includes, + includesCount, + camelCase, + replace, + first, + isMatch, + isString, + isTrue, + isFunction, + isArray, + isEmpty, + remove, + reverse, + pipe, + toMatcher, + construct, + invoke, + hasOwnProperty, + keysObjOrArray, +} = require('../../index.all') + +const isNegative = x => x < 0 + +// NEED TO HAVE .LAST_INDEX_OF CAN USE COUNT, SAME WAY, AND CPY FROM LODASH | RAMDA + +// whether to return the key along with value... +// first, last, nth +const _findAt = curry(3, (haystack, predicate, position) => { + let findings = [] + + // @TODO NOT SOLID + const hay = isArray(haystack) ? haystack : haystack.split(predicate) + + // loop obj ugh + hay.forEach((needle, key) => { + if (isMatch(needle, predicate)) findings.push(needle) + // if (predicate(needle, key)) findings.push(needle) + }) + + if (isEmpty(findings)) return null + else if (isNegative(position)) return findings[findings.length - position] + else return findings[position] +}) + +// findIndexAt +const findIndexAt = curry(3, (haystack, predicate, position) => { + const finding = _findAt(haystack, predicate, position) + return haystack.indexOf(finding) +}) + +// const replaceLast = findAt('_', '_', -1) +// const replaceLast = (pattern, replacement, str) => +// pipe(reverse, replace(pattern, replacement), reverse)(str) + +const replaceLast = (pattern, replacement, str) => { + // const index = findIndexAt(str, pattern, -1) + + // 1 + // const pieces = str.split(pattern) + // const replaced = pieces.join(pattern) + + // 2 + const index = str.lastIndexOf(pattern) + const pre = str.substring(0, index) + const second = str.substring(index) + const replaced = pre + second.replace(pattern, replacement) + // console.log({index, pre, second, pattern, replaced}) + + // 3 + // const strs = str.split(pattern) + // let replaced = '' + // strs.forEach((s, index) => { + // if (index === strs.length) replaced += s.replace(pattern) + // else replaced += s + // }) + + // const replaced = str.replace(toMatcher(pattern), replacement) + + return replaced +} + +// @TODO could also use for in +const forOwn = curry(2, (array, iteratee) => { + const nodeIsArray = isArray(array) + let keys = keysObjOrArray(array) + let index = 0 + while (index++ < keys.length - 1) { + const key = nodeIsArray ? keys[index] : keys[keys[index]] + iteratee(keys[index], key, index, array) + } + return array +}) + +// forEachChain +const forEach = curry(2, (array, iteratee) => { + array.forEach(iteratee) + return array +}) +const wrapForEach = (array) => { + return {forEach: forEach(array)} +} + + +// @TODO pure-function side-effect-free to return say an array +// with them knowing the original index +// +// @TODO need to remap Map too... ugh +const _remapKeys = (transform, obj, removeOld = true) => { + Object.keys(obj).forEach(oldKey => { + const newKey = transform(obj[oldKey]) + obj[newKey] = obj[oldKey] + if (isTrue(removeOld)) remove(obj[oldKey]) + }) +} +const _remapValues = (transform, obj) => { + Object.keys(obj).forEach(key => obj[key] = transform(obj[key], key)) +} + +// value & values, key & keys, as obj or array... goodness +// +// match key, if match, use that transform (first one, condition/all as og name) +const _findKey = (predicate, obj) => Object.keys(obj).filter(predicate).shift() +const findKey = curry(2, _findKey) + +// @TODO NEED FINDVALUES TO PIPE ALL RESULTS +const _findValue = (predicate, obj) => { + const keys = Object.keys(obj) + for (let index = 0; index < keys.length; index++) { + const key = keys[index] + const value = obj[key] + if (predicate(value, key)) return value + } + return false +} +const _findValues = (predicate, obj) => { + const keys = Object.keys(obj) + const valuesFound = [] + for (let index = 0; index < keys.length; index++) { + const key = keys[index] + const value = obj[key] + if (predicate(value, key)) valuesFound.push(value) + } + return valuesFound +} + +const findValue = curry(2, _findValue) +const findValues = curry(2, _findValues) + +const remapKeys = curry(2, _remapKeys) +const remapValues = curry(2, _remapValues) + +const remapToMatch = remapKeys(toMatcher) +const findFirstMatch = pipe(isMatch, findValue) + + +// @TODO now I have a use knowing it exists... +// find(map, prop, isMatch) +// findKey(map, isMatch) +// Object.keys(map).filter(isMatch) +// remapToMatch(map) + +const findMatching = (obj, query) => { + let lastKeyFound + let keys = [] + + const keyToMatcher = (val, key) => { + lastKeyFound = key + // console.log('does it match?', {query, val, key, isMatch: isMatch(query, key)}) + if (isMatch(query, key)) { + keys.push(key) + return true + } + return false + } + + const value = findValues(keyToMatcher, obj) + + // console.log({value, keys}, 'finding matching...') + if (value.length) return [lastKeyFound, value, keys] + else return false +} + +module.exports = { + forEach, + wrapForEach, + replaceLast, + isNegative, + // find + findIndexAt, + findMatching, + findKey, + findValue, + findValues, + findFirstMatch, + // remap + remapKeys, + remapValues, + remapToMatch, + forOwn, +} diff --git a/build/util/_filefolder.js b/build/util/_filefolder.js new file mode 100644 index 0000000..051f9a7 --- /dev/null +++ b/build/util/_filefolder.js @@ -0,0 +1,23 @@ +const {basename} = require('path') + +const getFolderName = file => { + const fileParts = file.split('/') + fileParts.pop() + return fileParts.pop() +} +const getFileName = (file, withExt = false) => { + let filename = basename(file) + + if (withExt === false && filename.includes('.')) { + filename = filename.split('.').shift() + } + + return filename +} +const getFolderAndFileName = (abs, withExt = false) => { + const folder = getFolderName(abs, withExt) + const file = getFileName(abs, withExt) + return [folder, file, abs] +} + +module.exports = {getFolderName, getFileName, getFolderAndFileName} diff --git a/build/util/_res.js b/build/util/_res.js new file mode 100644 index 0000000..4839703 --- /dev/null +++ b/build/util/_res.js @@ -0,0 +1,4 @@ +const {resolve} = require('path') +const {curry} = require('../../') + +module.exports = curry(2, (dir, rel) => resolve(dir, rel)) diff --git a/build/util/_toRel.js b/build/util/_toRel.js new file mode 100644 index 0000000..21e7651 --- /dev/null +++ b/build/util/_toRel.js @@ -0,0 +1,7 @@ +const {resolve} = require('path') +const {curry} = require('../../') + +// replace() +const toRel = (rootPath, filePath) => filePath.replace(rootPath, '') + +module.exports = curry(2, toRel) diff --git a/build/util/index.js b/build/util/index.js index b0c473b..836d4e3 100644 --- a/build/util/index.js +++ b/build/util/index.js @@ -1,4 +1,6 @@ module.exports = { argv: require('./_args'), del: require('./_delete'), + res: require('./_res'), + _res: require('./_res'), } diff --git a/dists/dev/index.js b/dists/dev/index.js new file mode 100644 index 0000000..4f0e4ed --- /dev/null +++ b/dists/dev/index.js @@ -0,0 +1,10130 @@ +(function (global, factory) { + typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() : + typeof define === 'function' && define.amd ? define(factory) : + (global.ChainAble = factory()); +}(this, (function () { 'use strict'; + + function unwrapExports (x) { + return x && x.__esModule ? x['default'] : x; + } + + function createCommonjsModule(fn, module) { + return module = { exports: {} }, fn(module, module.exports), module.exports; + } + + /* ___filename___: dist/deps/util/assign.js */ + var assign = Object.assign; + + /* ___filename___: dist/deps/is/undefined.js */ + /** + * @desc Checks if `value` is `undefined`. + * @category Lang + * + * @param {*} x value + * @return {boolean} isUndefined + * + * @since 4.0.0-alpha.1 + * @memberOf is + * @func isUndefined + * + * @see is/nullOrUndefined + * @see https://github.com/infernojs/inferno/blob/master/packages/inferno-shared/src/index.ts#L57 + * + * @NOTE || typeof x === 'undefined' + * + * @example + * + * isUndefined(undefined) + * //=> true + * isUndefined(void 0) + * //=> true + * + * isUndefined(null) + * //=> false + * isUndefined(NaN) + * //=> false + * isUndefined({}) + * //=> false + * isUndefined('') + * //=> false + * isUndefined(1) + * //=> false + * isUndefined(false) + * //=> false + * + */ + var _undefined = function (x) { return x === undefined; }; + + /* ___filename___: dist/deps/symbols/iterator.js */ + var iterator = Symbol.iterator; + + // typeof Symbol !== 'undefined' + // ? Symbol.iterator + // : '@@iterator' + + /* ___filename___: dist/deps/symbols/instance.js */ + var instance = Symbol.hasInstance; + + /* ___filename___: dist/deps/symbols/primitive.js */ + var primitive = Symbol.toPrimitive; + + /* ___filename___: dist/deps/is/prototypeOf.js */ + var prototypeOf = function (obj, comparator) { return Object.prototype.isPrototypeOf.call(obj, comparator); }; + + /* ___filename___: dist/deps/is/toS.js */ + /** + * The base implementation of `getTag` without fallbacks for buggy environments. + * + * @memberOf is + * @since 3.0.0 + * + * @param {*} obj The value to `Object.prototype.toString.call(obj)`. + * @return {string} Returns the `toStringTag`. + * + * @see https://github.com/lodash/lodash/blob/master/.internal/baseGetTag.js + * @see https://github.com/jonschlinkert/kind-of + * @see https://github.com/substack/js-traverse/blob/master/index.js#L285 + * @see http://luxiyalu.com/object-prototype-tostring-call/ + * + * @TODO obj[Symbol.toStringTag] + * + * @example + * + * toS({}) + * //=> '[Object object]' + * + * toS(function() {}) + * //=> '[Object function]' + * + */ + var toS = function (obj) { return Object.prototype.toString.call(obj); }; + + /* ___filename___: dist/deps/is/toS.js */ + + /* ___filename___: dist/deps/is/map.js */ + + + /** + * @desc Checks if `value` is classified as a `Map` object. + * @param {*} x value + * @return {boolean} isMap + * + * @since 3.0.0 + * @memberOf is + * @func isMap + * @see https://github.com/jonschlinkert/kind-of + * + * @example + * + * isMap(new Map()) + * //=> true + * isMap(new Map.entries()) + * //=> false + * isMap(new Set()) + * //=> false + * isMap({}) + * //=> false + * isMap('') + * //=> false + * isMap(1) + * //=> false + * isMap(new WeakMap) + * // => false + * + * @example + * + * const e = {} + * eh[Symbol.toStringTag] = '[object Map]' + * isMap(eh) + * + * @example + * + * class Eh extends Map() + * isMap(new Eh()) + * //=> true + * + */ + var map = function isMap(x) { + // return x instanceof Map || + return toS(x) === '[object Map]' + }; + + /* ___filename___: dist/deps/is/set.js */ + + + /** + * Checks if `value` is classified as a `Set` object. + * + * @since 4.3.0 + * @category Lang + * @param {*} x The value to check. + * @return {boolean} Returns `true` if `value` is a set, else `false`. + * + * @example + * + * isSet(new Set) + * // => true + * + * isSet(new WeakSet) + * // => false + * + */ + var set = function isSet(x) { + return x instanceof Set || toS(x) === '[object Set]' + // return toS(x) === '[object Set]' + }; + // x instanceof Set || + + /* ___filename___: dist/deps/is/function.js */ + /** + * Checks if `value` is classified as a `Function` object. + * @category Lang + * + * @param {*} x The value to check. + * @return {boolean} x isFunction + * + * @since 3.0.0 + * @memberOf is + * @func isFunction + * + * @NOTE || x instanceof Function + * + * @polyfill safari=9 + * The use of `Object#toString` avoids issues with the `typeof` operator + * in Safari 9 which returns 'object' for typed arrays and other constructors. + * there is no polyfill for this + * https://github.com/krambuhl/custom-event-polyfill/issues/2 + * browser usage is < 0.3%, very edge case + * + * @example + * + * isFunction(function() {}) + * //=> true + * isFunction(() => {}) + * //=> true + * isFunction(new Function()) + * //=> true + * + * isFunction(1) + * //=> false + * isFunction('') + * //=> false + * isFunction(/abc/) + * // => false + */ + var _function = function isFunction(x) { + return typeof x === 'function' + }; + + /* ___filename___: dist/deps/is/stringPrimitive.js */ + + + /** + * Checks if `value` is classified as a `String` **primitive**. + * + * @since 3.0.0 + * @category Lang + * @memberOf is + * @param {*} x The value to check. + * @returns {boolean} Returns `true` if `value` is a string, else `false`. + * + * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String + * @see https://github.com/lodash/lodash/blob/master/isString.js + * @see is/string + * + * @example + * + * isString('abc') + * // => true + * + * isString(new String('abc')) + * // => false + * + * isString(1) + * // => false + */ + var stringPrimitive = function (x) { return typeof x === 'string'; }; + + /* ___filename___: dist/deps/is/stringPrimitive.js */ + + /* ___filename___: dist/deps/is/string.js */ + + + + /** + * Checks if `value` is classified as a `String` primitive or object. + * + * @since 3.0.0 + * @category Lang + * + * @memberOf is + * @extends isStringPrimitive + * @variation also allows String objects + * + * @param {*} x The value to check. + * @return {boolean} Returns `true` if `value` is a string, else `false`. + * + * @see https://github.com/lodash/lodash/blob/master/isString.js + * @see isStringPrimitive + * + * @example + * + * isString('abc') + * // => true + * + * isString(new String('abc')) + * // => true + * + * isString(1) + * // => false + */ + var string = function (x) { return stringPrimitive(x) || toS(x) === '[object String]'; }; + + /* ___filename___: dist/deps/is/false.js */ + /** + * @param {*} x value + * @return {boolean} isFalse + * + * @since 4.0.0-alpha.1 + * @memberOf is + * @func isFalse + * + * @example + * + * isFalse(false) + * //=> true + * isFalse(true) + * //=> false + * isFalse(0) + * //=> false + * isFalse('') + * //=> false + * + */ + var _false = function isFalse(x) { + return x === false + }; + + /* ___filename___: dist/deps/util/noop.js */ + /** + * @name noop + * + * @func + * @since 5.0.0 + * @return {void} + * + * {@link https://github.com/sindresorhus/noop3 noop3} + * @see {@link noop3} + * + * @example + * + * noop + * + * @example + * + * noop() + * + */ + var noop = function noop() { /* noop */ }; + + /* ___filename___: dist/deps/util/keys.js */ + var keys = Object.keys; + // function keys(obj) { + // var res = [] + // for (var key in obj) + // { res.push(key) } + // return res + + /* ___filename___: dist/deps/util/assign.js */ + + /* ___filename___: dist/deps/define.js */ + + + /** + * @desc default to configurable and enumerable, unless configured otherwise + * @since 4.0.0 + * + * @param {Object} obj object to define on + * @param {Primitive} name property name to define + * @param {Object} descriptor object descriptor + * @return {void} + * + * @tutorial https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Object/defineProperty + * + * @example + * + * var desc = Object.getOwnPropertyDescriptor(obj, 'eh', {get: () => console.log('eh')}) + * + */ + var define = function(obj, name, descriptor) { + Object.defineProperty( + obj, + name, + assign( + { + configurable: true, + enumerable: true, + }, + descriptor + ) + ); + }; + + /* ___filename___: dist/deps/ignored.js */ + var ignored = function (key) { return key === 'parent' || key === 'store' || key === 'meta' || key === 'className'; }; + + // key === 'decorated' || + // key === 'transformers' || + // key === 'inspect' || + + /* ___filename___: dist/deps/env/dev.js */ + /* istanbul ignore next: wip build */ + var dev = process.env.NODE_ENV !== 'production'; + + /* ___filename___: dist/deps/symbols/iterator.js */ + + /* ___filename___: dist/deps/symbols/instance.js */ + + /* ___filename___: dist/deps/symbols/primitive.js */ + + /* ___filename___: dist/deps/is/prototypeOf.js */ + + /* ___filename___: dist/deps/is/map.js */ + + /* ___filename___: dist/deps/is/set.js */ + + /* ___filename___: dist/deps/is/undefined.js */ + + /* ___filename___: dist/deps/is/function.js */ + + /* ___filename___: dist/deps/is/string.js */ + + /* ___filename___: dist/deps/is/false.js */ + + /* ___filename___: dist/deps/util/noop.js */ + + /* ___filename___: dist/deps/util/keys.js */ + + /* ___filename___: dist/deps/define.js */ + + /* ___filename___: dist/deps/ignored.js */ + + /* ___filename___: dist/deps/env/dev.js */ + + /* ___filename___: dist/Chainable.js */ + + + + + + + + + + + + + + + + + // @TODO change from `||` to if else + var shouldClear = function (key, property) { return !ignored(key) && + (map(property) || set(property) || (property && property.store)); }; + + var ComposeChainable = function (Target) { + /* istanbul ignore next: dev */ + if (dev) { + if (!Target || !Target.prototype) { + console.log({Target: Target}); + throw new TypeError('did not have a super class / target base') + } + } + + /** + * @desc Trait class that can inherit any class passed into compose, extended by ChainedMap & ChainedSet + * + * @member Chainable + * @class Chainable + * @category Chainable + * @type {Chainable} + * + * @prop {Chainable | any} parent + * @prop {string} className + * + * {@link https://github.com/iluwatar/java-design-patterns/tree/master/chain chain-pattern} + * @see {@link chain-pattern} + * + * @see ChainedMap + * @see ChainedSet + * + * @tests Chainable + * @types Chainable + */ + var Chainable = (function (Target) { + function Chainable(parent) { + Target.call(this); + if (parent) { this.parent = parent; } + this.className = this.constructor.name; + } + + if ( Target ) Chainable.__proto__ = Target; + Chainable.prototype = Object.create( Target && Target.prototype ); + Chainable.prototype.constructor = Chainable; + + /** + * @desc Iterator for looping values in the store + * + * @memberOf Chainable + * @since 0.5.0 + * + * @type {generator} + * @return {Object} {value: undefined | any, done: true | false} + * + * @NOTE assigned to a variable so buble ignores it + * + * + * @see https://github.com/sindresorhus/quick-lru/blob/master/index.js + * @see https://stackoverflow.com/questions/36976832/what-is-the-meaning-of-symbol-iterator-in-this-context + * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/iterator + * @see this.store + * @tests iteration + * + * @example + * + * const chain = new Chain().set('eh', 1) + * for (var [key, val] of chain) console.log({[key]: val}) + * //=> {eh: 1} + * + * @example + * + * *[Symbol.iterator](): void { for (const item of this.store) yield item } + * + * @example + * + * const {ChainedSet} = require('chain-able') + * const set = new ChainedSet() + * set.add('eh') + * + * for (const arr of set) { + * const [key, val] = arr + * + * key + * //=> 0 + * + * val + * //=> 'eh' + * + * arr.length + * //=> 2 + * } + * + */ + Chainable.prototype[iterator] = function () { + var values = this.values(); + var size = this.store.size; + var entries = this.entries ? this.entries() : 0; + var keys$$1 = entries === 0 ? new Array(size) : keys(entries); + + return { + i: 0, + next: function next() { + var i = this.i; + var key = i; + var val = values[i]; + if (entries) { key = keys$$1[i]; } + + // done - no more values, or iteration reached size + if ((_undefined(key) && _undefined(val)) || size <= i) { + return {value: undefined, done: true} + } + + this.i++; + + // return + return {value: [key, val], done: false} + }, + } + }; + + /** + * @desc for ending nested chains + * @since 0.4.0 + * @memberOf Chainable + * + * @return {Chainable | any} + * + * @see Chainable.parent + * @see FactoryChain + * + * @example + * + * const parent = 'eh' + * const child = newChain(parent) + * child.end() + * //=> 'eh' + * + */ + Chainable.prototype.end = function end () { + return this.parent + }; + + /** + * @desc when the condition is true, + * trueBrancher is called, + * else, falseBrancher is called + * + * @memberOf Chainable + * @since 4.0.0 <- added string-as-has(condition) + * @since 2.0.0 + * + * @param {boolean | string} condition when string, checks this.get + * @param {Function} [trueBrancher=Function] called when true + * @param {Function} [falseBrancher=Function] called when false + * @return {Chainable} @chainable + * + * @example + * + * + * const prod = process.env.NODE_ENV === 'production' + * chains.when(prod, c => c.set('prod', true), c => c.set('prod', false)) + * + * + */ + Chainable.prototype.when = function when (condition, trueBrancher, falseBrancher) { + if (condition) { + if (_function(trueBrancher)) { + if (string(condition)) { + if (this.get(condition)) { + trueBrancher(this); + } + } + else { + trueBrancher(this); + } + } + } + else if (_function(falseBrancher)) { + falseBrancher(this); + } + + return this + }; + + /** + * @desc clears the map, + * goes through this properties, + * calls .clear if they are instanceof Chainable or Map + * + * @memberOf Chainable + * @since 4.0.0 (moved only to Chainable, added option to clear this keys) + * @since 0.4.0 (in ChainedMap) + * @since 0.3.0 (in Chainable) + * + * @param {boolean | undefined} [clearPropertiesThatAreChainLike=true] checks properties on the object, if they are `chain-like`, clears them as well + * @return {Chainable} @chainable + * + * @see https://github.com/fliphub/flipchain/issues/2 + * @see ChainedSet + * @see ChainedMap + * + * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/clear map-clear} + * @see {@link map-clear} + * + * @example + * + * const chain = new Chain() + * chain.set('eh', 1) + * chain.entries() + * //=> {eh: 1} + * chain.clear() + * chain.entries() + * //=> {} + * + */ + Chainable.prototype.clear = function clear (clearPropertiesThatAreChainLike) { + var this$1 = this; + + this.store.clear(); + + if (_false(clearPropertiesThatAreChainLike)) { return this } + + var keys$$1 = keys(this); + for (var k = 0; k < keys$$1.length; k++) { + var key = keys$$1[k]; + var property = this$1[key]; + if (shouldClear(key, property)) { this$1[key].clear(); } + } + + return this + }; + + /** + * @desc calls .delete on this.store.map + * @since 0.3.0 + * @memberOf Chainable + * + * @param {Primitive} key on a Map: key referencing the value. on a Set: the index + * @return {Chainable} + * + * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/has + * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set/has + * @see ChainedSet + * @see ChainedMap + * + * @example + * + * const chain = new Chain() + * chain.set('eh', 1) + * chain.get('eh') + * // => 1 + * chain.delete('eh', 1) + * chain.get('eh') + * // => undefined + * + */ + Chainable.prototype.delete = function delete$1 (key) { + this.store.delete(key); + return this + }; + + /** + * @desc checks whether the store has a value for a given key + * @memberOf Chainable + * @since 0.3.0 + * + * @param {any} keyOrValue key when Map, value when Set + * @return {boolean} + * + * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/has map-has} + * @see {@link map-has} + * + * @example + * + * const chain = new Chain() + * chain.set('eh', 1).has('eh') + * //=> true + * chain.has('canada') + * //=> false + * + */ + Chainable.prototype.has = function has (keyOrValue) { + return this.store.has(keyOrValue) + }; + + /** + * @desc spreads the entries from ChainedMap.store.values + * allocates a new array, adds the values from the iterator + * + * @memberOf Chainable + * @since 0.4.0 + * + * @return {Array} toArr(this.store.values()) + * + * @NOTE look at Chainable.constructor to ensure not to use `new Array...` + * @NOTE moved from ChainedMap and ChainedSet to Chainable @2.0.2 + * @NOTE this was [...] & Array.from(this.store.values()) + * + * {@link https://kangax.github.io/compat-table/es6/#test-Array_static_methods compat-array-static-methods} + * {@link https://stackoverflow.com/questions/20069828/how-to-convert-set-to-array set-to-array} + * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/values mozilla-map-values} + * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set/values mozilla-set-values} + * + * @see {@link mozilla-map-values} + * @see {@link mozilla-set-values} + * @see {@link compat-array-static-methods} + * @see {@link set-to-array} + * + * + * @example + * + * const chain = new Chain() + * chain.set('eh', 1) + * chain.values() + * //=> [1] + * + */ + Chainable.prototype.values = function values () { + var allocated = new Array(this.store.size); + var i = 0; + this.store.forEach(function (v) { return (allocated[i++] = v); }); + return allocated + }; + + /** + * @desc symbol method for toString, toJSON, toNumber + * @memberOf Chainable + * @since 1.0.2 + * @version 2 + * + * @param {string} hint enum[default, string, number] + * @return {Primitive} + * + * {@link http://2ality.com/2015/09/well-known-symbols-es6.html#default-tostring-tags well-known-symbols-es6} + * @see {@link well-known-symbols-es6} + * + * @example + * + * const chain = new Chain() + * chain.toNumber = () => 1 + * +chain; + * //=> 1 + * chain + 1 + * //=> + * + * @example + * + * const chain = new Chain() + * chain.toString = () => 'eh' + * chain + '' + * //=> 'eh' + * + */ + Chainable.prototype[primitive] = function (hint) { + /* prettier-ignore */ + /** + * hint === 'number' + * `s`tring is 115 + * `n`umber is 110 + * 110 & 4 = 1 + * 115 & 4 = 0 + * + * if (hint === 'string' && this.toJSON) return this.toJSON() + * else if (hint === 'number' && this.toNumber) return this.toNumber() + */ + if (hint === 'number' && this.toNumber) { return this.toNumber() } + + // hint === 'string' + if (this.toJSON) { return this.toJSON() } + + // hint === 'default' + return this.toString() + }; + + return Chainable; + }(Target)); + + var ChainPrototype = Chainable.prototype; + + /** + * @memberOf Chainable + * @name length + * @method length + * @readonly + * @since 0.5.0 + * @see ChainedMap.store + * @return {number} + * @example for (var i = 0; i < chain.length; i++) + */ + define(ChainPrototype, 'length', { + enumerable: false, + get: function get() { + return this.store.size + }, + }); + define(ChainPrototype, instance, { + enumerable: false, + value: function (instance$$1) { return instance$$1 && (prototypeOf(ChainPrototype, instance$$1) || instance$$1.store); }, + }); + + return Chainable + }; + + // class {} + var c = ComposeChainable(noop); + + /** + * @since 3.0.0 + * @func + * @example + * + * class Target {} + * const TargetChain = Chainable.compose(Target) + * const chain = new TargetChain() + * chain instanceof Target + * //=> true + * + */ + c.compose = ComposeChainable; + + var Chainable = c; + + /* ___filename___: dist/deps/is/objTypeof.js */ + /** + * @param {*} x value + * @return {boolean} isObjLoose + * + * @since 3.0.0 + * @memberOf is + * @func isObjLoose + * @see is/obj + * @see is/objWithKeys + * @see is/objStrict + * @see is/null + * + * @example + * + * isObjLoose(new Object()) + * //=> true + * isObjLoose({}) + * //=> true + * isObjLoose(Object.create(null)) + * //=> true + * isObjLoose(null) + * //=> true + * + * isObjLoose(new Set()) + * //=> false + * isObjLoose(function() {}) + * //=> false + * isObjLoose('') + * //=> false + * isObjLoose(1) + * //=> false + * + */ + var objTypeof = function (x) { return typeof x === 'object'; }; + + /* ___filename___: dist/deps/is/null.js */ + /** + * @param {*} x value + * @return {boolean} isNull + * + * @since 3.0.0 + * @memberOf is + * @func isNull + * + * @example + * + * isNull(null) + * //=> true + * + * isNull(undefined) + * //=> false + * isNull(void 0) + * //=> false + * isNull({}) + * //=> false + * isNull('') + * //=> false + * isNull(1) + * //=> false + * + */ + var _null = function (x) { return x === null; }; + + /* ___filename___: dist/deps/is/null.js */ + + /* ___filename___: dist/deps/is/nullOrUndefined.js */ + + + + /** + * @desc Checks if `value` is `null` or `undefined`. + * @alias isNil + * @category Lang + * + * @param {*} x value + * @return {boolean} isNullOrUndefined + * + * @since 4.0.0-alpha.1 + * @memberOf is + * @func isNullOrUndefined + * + * @see is/null + * @see is/undefined + * @see https://github.com/infernojs/inferno/blob/master/packages/inferno-shared/src/index.ts#L23 + * + * @example + * + * isNullOrUndefined(null) + * //=> true + * isNullOrUndefined(undefined) + * //=> true + * isNullOrUndefined(void 0) + * //=> true + * + * isNullOrUndefined(NaN) + * //=> false + * isNullOrUndefined({}) + * //=> false + * isNullOrUndefined('') + * //=> false + * isNullOrUndefined(1) + * //=> false + * isNullOrUndefined(false) + * //=> false + * + */ + var nullOrUndefined = function isNullOrUndef(x) { + return _undefined(x) || _null(x) + }; + + /* ___filename___: dist/deps/is/objTypeof.js */ + + /* ___filename___: dist/deps/is/nullOrUndefined.js */ + + /* ___filename___: dist/deps/is/objNotNull.js */ + + + + /** + * @param {*} x value + * @return {boolean} isObjStrict + * + * @since 3.0.0 + * @memberOf is + * @func isObjStrict + * @see is/obj + * @see is/objWithKeys + * @see is/objTypeof + * @see is/null + * @see https://github.com/sindresorhus/is-obj/blob/master/index.js + * @TODO !Array.isArray + * + * @extends isObjTypeof + * @variation null will not count as an object + * + * @example + * + * isObjStrict(new Object()) + * //=> true + * isObjStrict({}) + * //=> true + * isObjStrict(Object.create(null)) + * //=> true + * isObjStrict(null) + * //=> false + * + * isObjStrict(new Set()) + * //=> false + * isObjStrict(function() {}) + * //=> false + * isObjStrict('') + * //=> false + * isObjStrict(1) + * //=> false + * + */ + var objNotNull = function (x) { return !nullOrUndefined(x) && objTypeof(x); }; + + /* ___filename___: dist/deps/is/array.js */ + /** + * @func isArray + * @todo https://github.com/facebook/immutable-js/blob/master/src/utils/isArrayLike.js + * @see https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray + * @type {Function} + * @since 3.0.0 + */ + var array = Array.isArray; + + // function isArray(xs) { + // return Object.prototype.toString.call(xs) === '[object Array]' + // } + + /* ___filename___: dist/deps/is/true.js */ + /** + * @param {*} x value + * @return {boolean} isTrue + * + * @since 4.0.0-alpha.1 + * @memberOf is + * @func isTrue + * + * @example + * + * isTrue(true) + * //=> true + * isTrue(false) + * //=> false + * isTrue(1) + * //=> false + * isTrue('') + * //=> false + * + */ + var _true = function (x) { return x === true; }; + + /* ___filename___: dist/deps/is/regexp.js */ + + + /** + * Checks if `value` is classified as a `RegExp` object. + * + * @since 0.1.0 + * @category Lang + * @param {*} x The value to check. + * @return {boolean} Returns `true` if `value` is a regexp, else `false`. + * @see https://github.com/lodash/lodash/blob/master/isRegExp.js + * + * @example + * + * isRegExp(/abc/) + * // => true + * + * isRegExp('/abc/') + * // => false + * + */ + var regexp = function (x) { return toS(x) === '[object RegExp]'; }; + // obj instanceof RegExp || + + /* ___filename___: dist/deps/is/date.js */ + + + /** + * @param {*} x value + * @return {boolean} isDate + * + * @since 3.0.0 + * @memberOf is + * @func isDate + * @extends toS + * + * @example + * + * isDate(new Date()) + * //=> true + * isDate(Date.now()) + * //=> false + * isDate(1) + * //=> false + * isDate('') + * //=> false + * + * @example + * + * const e = {} + * eh[Symbol.toStringTag] = '[Object Date]' + * isDate(eh) + * //=> true + * + * @example + * + * class Eh extends Date() + * isDate(new Eh()) + * //=> true + */ + var date = function isDate(x) { + return toS(x) === '[object Date]' + // x instanceof Date || + }; + + /* ___filename___: dist/deps/is/true.js */ + + /* ___filename___: dist/deps/is/boolean.js */ + + + + + /** + * @desc Checks if `value` is classified as a boolean primitive or object. + * @category Lang + * @since 3.0.0 + * + * @param {*} x value + * @return {boolean} isBoolean + * + * @extends isTrue + * @extends isFalse + * @see is/toS + * @memberOf is + * @func isBoolean + * + * @NOTE could also have typeof x === 'boolean' || (/true|false/).test(x) + * + * @example + * + * isBoolean(false) + * //=> true + * isBoolean(new Boolean(1)) + * //=> true + * isBoolean(1) + * //=> false + * isBoolean('') + * //=> false + * + */ + var boolean_1 = function isBoolean(x) { + return _true(x) || _false(x) || toS(x) === '[object Boolean]' + }; + + /* ___filename___: dist/deps/is/array.js */ + + /* ___filename___: dist/deps/util/simpleKindOf.js */ + + + + /* prettier-ignore */ + /** + * @desc when Array -> 'array' + * when null -> 'null' + * else `typeof x` + * @param {any} x + * @return {string} type + */ + var simpleKindOf = function (x) { + return array(x) + ? 'array' + : _null(x) + ? 'null' + : typeof x + }; + + /* ___filename___: dist/deps/conditional/includes/includes.js */ + var includes = function (haystack, needle) { return haystack.includes(needle); }; + + /* ___filename___: dist/deps/conditional/includes/includes.js */ + + var index$4 = includes; + + /* ___filename___: dist/deps/dopemerge/emptyTarget.js */ + + + /** + * @desc make a new empty Array or Object for cloning + * @memberOf dopemerge + * @name emptyTarget + * @since 2.0.0 + * @func + * + * @param {*} val array or object to return an empty one of + * @return {Object | Array} depending on the data type of val + * + * @example + * + * emptyTarget({eh: true}) + * //=> {} + * + * emptyTarget([1]) + * //=> [] + * + */ + var emptyTarget = function emptyTarget(val) { + return array(val) ? [] : {} + }; + + /* ___filename___: dist/deps/is/objNotNull.js */ + + /* ___filename___: dist/deps/is/regexp.js */ + + /* ___filename___: dist/deps/is/date.js */ + + /* ___filename___: dist/deps/is/boolean.js */ + + /* ___filename___: dist/deps/util/simpleKindOf.js */ + + /* ___filename___: dist/deps/dopemerge/emptyTarget.js */ + + /* ___filename___: dist/deps/dopemerge/dopemerge.js */ + /* eslint complexity: "OFF" */ + + + + + + + + + + + + + + + /** + * @desc 1: not null object + * 2: object toString is not a date or regex + * + * @category merge + * @memberOf dopemerge + * + * @since 2.0.0 + * @param {*} x value to check + * @return {boolean} + * + * @example + * + * isMergeableObj({}) + * //=> true + * + * isMergeableObj(Object.create(null)) + * // => true + * + * isMergeableObj(new Date()) + * //=> false + * + * isMergeableObj(/eh/) + * //=> false + * + */ + function isMergeableObj(x) { + return objNotNull(x) && !regexp(x) && !date(x) + } + + /** + * Defaults to `false`. + * If `clone` is `true` then both `x` and `y` are recursively cloned as part of the merge. + * + * @memberOf dopemerge + * @since 2.0.0 + * + * @param {*} value value to clone if needed + * @param {DopeMergeOptions} optsArg dopemerge options, could contain .clone + * @return {Object | Array | any} cloned or original value + * + * @see emptyTarget + * @see isMergeableObj + * + * @example + * + * var obj = {eh: true} + * + * cloneIfNeeded(obj, {clone: true}) === obj + * //=> false + * + * cloneIfNeeded(obj, {clone: false}) === obj + * //=> true + * + */ + function cloneIfNeeded(value, optsArg) { + return _true(optsArg.clone) && isMergeableObj(value) + ? deepmerge(emptyTarget(value), value, optsArg) + : value + } + + /* prettier-ignore */ + /** + * The merge will also merge arrays and array values by default. + * However, there are nigh-infinite valid ways to merge arrays, + * and you may want to supply your own. + * You can do this by passing an `arrayMerge` function as an option. + * + * @memberOf dopemerge + * @since 2.0.0 + * + * @param {*} target array merged onto, could be emptyTarget if cloning + * @param {*} source original source array + * @param {*} optsArg dopemerge options + * @return {Array | *} merged array + * + * @example + * + * function concatMerge(destinationArray, sourceArray, options) { + * destinationArray + * //=> [1, 2, 3] + * + * sourceArray + * //=> [3, 2, 1] + * + * options + * //=> { arrayMerge: concatMerge } + * + * return destinationArray.concat(sourceArray) + * } + * merge([1, 2, 3], [3, 2, 1], { arrayMerge: concatMerge }) + * //=> [1, 2, 3, 3, 2, 1] + * + */ + function defaultArrayMerge(target, source, optsArg) { + var destination = target.slice(); + + for (var i = 0; i < source.length; i++) { + var v = source[i]; + if (_undefined(destination[i])) { + destination[i] = cloneIfNeeded(v, optsArg); + } + else if (isMergeableObj(v)) { + destination[i] = deepmerge(target[i], v, optsArg); + } + // @see https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Operators/Bitwise_Operators#Bitwise_NOT + // === -1 + // eslint-disable-next-line prefer-includes/prefer-includes + else if (!~target.indexOf(v)) { + destination.push(cloneIfNeeded(v, optsArg)); + } + } + return destination + } + + function mergeObj(target, source, optsArg) { + var destination = {}; + if (isMergeableObj(target)) { + var targetKeys = keys(target); + for (var k = 0; k < targetKeys.length; k++) { + destination[targetKeys[k]] = cloneIfNeeded(target[targetKeys[k]], optsArg); + } + } + var sourceKeys = keys(source); + for (var s = 0; s < sourceKeys.length; s++) { + var key = sourceKeys[s]; + if (!isMergeableObj(source[key]) || !target[key]) { + destination[key] = cloneIfNeeded(source[key], optsArg); + } + else { + destination[key] = deepmerge(target[key], source[key], optsArg); + } + } + + return destination + } + + function deepmerge(target, source, optsArg) { + if (array(source)) { + var arrayMerge = optsArg.arrayMerge; + return array(target) + ? arrayMerge(target, source, optsArg) + : cloneIfNeeded(source, optsArg) + } + + // else + return mergeObj(target, source, optsArg) + } + + /* prettier-ignore */ + /** + * Merge the enumerable attributes of two objects deeply. + * Merge two objects `x` and `y` deeply, returning a new merged object with the + * elements from both `x` and `y`. + * If an element at the same key is present for both `x` and `y`, the value from + * `y` will appear in the result. + * Merging creates a new object, so that neither `x` or `y` are be modified. + * However, child objects on `x` or `y` are copied over - + * if you want to copy all values, you must pass `true` to the clone option. + * + * + * @member dopemerge + * @category merge + * + * @param {*} obj1 left + * @param {*} obj2 right + * @param {*} opts dopemerge options + * @return {Object | Array | any} merged + * + * {@link https://github.com/KyleAMathews/deepmerge deepmerge} + * @see {@link deepmerge} + * + * @types dopemerge + * @tests deepmerge + * + * @example + * + * var x = { + * foo: {bar: 3}, + * array: [{ + * does: 'work', + * too: [1, 2, 3], + * }], + * } + * + * var y = { + * foo: {baz: 4}, + * quux: 5, + * array: [ + * { + * does: 'work', + * too: [4, 5, 6], + * }, + * { + * really: 'yes', + * }, + * ], + * } + * + * var expected = { + * foo: { + * bar: 3, + * baz: 4, + * }, + * array: [ + * { + * does: 'work', + * too: [1, 2, 3, 4, 5, 6], + * }, + * { + * really: 'yes', + * }, + * ], + * quux: 5, + * } + * + * merge(x, y) + * //=> expected + * + */ + function dopemerge(obj1, obj2, opts) { + // if they are identical, fastest === check + if (obj1 === obj2) { + return obj1 + } + + // setup options + var options = assign( + { + arrayMerge: defaultArrayMerge, + stringToArray: true, + boolToArray: false, + ignoreTypes: ['null', 'undefined'], + // debug: true, + }, + opts || {} + ); + var ignoreTypes = options.ignoreTypes; + var stringToArray = options.stringToArray; + var boolToArray = options.boolToArray; + var clone = options.clone; + + // @NOTE: much better size but oh well + // const ignoreTypes = ['null', 'undefined'] + // const stringToArray = true + // const boolToArray = false + // const clone = true + + // check one then check the other + if (_true(index$4(ignoreTypes, simpleKindOf(obj1)))) { + return obj2 + } + else if (_true(index$4(ignoreTypes, simpleKindOf(obj2)))) { + return obj1 + } + else if (boolean_1(obj1) && boolean_1(obj2)) { + // @NOTE uglifier optimizes into a wicked ternary + return boolToArray ? [obj1, obj2] : obj2 + } + else if (string(obj1) && string(obj2)) { + return stringToArray ? [obj1, obj2] : obj1 + obj2 + } + else if (array(obj1) && string(obj2)) { + return (clone ? obj1.slice(0) : obj1).concat([obj2]) + } + else if (string(obj1) && array(obj2)) { + return (clone ? obj2.slice(0) : obj2).concat([obj1]) + } + else { + return deepmerge(obj1, obj2, options) + } + } + + var dopemerge_1 = dopemerge; + + /* ___filename___: dist/deps/dopemerge/dopemerge.js */ + + var index$2 = dopemerge_1; + + /* ___filename___: dist/deps/util/from.js */ + /** + * @tutorial https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/from + * @see https://github.com/lodash/lodash/blob/master/.internal/setToArray.js + * ^ could use if needed + */ + var from = Array.from; + + /* ___filename___: dist/deps/util/from.js */ + + /* ___filename___: dist/deps/reduce/reduce.js */ + + + /** + * @desc Map -> Object + * @since 4.0.0 + * + * @param {Map} map map to reduce, calls entries, turns into an array, then object + * @return {Object} reduced object + * + * @see ArrayFrom + * + * @example + * + * var emptyMap = new Map() + * reduce(emptyMap) + * // => {} + * + * @example + * + * var map = new Map() + * map.set('eh', 1) + * reduce(map) + * // => {eh: 1} + * + */ + var reduce = function (map) { + var reduced = {}; + + // only need to do this if we actually have values in our Map + if (map.size !== 0) { + reduced = from(map.entries()).reduce(function (acc, ref) { + var key = ref[0]; + var value = ref[1]; + + acc[key] = value; + return acc + }, reduced); + } + + return reduced + }; + + /* ___filename___: dist/deps/reduce/reduce.js */ + + var index$6 = reduce; + + /* ___filename___: dist/deps/is/obj.js */ + + + + + /** + * @func isObj + * + * Checks if `value` is the + * [language type](http://www.ecma-international.org/ecma-262/7.0/#sec-ecmascript-language-types) + * of `Object`. (e.g. arrays, functions, objects, regexes, `new Number(0)`, and `new String('')`) + * + * @since 3.0.0 + * @category Lang + * + * @param {*} value The value to check. + * @return {boolean} Returns `true` if `value` is an object, else `false`. + * + * @memberOf is + * @see http://stackoverflow.com/questions/34111902/why-do-lodashs-isobject-isplainobject-behave-differently-than-typeof-x + * @see https://github.com/lodash/lodash/blob/master/isObject.js + * @NOTE Object.prototype.toString.call(val) === '[object Object]' + * + * @example + * + * isObject({}) + * // => true + * + * isObject([1, 2, 3]) + * // => true + * + * isObject(Function) + * // => true + * + * isObject(null) + * // => false + * + */ + var obj = function (x) { return !_null(x) && (objTypeof(x) || _function(x)); }; + + /* ___filename___: dist/deps/is/obj.js */ + + /* ___filename___: dist/deps/reduce/entries.js */ + + + + + + + /** + * @desc recursively reduce maps and objects that include reducable data + * @since 4.0.0 + * + * @sig reduced => object => isMap(object) -> reduced; merge(object, reduced) + * + * @param {Object | any} reduced merged object and reduced + * @return {Function} Function(values: Object) + * + * @see https://www.airpair.com/javascript/javascript-array-reduce + * @see ChainedMap + * + * @example + * + * const map = new Map() + * map.set('eh', true) + * const nested = new Map() + * nested.set('reduced', true) + * + * const chain = { + * entries() { + * return { + * nested: reduce(nested), + * key: true, + * } + * }, + * } + * const reduced = reduce(map) + * reduceEntries(reduced)({chain}) + * // => { + * eh: true, + * chain: { + * nested: { + * reduced: true, + * key: true, + * }, + * }, + * } + * + * @example + * + * const reducedIgnored = { + * canada: { + * store: chain, + * }, + * } + * const ignored = reduceEntries(reduced)(reducedIgnored) + * //=> { + * eh: true, + * chain: { + * nested: { + * reduced: true, + * }, + * key: true, + * }, + * } + * + */ + var entries = function (reduced) { return function (obj$$1) { + var keys$$2 = keys(obj$$1); + + for (var k = 0; k < keys$$2.length; k++) { + var key = keys$$2[k]; + + if (ignored(key)) { + continue + } + + var value = obj$$1[key]; + if (obj(value) && _function(value.entries)) { + assign(reduced, {[key]: value.entries(true) || {}}); + } + } + + return reduced + }; }; + + /* ___filename___: dist/deps/is/iterator.js */ + + + /** + * @param {*} x value + * @return {boolean} isIterator + * + * @since 3.0.0 + * @memberOf is + * @func isIterator + * @see https://github.com/jonschlinkert/kind-of/pull/12 + * + * @example + * + * isIterator(new Set().values()) + * //=> true + * isIterator(new Map.entries()) + * //=> true + * isIterator(new Map()) + * //=> false + * isIterator('') + * //=> false + * isIterator(1) + * //=> false + * + * @example + * + * const e = {} + * eh[Symbol.toStringTag] = '[Map Iterator]' + * isIterator(eh) + * //=> true + * eh[Symbol.toStringTag] = '[Set Iterator]' + * isIterator(eh) + * //=> true + * + * @example + * + * class Eh extends Set() + * isIterator(new Eh().values()) + * //=> true + * + */ + // eslint-disable-next-line + var iterator$2 = function (x) { return ~toS(x).indexOf('Iterator'); }; + + /* ___filename___: dist/deps/is/iterator.js */ + + /* ___filename___: dist/deps/to-arr.js */ + + + + + + + + /** + * @desc anything into an array + * @sig * => Array + * @since 0.0.1 + * + * @param {any} ar turn this into an array + * @return {Array} anything into an array + * + * @tests deps/to-arr + * @types deps + * + * @example + * + * toarr([]) + * // => [] + * + * toarr('') + * // => [''] + * + * toarr('1,2') + * // => ['1', '2'] + * + * toarr('1,2') + * // => ['1', '2'] + * + * const map = new Map() + * map.set('eh', true) + * const arr = toarr(map.entries()) + * // => ['eh', true] + * + * const set = new Set() + * set.add('eh') + * set.add(true) + * const arr = toarr(map.entries()) + * // => ['eh', true] + * + * toarr('').concat(toarr(false)).concat(toarr(null)) + * // => ['', false, null] + * + */ + var toArr = function(ar) { + // @NOTE: !'' === true + if (stringPrimitive(ar)) { return ar.includes(',') ? ar.split(',') : [ar] } + else if (!ar) { return [ar] } + else if (array(ar)) { return ar } + else if (set(ar) || map(ar) || ar.values) { + /** + * @desc when using `new Set().values`... no forEach o.o + * .values is also on `Object`... + */ + return from(ar.values(ar)) + } + else if (iterator$2(ar)) { return from(ar) } + else { return [ar] } + }; + + /* ___filename___: dist/deps/to-arr.js */ + + /* ___filename___: dist/deps/concat.js */ + + + /** + * @desc conat two values, coerce to arrays + * @since 4.0.0 + * + * @func + * @name concat + * + * @param {Array | *} one toArr1 + * @param {Array | *} two toArr2 + * @return {Array} [one, two] + * + * @example + * + * concat([1], [2]) //=> [1, 2] + * concat([1], 2) //=> [1, 2] + * concat(1, 2) //=> [1, 2] + * concat(new Set([1]), 2) //=> [1, 2] + * + * // kind of weird... + * concat(null, 2) //=> [2] + * concat(undefined, 2) //=> [2] + * concat(1, null) //=> [1, null] + * + */ + var concat = function (one, two) { return toArr(one || []).concat(toArr(two)); }; + + /* ___filename___: dist/deps/fp/always.js */ + /** + * Returns a function that always returns the given value. Note that for + * non-primitives the value returned is a reference to the original value. + * + * This function is known as `const`, `constant`, or `K` (for K combinator) in + * other languages and libraries. + * + * @alias always + * @alias constant + * @func + * @memberOf fp + * @since v5.0.0 + * @category Function + * @sig a -> (* -> a) + * + * @param {*} value The value to wrap in a function + * @return {Function} A Function :: * -> val. + * + * @see https://github.com/ramda/ramda/issues/1038 + * @see https://github.com/ramda/ramda/blob/master/src/always.js + * + * @example + * + * var t = always('Tee'); + * t(); //=> 'Tee' + * + */ + + /* ___filename___: dist/deps/meta/transformers.js */ + /* istanbul ignore next: wip build */ + var transformers = process.env.NODE_ENV === 'production' + ? 'transformers' + : 'transformers'; + + /* ___filename___: dist/deps/meta/observers.js */ + /* istanbul ignore next: wip build */ + var observers = process.env.NODE_ENV === 'production' + ? 'observers' + : 'observers'; + + /* ___filename___: dist/deps/meta/shorthands.js */ + /* istanbul ignore next: wip build */ + var shorthands = process.env.NODE_ENV === 'production' + ? 'shorthands' + : 'shorthands'; + + /* ___filename___: dist/deps/meta/decorated.js */ + /* istanbul ignore next: wip build */ + var decorated = process.env.NODE_ENV === 'production' + ? 'decorated' + : 'decorated'; + + /* ___filename___: dist/deps/concat.js */ + + /* ___filename___: dist/deps/fp/always.js */ + + /* ___filename___: dist/deps/meta/transformers.js */ + + /* ___filename___: dist/deps/meta/observers.js */ + + /* ___filename___: dist/deps/meta/shorthands.js */ + + /* ___filename___: dist/deps/meta/decorated.js */ + + /* ___filename___: dist/deps/meta/meta.js */ + // without it, the arguments & caller are uglier when drbugging + + + + + + + + + + + + + + // will expand this later + var isInKeyMapAsSet = function (x) { return x === observers; }; + var emptyArray = []; // always([]) + + // @NOTE: using `[]` deopts o.o + // eslint-disable-next-line + // this.shorthands = new Array() + + /** + * @since 4.0.0 + * @param {Chain} _this + * @return {Chain} + */ + function getMeta(_this) { + // if we already have it, keep it + if (_this.meta) { return _this.meta } + + // the store + // shorthands: key -> method + var store = {}; + + // --- uglifiable functions + + /** @desc initialize the store maps when we need them */ + /* prettier-ignore */ + var ensureInitialized = function (name, value) { + if (!_undefined(store[name])) { return } + + // if ( + // name === TRANSFORMERS_KEY || + // name === SHORTHANDS_KEY || + // name === DECORATED_KEY + // ) { + // store[name] = new Map() + // } + // else + if (isInKeyMapAsSet(name)) { + store[name] = new Set(); + } + else { + store[name] = new Map(); + } + }; + + /** + * @since 4.0.0 + * @param {Primitive} key + * @param {Primitive | undefined} [prop=undefined] + * @return {boolean} + */ + var has = function (key, prop) { + if (_undefined(prop)) { return !!store[key].size } + else { return store[key].has(prop) } + }; + /** + * @since 4.0.0 + * @param {Primitive} key + * @param {Primitive | undefined} [prop=undefined] + * @return {any} + */ + var get = function (key, prop) { return (has(key, prop) ? store[key].get(prop) : emptyArray); }; + + /** + * @since 4.0.0 + * @param {Primitive} key + * @param {Primitive | undefined} [prop=undefined] + * @param {Primitive | undefined} [value=undefined] + * @return {void} + */ + var set$$2 = function (key, prop, value) { + var storage = store[key]; + // when it's a set, we have no `prop`, we just have .add + // so `prop = value` && `value = undefined` + if (set(storage)) { + storage.add(prop); + } + else { + // if (!has(key, prop)) return + var existing = storage.get(prop); + var val = concat(existing, value); + storage.set(prop, val); + } + }; + + /** + * @since 4.0.0 + * + * @desc a single easily minifiable function, + * dynamically setting & getting depending on arguments + * to avoid nested property accessing + * only instantiating when values are **addded** + * + * @param {Primitive} key + * @param {Primitive | undefined} [prop=undefined] + * @param {undefined | any} [value=undefined] (when no value, it's a getter) + * @return {Array | Chain} depending on args + */ + function meta(key, prop, value) { + if (process.env.NODE_ENV === 'DEBUG') { + console.log('USING META', {key: key, prop: prop, value: value}); + } + + /* prettier-ignore */ + if (_undefined(value)) { + // when we want to just access the property, return an array + // @example `.meta('transformers')` + if (_undefined(prop)) { + if (_undefined(store[key])) { return emptyArray } + else { return store[key].size === 0 ? emptyArray : from(store[key].values()) } + } + // we have `key, prop` + // + // 1: should `prop` be a value, (isSet?) + else if (isInKeyMapAsSet(key)) { + ensureInitialized(key); + set$$2(key, prop); + } + // 2: prop is a key, we want to return the [..] for that specific property + // @example `.meta('transformers', 'eh')` + else if (_undefined(store[key])) { return emptyArray } + else { return toArr(get(key, prop)) } + } + // we have `key, prop, value` + else { + ensureInitialized(key); + // we have a value, let's add it + set$$2(key, prop, value); + } + return _this + } + + // for debugging + meta.store = store; + // meta.debug = false + + return meta + } + + var meta = getMeta; + + /* ___filename___: dist/deps/meta/meta.js */ + + var index$8 = meta; + + /* ___filename___: dist/Chainable.js */ + + /* ___filename___: dist/deps/reduce/entries.js */ + + /* ___filename___: dist/ChainedMapBase.js */ + + + + + + + + + + + /** + * this is to avoid circular requires + * because MergeChain & MethodChain extend this + * yet .method & .merge use those chains + * ...also, it serves as a non-references creator for extending new instances + * of Chainable, where it splits into (Map | Set) -> composed prototype decorators + * + * + * @file + * @since 4.0.0-alpha.1 + * @inheritdoc + * @class ChainedMapBase + * @member ChainedMapBase + * @category Chainable + * @extends {Chainable} + * @type {Chainable} + * + * @types ChainedMapBase + * @tests ChainedMap + * + * @prop {Meta} meta meta fn + * @prop {Map} store main store + * + * {@link https://tc39.github.io/ecma262/#sec-map-objects emca-map} + * {@link https://ponyfoo.com/articles/es6-maps-in-depth pony-map} + * {@link https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Map mozilla-map} + * @see {@link pony-map} + * @see {@link mozilla-map} + * @see {@link emca-map} + * + * @see ChainedMap + * @see Chainable + * @see MergeChain + * @see MethodChain + * @see ChainedMap + * + */ + + var ComposeChainedMapBase = function (Target) { + return (function (Target) { + function ChainedMapBase(parent) { + Target.call(this, parent); + + this.store = new Map(); + this.meta = index$8(this); + } + + if ( Target ) ChainedMapBase.__proto__ = Target; + ChainedMapBase.prototype = Object.create( Target && Target.prototype ); + ChainedMapBase.prototype.constructor = ChainedMapBase; + + /** + * @desc tap a value with a function + * @modifies this.store.get(name) + * @memberOf ChainedMapBase + * @version 0.7.0 + * @since 4.0.0-alpha.1 <- moved from transform & shorthands + * + * @param {string | any} name key to `.get` + * @param {Function} fn function to tap with + * @return {Chain} @chainable + * + * {@link https://github.com/sindresorhus/awesome-tap awesome-tap} + * {@link https://github.com/midknight41/map-factory map-factory} + * {@link https://github.com/webpack/tapable tapable} + * @see {@link tapable} + * + * @see ChainedMapBase.set + * @see ChainedMapBase.get + * + * @example + * + * chain + * .set('moose', {eh: true}) + * .tap('moose', moose => {moose.eh = false; return moose}) + * .get('moose') + * + * // => {eh: false} + * + * @example + * + * const entries = new Chain() + * .set('str', 'emptyish') + * .tap('str', str => str + '+') + * .set('arr', [1]) + * .tap('arr', arr => arr.concat([2])) + * .entries() + * + * //=> {str: 'emptyish+', arr: [1, 2]} + * + */ + ChainedMapBase.prototype.tap = function tap (name, fn) { + return this.set(name, fn(this.get(name), index$2)) + }; + + /** + * @desc checks each property of the object + * calls the chains accordingly + * + * @memberOf ChainedMapBase + * @since 0.5.0 + * + * @param {Object} obj object with functions to hydrate from + * @return {Chainable} @chainable + * + * @TODO could also add parsing stringified + * + * @example + * + * const from = new Chain().from({eh: true}) + * const eh = new Chain().set('eh', true) + * eq(from, eh) + * // => true + * + */ + ChainedMapBase.prototype.from = function from (obj) { + var this$1 = this; + + var keys$$1 = keys(obj); + + for (var k = 0; k < keys$$1.length; k++) { + var key = keys$$1[k]; + var value = obj[key]; + var fn = this$1[key]; + + if (fn && fn.merge) { + fn.merge(value); + } + else if (_function(fn)) { + fn.call(this$1, value); + } + else { + this$1.set(key, value); + } + } + + return this + }; + + /** + * @desc shorthand methods, from strings to functions that call .set + * @since 0.4.0 + * @memberOf ChainedMapBase + * + * @param {Array} methods decorates/extends an object with new shorthand functions to get/set + * @return {ChainedMapBase} @chainable + * + * @example + * + * const chain1 = new Chain() + * chain1.extend(['eh']) + * + * const chain2 = new Chain() + * chain2.eh = val => this.set('eh', val) + * + * eq(chain2.eh, chain1.eh) + * //=> true + * + */ + ChainedMapBase.prototype.extend = function extend (methods) { + var this$1 = this; + + methods.forEach(function (method) { + this$1.meta(shorthands, method); + this$1[method] = function (value) { return this$1.set(method, value); }; + }); + return this + }; + + /** + * @desc spreads the entries from ChainedMapBase.store (Map) + * return store.entries, plus all chain properties if they exist + * + * @memberOf ChainedMapBase + * @version 4.0.0 <- improved reducing + * @since 0.4.0 + * + * @param {boolean} [chains=false] if true, returns all properties that are chains + * @return {Object} reduced object containing all properties from the store, and when `chains` is true, all instance properties, and recursive chains + * + * // + * + * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/entries mozilla-map-entries} + * @see {@link mozilla-map-entries} + * + * @example + * + * map.set('a', 'alpha').set('b', 'beta').entries() + * //=> {a: 'alpha', b: 'beta'} + * + */ + ChainedMapBase.prototype.entries = function entries$$1 (chains) { + var reduced = index$6(this.store); + if (_undefined(chains)) { return reduced } + + var reducer = entries(reduced); + reducer(this); + reducer(reduced); + return reduced + }; + + /** + * @desc get value for key path in the Map store + * ❗ `debug` is a special key and is *not* included into .store + * it goes onto .meta + * + * @memberOf ChainedMapBase + * @version 4.0.0 <- moved debug here + * @since 0.4.0 + * + * @param {Primitive} key Primitive data key used as map property to reference the value + * @return {any} value in .store at key + * + * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/get mozilla-map-get} + * @see {@link mozilla-map-get} + * + * @example + * + * const chain = new Chain() + * chain.set('eh', true) + * chain.get('eh') + * //=> true + * + * chain.get('nope') + * //=> undefined + * + */ + ChainedMapBase.prototype.get = function get (key) { + if (key === 'debug') { return this.meta.debug } + return this.store.get(key) + }; + + /** + * @desc sets the value using the key on store + * adds or updates an element with a specified key and value + * + * @memberOf ChainedMapBase + * @since 0.4.0 + * + * @param {Primitive} key Primitive to reference the value + * @param {any} value any data to store + * @return {ChainedMapBase} @chainable + * + * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/set mozilla-map-set} + * + * @see {@link mozilla-map-set} + * @see ChainedMapBase.store + * + * @example + * + * const chain = new Chain() + * chain.set('eh', true) + * chain.get('eh') + * //=> true + * + */ + ChainedMapBase.prototype.set = function set (key, value) { + this.store.set(key, value); + return this + }; + + return ChainedMapBase; + }(Target)) + }; + + /** + * @desc ChainedMapBase composer + * @alias ComposeMap + * @type {Composer} + * @method compose + * @memberOf ChainedMapBase + * + * @param {Class | Object | Composable} [Target=Chainable] class to extend + * @return {Class} ChainedMapBase + * + * @example + * + * const heh = class {} + * const composed = ChainedMapBase.compose(heh) + * const hehchain = new Composed() + * hehchain instanceof heh + * //=> true + * + */ + var cmc = ComposeChainedMapBase(Chainable); + cmc.compose = ComposeChainedMapBase; + + var ChainedMapBase = cmc; + + /* ___filename___: dist/deps/env/debug.js */ + var debug = process.env.NODE_ENV === 'debug'; // || process.env.DEBUG = true + + /* ___filename___: dist/deps/util/keysObjOrArray.js */ + + + + + /** + * Creates an array of the own enumerable property names of `object`. + * + * **Note:** Non-object values are coerced to objects. See the + * [ES spec](http://ecma-international.org/ecma-262/7.0/#sec-object.keys) + * for more details. + * + * @since 0.1.0 + * @category Object + * + * @param {Object} object The object to query. + * @return {Array} Returns the array of property names. + * + * @see deps/util/props + * @see values, valuesIn + * @see https://github.com/lodash/lodash/blob/master/.internal/getAllKeys.js + * @see https://github.com/lodash/lodash/blob/master/keys.js + * @TODO https://github.com/lodash/lodash/blob/master/.internal/arrayLikeKeys.js + * + * @example + * + * function Foo() { + * this.a = 1 + * this.b = 2 + * } + * + * Foo.prototype.c = 3 + * + * keys(new Foo) + * // => ['a', 'b'] (iteration order is not guaranteed) + * + * keys('hi') + * // => ['0', '1'] + * + */ + + var zeroOneLength = function (obj$$2) { return (obj$$2.length > 1 ? obj$$2.length - 1 : obj$$2.length === 1 ? 1 : 0); }; + + var keysObjOrArray = function keys$$2(obj$$2) { + return array(obj$$2) + ? new Array(zeroOneLength(obj$$2)) + : obj(obj$$2) ? keys(obj$$2) : [] + + // for (var key in obj) gathered.push(key) + // return gathered + }; + + /* ___filename___: dist/deps/util/keysObjOrArray.js */ + + /* ___filename___: dist/deps/is/empty.js */ + + + + + + /* prettier-ignore */ + /** + * Returns `true` if the given value is its type's empty value; + * `false` otherwise. + * + * @func + * @memberOf is + * @since v0.1.0 + * @category Logic + * @sig a -> Boolean + * + * @param {*} x value to check if empty + * @return {boolean} + * + * @see empty + * @see https://github.com/ramda/ramda/issues/1228 + * + * @example + * + * isEmpty([1, 2, 3]); //=> false + * isEmpty([]); //=> true + * isEmpty(''); //=> true + * isEmpty(null); //=> false + * isEmpty({}); //=> true + * isEmpty({length: 0}); //=> false + * + */ + var empty = function isEmpty(x) { + if (x === '') { return true } + else if (nullOrUndefined(x)) { return false } + else if (obj(x) || array(x)) { return keysObjOrArray(x).length === 0 } + else { return false } + + // else return ( + // // null|undefined = empty + // // isNullOrUndefined(x) || + // // '' = empty + // // [] | {} = empty + // keys(x).length === 0 + // ) + }; + + /* ___filename___: dist/deps/is/error.js */ + + + /** + * @param {*} x value + * @return {boolean} isError + * + * @since 4.0.0 + * @memberOf is + * @func isError + * + * @example + * + * isError(new Error()) + * //=> true + * isError(new Error().stack) + * //=> false + * isError(1) + * //=> false + * isError('') + * //=> false + * + * @example + * + * const e = {} + * eh[Symbol.toStringTag] = '[Object Error]' + * isError(eh) + * //=> true + * + * @example + * + * class Eh extends Error() + * isError(new Eh()) + * //=> true + * + */ + var error$1 = function isError(x) { + // console.log('isError', toS(x), x) + return toS(x) === '[object Error]' + // x instanceof Error || + }; + + /* ___filename___: dist/deps/is/symbol.js */ + + + /** + * Checks if `value` is classified as a `Symbol` primitive or object. + * + * @since 4.0.0 + * @category Lang + * @memberOf is + * + * @param {*} value The value to check. + * @return {boolean} Returns `true` if `value` is a symbol, else `false`. + * + * @example + * + * isSymbol(Symbol.iterator) + * // => true + * + * isSymbol('abc') + * // => false + * + */ + var symbol = function (x) { return toS(x) === '[object Symbol]'; }; + + /* ___filename___: dist/deps/is/async.js */ + + + /** + * @category Lang + * + * @param {*} x value + * @return {boolean} isAsync + * @since 4.0.0-beta.2 + * + * @memberOf is + * @func isAsync + * + * @example + * + * isAsync(async function() {}) + * //=> true + * isAsync(new Promise(r => r())) + * //=> false + * isAsync({}) + * //=> false + * isAsync(function() {}) + */ + var async = function isAsync(x) { + return toS(x) === '[object AsyncFunction]' + }; + + /* ___filename___: dist/deps/is/promise.js */ + + + /** + * @desc is a Promise + * @param {*} x value + * @return {boolean} x isPromise + * + * @since 4.0.0-beta.2 + * @memberOf is + * @func isPromise + * + * @see https://github.com/jonschlinkert/kind-of/blob/master/index.js#L66 + * @see https://github.com/sindresorhus/promise-fun + * + * @example + * + * isPromise(new Promise(r => r)) + * //=> true + * isPromise(async function() {}) + * //=> false // on some environments, true + * + * isPromise({}) + * //=> false + * isPromise(Object.create(null)) + * //=> false + * isPromise(null) + * //=> false + * isPromise(new Set()) + * //=> false + * isPromise(function() {}) + * //=> false + * isPromise('') + * //=> false + * isPromise(1) + * //=> false + * + */ + var promise = function (x) { return toS(x) === '[object Promise]'; }; + + /* ___filename___: dist/deps/is/async.js */ + + /* ___filename___: dist/deps/is/promise.js */ + + /* ___filename___: dist/deps/is/asyncish.js */ + + + + /** + * @desc async function or promise + * @category Lang + * + * @param {*} x value + * @return {boolean} x isAsyncish + * @since 4.0.0-beta.2 + * + * @memberOf is + * @func isAsyncish + * @extends isAsyncish + * @extends isPromise + * @variation isAsyncish OR isPromise + * + * @example + * + * isAsyncish(async function() {}) + * //=> true + * isAsyncish(new Promise(r => r())) + * //=> true + * + * isAsyncish({}) + * //=> false + * isAsyncish(function() {}) + */ + var asyncish = function (x) { return async(x) || promise(x); }; + + /* ___filename___: dist/deps/is/numberPrimitive.js */ + /** + * @param {*} x value + * @return {boolean} isNumberPrimitive + * + * @since 3.0.0 + * @memberOf is + * @func isNumberPrimitive + * @see is/real + * + * @example + * + * isNumberPrimitive(1) + * //=> true + * isNumberPrimitive(Number(1)) + * //=> true + * isNumberPrimitive(NaN) + * //=> true + * isNumberPrimitive(new Number(1)) + * //=> false + * + * isNumberPrimitive(null) + * //=> false + * isNumberPrimitive(undefined) + * //=> false + * isNumberPrimitive(void 0) + * //=> false + * isNumberPrimitive({}) + * //=> false + * isNumberPrimitive('') + * //=> false + * isNumberPrimitive(false) + * //=> false + * + */ + var numberPrimitive = function (x) { return typeof x === 'number'; }; + + /* ___filename___: dist/deps/is/numberPrimitive.js */ + + /* ___filename___: dist/deps/is/primitive.js */ + + + + + + /** + * Checks if `value` is classified as a `String` **primitive**. + * + * @since 3.0.0 + * @category Lang + * @memberOf is + * @param {*} x The value to check. + * @returns {boolean} Returns `true` if `value` is a string, else `false`. + * + * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String + * @see https://github.com/lodash/lodash/blob/master/isString.js + * @see is/string + * + * @example + * + * isPrimitive('abc') // => true + * isPrimitive(new String('abc')) // => false + * isPrimitive(1) // => true + * isPrimitive([]) // => false + * isPrimitive('') // => true + * isPrimitive({}) // => false + * + */ + var primitive$2 = function isPrimitive(node) { + return ( + nullOrUndefined(node) || + stringPrimitive(node) || + numberPrimitive(node) || + boolean_1(node) // isBooleanPrimitive + ) + }; + + /* ___filename___: dist/deps/fp/isPlaceholder.js */ + var isPlaceholder = function _isPlaceholder(x) { + return x === '_' + }; + + /* ___filename___: dist/deps/fp/arity.js */ + /* istanbul ignore next: metadata, one is covered, all are covered */ + /* prettier-ignore */ + /** + * @desc just for `.length` of a function? + * @memberOf fp + * + * @since 5.0.0 + * @param {number} n number of arguments + * @param {Function} fn function to wrap + * @return {Function} function with params + * + * @TODO keeping this means change uglify... + * + * @example + * const wan = one => console.log(one) + * arity(1, wan) + * => function(one => wan(one)) + */ + var arity = function _arity(n, fn) { + /* eslint-disable no-unused-vars */ + if (n === 0) { return function() { return fn.apply(this, arguments) } } + else if (n === 1) { return function(a0) { return fn.apply(this, arguments) } } + else if (n === 2) { return function(a0, a1) { return fn.apply(this, arguments) } } + else if (n === 3) { return function(a0, a1, a2) { return fn.apply(this, arguments) } } + else if (n === 4) { return function(a0, a1, a2, a3) { return fn.apply(this, arguments) } } + else if (n === 5) { return function(a0, a1, a2, a3, a4) { return fn.apply(this, arguments) } } + else if (n === 6) { return function(a0, a1, a2, a3, a4, a5) { return fn.apply(this, arguments) } } + else if (n === 7) { return function(a0, a1, a2, a3, a4, a5, a6) { return fn.apply(this, arguments) } } + else if (n === 8) { return function(a0, a1, a2, a3, a4, a5, a6, a7) { return fn.apply(this, arguments) } } + else if (n === 9) { return function(a0, a1, a2, a3, a4, a5, a6, a7, a8) { return fn.apply(this, arguments) } } + else if (n === 10) { return function(a0, a1, a2, a3, a4, a5, a6, a7, a8, a9) { return fn.apply(this, arguments) } } + }; + + /* ___filename___: dist/deps/fp/isPlaceholder.js */ + + /* ___filename___: dist/deps/fp/arity.js */ + + /* ___filename___: dist/deps/fp/curry.js */ + + + + + /** + * Returns a curried equivalent of the provided function, with the specified + * arity. The curried function has two unusual capabilities. First, its + * arguments needn't be provided one at a time. If `g` is `R.curryN(3, f)`, the + * following are equivalent: + * + * - `g(1)(2)(3)` + * - `g(1)(2, 3)` + * - `g(1, 2)(3)` + * - `g(1, 2, 3)` + * + * Secondly, the special placeholder value [`R.__`](#__) may be used to specify + * "gaps", allowing partial application of any combination of arguments, + * regardless of their positions. If `g` is as above and `_` is [`R.__`](#__), + * the following are equivalent: + * + * - `g(1, 2, 3)` + * - `g(_, 2, 3)(1)` + * - `g(_, _, 3)(1)(2)` + * - `g(_, _, 3)(1, 2)` + * - `g(_, 2)(1)(3)` + * - `g(_, 2)(1, 3)` + * - `g(_, 2)(_, 3)(1)` + * + * @func + * @memberOf fp + * @since v0.5.0 + * @category Function + * @sig Number -> (* -> a) -> (* -> a) + * + * @param {Number} length The arity of the curried function. + * @param {Array} received An array of arguments received thus far. + * @param {Function} fn The function to curry. + * @return {Function} A new, curried function. + * + * @see R.curry + * + * @example + * + * var sumArgs = (...args) => R.sum(args); + * + * var curriedAddFourNumbers = R.curryN(4, sumArgs); + * var f = curriedAddFourNumbers(1, 2); + * var g = f(3); + * g(4); //=> 10 + * + */ + function _curryN(length, received, fn) { + return function() { + var arguments$1 = arguments; + + var combined = []; + var argsIdx = 0; + var left = length; + var combinedIdx = 0; + + while (combinedIdx < received.length || argsIdx < arguments.length) { + var result = (void 0); + + if ( + combinedIdx < received.length && + (!isPlaceholder(received[combinedIdx]) || argsIdx >= arguments$1.length) + ) { + result = received[combinedIdx]; + } + else { + result = arguments$1[argsIdx++]; + // argsIdx += 1 + } + combined[combinedIdx++] = result; + if (!isPlaceholder(result)) { + left -= 1; + } + // combinedIdx += 1 + } + return left <= 0 + ? fn.apply(this, combined) + : arity(left, _curryN(length, combined, fn)) + } + } + + /** + * Returns a curried equivalent of the provided function, with the specified + * arity. The curried function has two unusual capabilities. First, its + * arguments needn't be provided one at a time. If `g` is `R.curryN(3, f)`, the + * following are equivalent: + * + * - `g(1)(2)(3)` + * - `g(1)(2, 3)` + * - `g(1, 2)(3)` + * - `g(1, 2, 3)` + * + * Secondly, the special placeholder value [`R.__`](#__) may be used to specify + * "gaps", allowing partial application of any combination of arguments, + * regardless of their positions. If `g` is as above and `_` is [`R.__`](#__), + * the following are equivalent: + * + * - `g(1, 2, 3)` + * - `g(_, 2, 3)(1)` + * - `g(_, _, 3)(1)(2)` + * - `g(_, _, 3)(1, 2)` + * - `g(_, 2)(1)(3)` + * - `g(_, 2)(1, 3)` + * - `g(_, 2)(_, 3)(1)` + * + * @func + * @memberOf fp + * @since v0.5.0 + * @category Function + * @sig Number -> (* -> a) -> (* -> a) + * + * @param {Number} length The arity for the returned function. + * @param {Function} fn The function to curry. + * @return {Function} A new, curried function. + * + * @see ramda + * + * @example + * + * var sumArgs = (...args) => R.sum(args); + * + * var curriedAddFourNumbers = R.curryN(4, sumArgs); + * var f = curriedAddFourNumbers(1, 2); + * var g = f(3); + * g(4); //=> 10 + * + */ + var curry = function curryN(length, fn) { + return arity(length, _curryN(length, [], fn)) + }; + + /* ___filename___: dist/deps/fp/curry.js */ + + /* ___filename___: dist/deps/fp/prop.js */ + + + /** + * Returns a function that when supplied an object returns the indicated + * property of that object, if it exists. + * + * @func + * @memberOf fp + * @since v5.0.0 + * @category Object + * @sig s -> {s: a} -> a | Undefined + * + * @param {String} p The property name + * @param {Object} obj The object to query + * @return {*} The value at `obj.p`. + * + * @see R.path + * + * @example + * + * R.prop('x', {x: 100}); //=> 100 + * R.prop('x', {}); //=> undefined + * + */ + var prop = curry(2, function (p, obj) { return obj[p]; }); + + /* ___filename___: dist/deps/fp/prop.js */ + + /* ___filename___: dist/deps/util/length.js */ + + + // reduces size by hundreds of bytes gzipped... + var length = prop('length'); + + /* ___filename___: dist/deps/util/length.js */ + + /* ___filename___: dist/deps/util/lengthMinusOne.js */ + + + // lengthMinusOne + var lengthMinusOne = function (x) { return length(x) - 1; }; + + /* ___filename___: dist/deps/util/lengthMinusOne.js */ + + /* ___filename___: dist/deps/dot/segments.js */ + + + + + var cache; + + /** + * @name dotPropSegments + * @since 4.0.0 + * @memberOf dot + * + * @param {string | Array} path dot-prop-path + * @return {Array} array path + * + * @example + * + * dotPropSegments('eh.oh') //=> ['eh', 'oh'] + * dotPropSegments(['eh', 'oh']) //=> ['eh', 'oh'] + * dotPropSegments('ehoh') //=> ['ehoh'] + * + */ + var segments = function (path) { + if (!cache) { cache = new Map(); } + if (cache.has(path)) { return cache.get(path) } + if (array(path)) { return path } + + var pathArr = path.split('.'); + var parts = []; + + for (var i = 0; i < pathArr.length; i++) { + var p = pathArr[i]; + + /** + * @example 1 + * '\.eh' -1 === '\\' (true) + * +1 !== undefined (true, eh) + * + * @example 2 + * '.eh' -1 === '\\' (false, undefined) + * +1 !== undefined (true, eh) + * + * @example 3 + * '\.' -1 === '\\' (true) + * +1 !== undefined (false, eh) + */ + while (p[lengthMinusOne(p)] === '\\' && !_undefined(pathArr[i + 1])) { + p = p.slice(0, -1) + '.' + pathArr[++i]; + } + + parts.push(p); + } + + cache.set(path, parts); + return parts + }; + + /* ___filename___: dist/deps/dot/dottable.js */ + + + + + // const isDot = require('./is/dot') + // const isDottable = (obj, path) => isObj(obj) && isDot(path) + var dottable = function (obj$$2, path) { return (obj(obj$$2) && string(path)) || array(path); }; + + /* ___filename___: dist/deps/dot/segments.js */ + + /* ___filename___: dist/deps/dot/dottable.js */ + + /* ___filename___: dist/deps/dot/set.js */ + + + + + + var set$2 = function dotset(obj$$2, path, value) { + if (!dottable(obj$$2, path)) { + return + } + + var pathArr = segments(path); + + for (var i = 0; i < pathArr.length; i++) { + var p = pathArr[i]; + + if (!obj(obj$$2[p])) { + obj$$2[p] = {}; + } + + // isLast + if (i === lengthMinusOne(pathArr)) { + obj$$2[p] = value; + } + + obj$$2 = obj$$2[p]; + } + }; + + /* ___filename___: dist/deps/is/error.js */ + + /* ___filename___: dist/deps/traversers/copy.js */ + + + + + + + /* prettier-ignore */ + /** + * @desc copy any primitive value, part of clone + * @version 5.0.0 + * @since 3.0.0 + * @name copy + * @see clone + * @memberOf Traverse + * + * @param {*} src value to copy + * @return {*} copied + * + * @example + * + * copy(/eh/gmi) //=> new RegExp('eh', 'gmi') + * copy(new Error('eh')) // => new Error with copied stack + msg + * copy([1]) // => [1] + * copy({}) // => {} + * + */ + var copy = function copy(src) { + if (objNotNull(src)) { + var dst; + + // if (isPrimitive(src)) { + // if (isNullOrUndefined(src)) { + // dst = src + // } + + // @TODO @IMPORTANT @FIXME @!IMPORTANT - COVER THIS OR NOT? + // for string value number boolean objects... + // if (isString(src)) { + // dst = src + '' + // } + // else if (isNumber(src)) { + // dst = src + 0 + // } + // else if (isBoolean(src)) { + // dst = !!src + // } + // else + + // lists... <- needs to have dot-prop support on Map/Set + // if (isMap(src)) { + // dst = new Map() + // const obj = reduce(src) + // // src.clear() + // ObjectKeys(obj).forEach(key => dst.set(key, obj[key])) + // return dst + // } + // else if (isSet(src)) { + // dst = new Set() + // // could clone here too + // const obj = toarr(src) + // // src.clear() + // obj.forEach(value => dst.add(value)) + // return dst + // } + + // ------ + if (array(src)) { + dst = []; + } + // was new date(src.getTime()) + // || isBoolean(src) || isNumber(src) || isString(src) + else if (date(src)) { + dst = new src.constructor(src.valueOf()); + } + else if (regexp(src)) { + // dst = new RegExp(src) + dst = new RegExp(src.src, src.toString().match(/[^/]*$/)[0]); + dst.lastIndex = src.lastIndex; + } + else if (error$1(src)) { + dst = new Error(src.message); + dst.stack = src.stack; + } + else { + dst = Object.create(Object.getPrototypeOf(src)); + } + + // @TODO: copy descriptor + // eslint-disable-next-line + for (var prop in src) { + dst[prop] = src; + // const desc = Object.getOwnPropertyDescriptor(src, prop) + // Object.defineProperty(dst, prop, desc) + } + return dst + } + else { + // require('fliplog').red('is NOT OBJ').echo() + return src + } + }; + + /* ___filename___: dist/deps/is/enumerable.js */ + var enumerable = function (obj, prop) { return Object.prototype.propertyIsEnumerable.call(obj, prop); }; + + /* ___filename___: dist/deps/is/enumerable.js */ + + /* ___filename___: dist/deps/dot/get.js */ + + + + + + + + /** + * @name dot.get + * @memberOf dot + * @func + * @since 3.0.0 + * @extends dot/getPathSegments + * + * @param {Object} obj the object to retrieve the nested property from. + * @param {Dottable | string | Array} path dot-prop-path to use + * @param {*} fallback use when there is no value at specified path + * @return {*} value at path or fallback + * + * @example + * + * dot.get({a: {b: 2}}, 'a.b'); //=> 2 + * dot.get({a: {b: 2}}, ['a', 'b']); //=> 2 + * dot.get({c: {b: 2}}, ['a', 'b']); //=> undefined + * + */ + var get = function(obj, path, fallback) { + if (!dottable(obj, path)) { + return _undefined(fallback) ? obj : fallback + } + + var pathArr = segments(path); + + for (var i = 0; i < pathArr.length; i++) { + if (!enumerable(obj, pathArr[i])) { + return fallback + } + + obj = obj[pathArr[i]]; + + if (nullOrUndefined(obj)) { + /* + * `obj` is either `undefined` or `null` so we want to stop the loop, and + * if this is not the last bit of the path, and + * if it did't return `undefined` + * it would return `null` if `obj` is `null` + * but we want `get({foo: null}, 'foo.bar')` to equal `undefined`, or the supplied fallback, not `null` + */ + if (i !== lengthMinusOne(pathArr)) { + return fallback + } + + break + } + } + + return obj + }; + + /* ___filename___: dist/deps/util/hasOwnProperty.js */ + var hasOwnProperty_1 = function (haystack, needle) { return Object.prototype.hasOwnProperty.call(haystack, needle); }; + + // function(obj, key) { + // return key in obj + // } + + /* ___filename___: dist/deps/util/hasOwnProperty.js */ + + /* ___filename___: dist/deps/traversers/eqValue.js */ + // conditionals + /* eslint complexity: "OFF" */ + + + + + + + + + + + + + + + // const ENV_DEBUG = require('../env/debug') + var ENV_DEBUG$1 = true; + + var isNotRealOrNotEqToString = function (x, y) { return !x || !y || x.toString() !== y.toString(); }; + + /* prettier-ignore */ + /** + * @desc checks value equality, used by eq which compares all types + * @since 4.1.0 + * @memberOf Traverse + * @protected + * + * @TODO !!!!!! USE ENUM FLAGS ON LOOSE TO ALLOW MORE CONFIG FOR ==, COMPARATOR, VALUEOF, walk proto (check ownProps...)... + * + * @param {*} x compare to y + * @param {*} y compare to x + * @param {boolean | number} [loose=false] use == checks when typof != + * @return {boolean} + * + * @example + * + * eqValue(1, 1) //=> true + * eqValue('1', 1) //=> false + * eqValue('1', 1, true) //=> true + * eqValue({}, {}) //=> true + * + */ + var eqValue = function eqValue(x, y, loose) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG$1) { + console.log('eqValue', {x: x, y: y, loose: loose}); + } + + // if (x === y) { + // if (ENV_DEBUG) { + // console.log('===', {x, y}) + // } + // // noop + // } + // else + + if (nullOrUndefined(x) || nullOrUndefined(y)) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG$1) { + console.log('null or undef !=', {x: x, y: y}); + } + + if (x !== y) { + return false + } + } + else if (typeof x !== typeof y) { + // eslint-disable-next-line + if (_true(loose) && x == y) { + // ignore + } + else { + /* istanbul ignore next: dev */ + if (ENV_DEBUG$1) { + console.log('typeof !=', {x: x, y: y}); + } + + return false + } + } + // @TODO put this up first? + else if (toS(x) !== toS(y)) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG$1) { + console.log('diff str types', {x: toS(x), y: toS(y)}); + } + + return false + } + else if (objNotNull(x)) { + // use .equals if the method exists + if (hasOwnProperty_1(x, 'equals')) { + return x.equals(y) + } + + /* istanbul ignore next: dev */ + if (ENV_DEBUG$1) { + console.log('isObjNotNull', {x: x}); + } + + // if (isArray(x)) { + // if (x.length !== y.length) { + // return false + // } + // } + + // @NOTE .toString will be covered for functions and regexes in objStrict + if (regexp(x) || regexp(y)) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG$1) { + console.log('regexp', {x: x, y: y}); + } + + if (isNotRealOrNotEqToString(x, y)) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG$1) { + console.log('regexp !=', {x: x, y: y}); + } + + return false + } + } + else if (date(x) || date(y)) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG$1) { + console.log('dates', {x: x, y: y}); + } + + if (!date(x) || !date(y) || x.getTime() !== y.getTime()) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG$1) { + console.log('!= dates', {x: x, y: y}); + } + + return false + } + } + else if (error$1(x) || error$1(y)) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG$1) { + console.log('isError', {x: x, y: y}); + } + + if (!error$1(x) || !error$1(y) || x.stack !== y.stack) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG$1) { + console.log('!= errors', {x: x, y: y}); + } + + return false + } + } + else if (array(x) && !array(y)) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG$1) { + console.log('isArray(x) || isArray(y)!'); + } + + return false + } + else if (!array(x) && array(y)) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG$1) { + console.log('!isArray(x) && isArray(y):'); + } + + return false + } + + // @TODO considering, we already know it is not null & undefined + // if (isPrimitive(x) || isPrimitive(y)) { + // return x.valueOf() === y.valueOf() + // } + + else { + // @TODO ObjectOrArrayKeys, but have to have else where they are both array + // + // @NOTE it will traverse through values if they are == here + var xKeys = keys(x); + var yKeys = keys(y).length; + + // diff length + if (xKeys.length !== yKeys) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG$1) { + console.log('!= obj key length', {xKeys: xKeys, yKeys: yKeys}); + } + + return false + } + + for (var k = 0; k < xKeys.length; k++) { + if (!hasOwnProperty_1(y, xKeys[k])) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG$1) { + console.log('!= obj property', {y: y, val: xKeys[k]}); + } + + return false + } + } + } + } + else if (toS(x) === toS(y) && x !== y) { + // isString(x) || isBoolean(x) || isNumber(x) || isIterator(x) + /* istanbul ignore next: dev */ + if (ENV_DEBUG$1) { + console.log('same str types - diff values', {s: toS(x), x: x, y: y}); + } + + return false + } + // // @TODO put this up first? + // else if (toS(x) !== toS(y)) { + // /* istanbul ignore next: dev */ + // if (ENV_DEBUG) { + // console.log('diff str types', {x: toS(x), y: toS(y)}) + // } + // + // return false + // } + + // go deeper + else if (_function(x) || _function(y)) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG$1) { + console.log('isFunction(x) && isFunction(y):'); + console.log(x.toString()); + console.log(y.toString()); + } + + if (isNotRealOrNotEqToString(x, y)) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG$1) { + console.log('x.toString() !== y.toString()', x.toString() !== y.toString()); + } + return false + } + else { + return true + } + } + // @TODO why? + else if (obj(x) && obj(y)) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG$1) { + console.log('isObj(x) && isObj(y):'); + } + + return false + } + // else { + /* istanbul ignore next: dev */ + if (ENV_DEBUG$1) { + console.log('eqeqeq:', {[toS(x) + 'X']: x, [toS(y) + 'Y']: y}); + } + return true + // } + }; + + /* ___filename___: dist/deps/dot/get.js */ + + /* ___filename___: dist/deps/is/empty.js */ + + /* ___filename___: dist/deps/env/debug.js */ + + /* ___filename___: dist/deps/traversers/eqValue.js */ + + /* ___filename___: dist/deps/traversers/_eq.js */ + // conditionals + /* eslint complexity: "OFF" */ + + // const traverse = require('../traverse') + + + + + + + + /* prettier-ignore */ + /** + * @name eq + * @since 3.0.0 + * @version 5.0.0 + * @memberOf Traverse + * + * @see https://github.com/facebook/immutable-js/blob/master/src/utils/deepEqual.js + * @see https://github.com/substack/node-deep-equal + * @see http://ramdajs.com/docs/#equals + * @see https://lodash.com/docs/4.17.4#isEqual + * @see https://github.com/angular/angular.js/blob/master/src/Angular.js + * + * @param {Traverse} traverse traversejs + * @param {*} a compare to b + * @param {*} b compare to a + * @param {boolean} [loose] compare loosely + * @param {boolean} [scoped] doing a second pass, private + * @return {boolean} isEqual + * + * @extends eqValue + * + * @example + * + * eq(1, 1) //=> true + * eq(1, '1') //=> false + * eq(1, '1', true) //=> true + * eq([1], [1]) //=> true + * + */ + var _eq = function (traverse) { return function eq(a, b, loose, stackA, stackB) { + if ( stackA === void 0 ) stackA = []; + if ( stackB === void 0 ) stackB = []; + + /* istanbul ignore next: dev */ + if (debug) { + console.log('\n'); + } + + var equal = true; + var node = b; + var nodes = [node]; + + var instance = traverse(a); + + var notEqual = function () { + equal = false; + instance.stop(); + }; + + /* istanbul ignore next: dev */ + if (debug) { + console.log('eq?'); + } + + instance.forEach(function(key, y, traverser) { + // @NOTE do base comparisons on values that are not actually iteratable + // aka, .isRoot + if (_null(key)) { + // always-valid state opionion vs always-invalid + // so it only returns false when it is !== fosho + if (eqValue(node, y, loose) === false) { return notEqual() } + else { return } + } + + /* istanbul ignore next: dev */ + if (debug) { + console.log('eq: iterating:'); + } + + // could use it as a fallback if undefined && y !== undefined + // const xyz = get(b, traverser.path.join('.'), b) + + var x = node; + + // isNotLeafAndIsObj + if (objNotNull(node) && !empty(node)) { + /* istanbul ignore next: dev */ + if (debug) { + console.log('is leaf, is not empty node, going deeper'); + } + + // so x is our current one, + // if node is not empty, use the key, push the value + // and when it is empty, and it is not a leaf but has nodes, pop back up + x = node[key]; + nodes.push(x); + } + + // ENV_DEBUG + // console.log({[key]: {x, xyz, y, nodes, path: traverser.path.join('.')}}) + + // for next loop!!! + if (!this.isLeaf && !empty(nodes)) { + /* istanbul ignore next: dev */ + if (debug) { + console.log('is not leaf, has nodes stack, pop'); + } + node = nodes.pop(); + } + + /* istanbul ignore next: dev */ + if (debug) { + console.log({key: key, y: y, x: x, a: a, b: b}); + } + + var eqv = eqValue(x, y, loose); + + /* istanbul ignore next: dev */ + if (debug) { + console.log({eqv: eqv}); + } + + if (eqv === false) { + // equal + notEqual(); + } + }); + + // cleanup + nodes = undefined; + node = undefined; + + return equal + }; }; + + /* ___filename___: dist/deps/cache/pooler.js */ + /* eslint consistent-this: ["error", "Klass"] */ + + + + /** + * @symb 🎱 + * @member pooler + * @type {Object} + */ + // const pooler = }} + + /** + * @desc call destructor on a pooled instance, put it back in the pool + * @since 5.0.0 + * @memberOf pooler + * + * @param {Object} instance call destructor + * @return {void} + * + * @example + * + * class Eh {} + * addPoolingTo(Eh) + * const eh = Eh.getPooled() + * eh.release() + * + */ + function standardReleaser(instance) { + var Klass = this; + + if (debug) { + if (instance instanceof Klass) { + throw new Error( + "Trying to release an instance\n into a pool of a different type." + ) + } + } + + instance.destructor(); + if (Klass.instancePool.length < Klass.poolSize) { + Klass.instancePool.push(instance); + } + } + + /** + * Static poolers. Several custom versions for each potential number of + * arguments. A completely generic pooler is easy to implement, but would + * require accessing the `arguments` object. In each of these, `this` refers to + * the Class itself, not an instance. If any others are needed, simply add them + * here, or in their own files. + * + * @since 5.0.0 + * @memberOf pooler + * + * @param {Object} copyFieldsFrom obj with instance pool + * @return {Object} instance of Klass + * + * @example + * + * class Eh {} + * addPoolingTo(Eh) + * const eh = Eh.getPooled() //=> oneArgumentPooler(Eh) + * eh.release() + * + */ + function oneArgumentPooler(copyFieldsFrom) { + var Klass = this; + if (Klass.instancePool.length) { + var instance = Klass.instancePool.pop(); + Klass.call(instance, copyFieldsFrom); + return instance + } + else { + return new Klass(copyFieldsFrom) + } + } + + var DEFAULT_POOL_SIZE = 10; + var DEFAULT_POOLER = oneArgumentPooler; + + /** + * Augments `CopyConstructor` to be a poolable class, augmenting only the class + * itself (statically) not adding any prototypical fields. Any CopyConstructor + * you give this may have a `poolSize` property, and will look for a + * prototypical `destructor` on instances. + * + * @since 5.0.0 + * @memberOf pooler + * + * @param {Function | Object} CopyConstructor Constructor that can be used to reset. + * @param {Function} pooler Customizable pooler. + * @return {Object} enhanced constructor, decorated with pooler + * + * @example + * + * class Eh {} + * addPoolingTo(Eh) // can optionally pass in pooler as second arg + * //=> Eh.instancePool = [] + * //=> Eh.getPooled = pooler || singleArgumentPooler + * //=> Eh.poolSize = 10 + * //=> Eh.release = standardReleaser + * + */ + function addPoolingTo(CopyConstructor, pooler) { + // Casting as any so that flow ignores the actual implementation and trusts + // it to match the type we declared + var NewKlass = CopyConstructor; + + NewKlass.instancePool = []; + NewKlass.getPooled = pooler || DEFAULT_POOLER; + if (!NewKlass.poolSize) { NewKlass.poolSize = DEFAULT_POOL_SIZE; } + NewKlass.release = standardReleaser; + + return NewKlass + } + + var pooler = addPoolingTo; + + /* ___filename___: dist/deps/is/symbol.js */ + + /* ___filename___: dist/deps/is/asyncish.js */ + + /* ___filename___: dist/deps/is/primitive.js */ + + /* ___filename___: dist/deps/dot/set.js */ + + /* ___filename___: dist/deps/traversers/copy.js */ + + /* ___filename___: dist/deps/traversers/_eq.js */ + + /* ___filename___: dist/deps/cache/pooler.js */ + + /* ___filename___: dist/deps/traverse.js */ + // conditionals + /* eslint complexity: "OFF" */ + + // inlined rollup + /* eslint import/max-dependencies: "OFF" */ + + // one file + /* eslint max-lines: "OFF" */ + + // debug conditionals + /* eslint max-depth: "OFF" */ + + + + + + + + + + + + + + + + + + + + + + + + + // const props = require('./util/props') + + // const ENV_DEBUG = require('./env/debug') + // const ENV_DEBUG = true + var ENV_DEBUG = false; + + function isIteratable(node) { + // ez ones + if (obj(node) || array(node)) { return true } + + var notIteratable = + primitive$2(node) || + regexp(node) || + date(node) || + symbol(node) || + asyncish(node) || + // isNative(node) || + error$1(node); + + if (notIteratable) { return false } + else { return true } + + // if (isNullOrUndefined(node)) { + // } + // else if (isString(node)) { + // } + // else if (isNumber(node)) { + // } + // else if (isBoolean(node)) { + // } + // else if (isRegExp(node)) { + // } + // else if (isDate(node)) { + // } + // else if (isSymbol(node) || isAsyncish(node)) { + // } + // else if (isNative(node)) { + // } + // else { + // return true + // } + // return false + } + + // function isSpecial(x) { + // // isPromise(x) || + // return isSymbol(x) || isError(x) || + // // || isGenerator(x) + // } + + /** + * {@link https://github.com/wmira/object-traverse/blob/master/index.js } + * {@link https://www.npmjs.com/browse/keyword/traverse } + * {@link https://www.npmjs.com/package/tree-walk } + * {@link https://www.npmjs.com/package/1tree } + * {@link https://www.npmjs.com/package/pathway } + * {@link https://www.npmjs.com/package/@mojule/tree } + * + * -------------------- + * + * if needed, clone + * + * first things to check are number/string/boolean/null/undefined + * + * then check non-iteratables + * symbol, promise, + * + * then check conversions + * - map, set + * + * then check empties + * - obj + * - fn + * + * ------- + * + * numbers f-or first/last + * and as a sort of hash like + * 1 + 2 + 4 = ISLEAF & ISROOT ? + * + * Array + * + * Object Function Date Error Map Set + * + * String + * Number NaN Infinity + * Boolean + * + * + * null undefined + * + * Promise Symbol + * + * ---- + * + * @emits before + * @emits pre + * @emits post + * @emits after + */ + + /** + * @class + * @desc Traverse class, pooled + * @alias IterAteOr + * @member Traverse + * @constructor + * @since 5.0.0 + * + * @param {Traversable} iteratee value to iterate, clone, copy, check for eq + * @param {Object | undefined} [config] wip config for things such as events or configs + * + * @extends pooler + * @see traverse + * @TODO make this a trie OR a linked-list + * + * @example + * + * new Traverse([1]) + * new Traverse([], {}) + * + */ + function Traverse(iteratee, config) { + // always cleared when done anyway + this.parents = new Set(); + + this.iteratee = iteratee; + this.parent = iteratee; + this.root = iteratee; + this.reset(); + + // to pass in the events (as commented below) without messing up scope? + // if (config.on) this.on = config.on + return this + } + + Traverse.prototype.reset = function() { + this.path = []; + this.key = undefined; + this.isAlive = true; + this.isCircular = false; + this.isLeaf = false; + this.isRoot = true; + + // iterates +1 so start at 0 + this.depth = -1; + }; + + /** + * @desc find parent, + * is there a parent + * above the current depth + * with the same value, + * making it circular? + * + * @memberOf Traverse + * @since 5.0.0 + * @private + * + * @param {number} depth current depth, to find parent >= + * @param {parent} value parent value to find + * @return {boolean} hasParent + * + * @example + * + * var obj = {eh: ['eh']} + * traverse(obj).addParent(0, obj) + * + */ + Traverse.prototype.hasParent = function(depth, value) { + // or array + if (!obj(value)) { return false } + return this.parents.has(value) + }; + + /** + * @desc add parent, to prevent circular iterations + * @memberOf Traverse + * @since 5.0.0 + * @private + * + * @param {number} depth current depth, to add parent to >= + * @param {parent} value parent value to add + * @return {void} + * + * @example + * + * var obj = {eh: ['eh']} + * traverse(obj).addParent(0, obj) + * + */ + Traverse.prototype.addParent = function(depth, value) { + if (!obj(value)) { return } + if (this.parents.size >= 100) { this.clear(); } + this.parents.add(value); + }; + + /** + * @desc remove all parents, reset the map + * + * @memberOf Traverse + * @since 5.0.0 + * @private + * + * @return {void} + * + * @example + * + * var obj = {eh: ['eh']} + * traverse(obj).forEach((key, value, t) => { + * t.parents + * //=> Set([obj]) + * t.clear() + * t.parents + * //=> Set[] + * }) + * + */ + Traverse.prototype.clear = function() { + if (!_undefined(this.parents)) { this.parents.clear(); } + }; + + /** + * @memberOf Traverse + * @since 5.0.0 + * @private + * + * @param {number} depth current depth, to find parents >= + * @param {parent} value parent value to remove + * @return {void} + * + * @example + * + * var obj = {eh: ['eh']} + * traverse(obj).removeParent(0, obj) + * + */ + Traverse.prototype.removeParent = function(depth, value) { + this.parents.delete(value); + }; + + /** + * @desc this is the main usage of Traverse + * @memberOf Traverse + * @since 3.0.0 + * @version 5.0.0 + * + * @param {Function} cb callback for each iteration + * @return {*} mapped result or original value, depends how it is used + * + * @example + * + * traverse([1, 2, 3]).forEach((key, value) => console.log({[key]: value})) + * //=> {'0': 1} + * //=> {'1': 2} + * //=> {'2': 3} + * + */ + Traverse.prototype.forEach = function iterateForEach(cb) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('\n forEach \n'); + } + + var result = this.iterate(cb); + + // TODO: HERE, WHEN THIS IS ADDED, CAN BREAK SOME TESTS? SCOPED PARENTS MAP? + Traverse.release(this); + + return result + }; + + /** + * @desc stop the iteration + * @modifies this.isAlive = false + * @memberOf Traverse + * + * @return {void} + * + * @example + * + * traverse({eh: true, arr: []}).forEach((key, val, t) => { + * if (isArray(val)) this.stop() + * }) + * + */ + Traverse.prototype.stop = function stop() { + this.isAlive = false; + // this.release() + }; + + /** + * @TODO skip 1 branch + * @version 5.0.0 + * @since 3.0.0 + * @memberOf Traverse + * + * @return {void} + * + * @example + * + * traverse([1, 2, 3, [4]]).forEach((key, val, t) => { + * if (isArray(val)) t.skip() + * }) + * + */ + Traverse.prototype.skip = function skip() { + this.skipBranch = true; + }; + + /* prettier-ignore */ + /** + * @TODO move into the wrapper? if perf allows? + * + * @desc checks whether a node is iteratable + * @modifies this.isIteratable + * @modifies this.isLeaf + * @modifies this.isCircular + * + * @memberOf Traverse + * @protected + * + * @param {*} node value to check + * @return {void} + * + * @example + * + * .checkIteratable({eh: true}) + * //=> this.isLeaf = false + * //=> this.isCircular = false + * //=> this.isIteratable = true + * + * .checkIteratable({} || []) + * //=> this.isLeaf = true + * //=> this.isCircular = false + * //=> this.isIteratable = false + * + * var circular = {} + * circular.circular = circular + * .checkIteratable(circular) + * //=> this.isLeaf = false + * //=> this.isCircular = true + * //=> this.isIteratable = true + * + */ + Traverse.prototype.checkIteratable = function check(node) { + this.isIteratable = isIteratable(node); + // just put these as an array? + if (_true(this.isIteratable)) { + // native = leaf if not root + this.isLeaf = false; + var path = this.path.join('.'); + + + if (this.hasParent(path, node)) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('circular___________', {node: node, path: this.path}); + } + this.isCircular = true; + } + else { + this.addParent(path, node); + this.isCircular = false; + } + + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + // console.log('IS_CIRCULAR_JSON', isCircular(node), this.isCircular, node) + } + } + else { + // --- + this.isLeaf = true; + this.isCircular = false; + } + }; + + /* prettier-ignore */ + /** + * Remove the current element from the output. + * If the node is in an Array it will be spliced off. + * Otherwise it will be deleted from its parent. + * + * @memberOf Traverse + * @version 5.0.0 + * @since 2.0.0 + * + * @param {undefined | Object} [arg] optional obj to use, defaults to this.iteratee + * @return {void} + * + * @example + * + * traverse([0]).forEach((key, val, it) => it.remove()) + * //=> [] + * + * traverse({eh: true}).forEach((key, val, it) => it.remove()) + * //=> {} + * + * traverse({eh: true, str: 'stringy'}).forEach((key, val, it) => { + * if (!isString(val)) it.remove() + * }) + * //=> {str: 'stringy'} + * + */ + Traverse.prototype.remove = function removes(arg) { + if (_undefined(this.key)) { return } + + var obj$$2 = arg || this.iteratee; + + if (!obj(obj$$2)) { return } + + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('remove'); + console.log({parent: this.parent, key: this.key, obj: obj$$2}); + } + + this.removeParent(obj$$2); + + this.skip(); + + delete obj$$2[this.key]; + delete this.parent[this.key]; + // if (isObj(obj)) deleteFromObjOrArray(obj, this.key) + // else deleteFromObjOrArray(this.parent, this.key) + // deleteFromObjOrArray(this.parent, this.key) + // deleteFromObjOrArray(this.iteratee, this.key) + + // if (isUndefined(obj)) { + // // throw new Error('why?') + // } + // else if (isArray(obj)) { + // /* istanbul ignore next: dev */ + // if (ENV_DEBUG) { + // console.log('traverse:remove:array', obj, this.key) + // } + // + // obj.splice(this.key, 1) + // } + // else if (isObjNotNull(obj)) { + // /* istanbul ignore next: dev */ + // if (ENV_DEBUG) { + // console.log('traverse:remove:obj', this.key) + // } + // + // delete obj[this.key] + // } + // + // if (isObjNotNull(this.parent)) { + // delete this.parent[this.key] + // + // /* istanbul ignore next: dev */ + // if (ENV_DEBUG) { + // console.log('traverse:remove:parent', this.key) + // } + // } + // if (isObjNotNull(this.iteratee)) { + // delete this.iteratee[this.key] + // + // /* istanbul ignore next: dev */ + // if (ENV_DEBUG) { + // console.log('traverse:remove:iteratee', this.key) + // } + // } + + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('traverse:remove:', this.key, {obj: obj$$2, iteratee: this.iteratee}); + } + }; + + /** + * @desc update the value for the current key + * @version 5.0.0 + * @since 2.0.0 + * @memberOf Traverse + * + * @param {*} value this.iteratee[this.key] = value + * @return {void} + * + * @example + * + * traverse({eh: true}) + * .forEach((key, val, traverser) => { + * if (this.isRoot) return + * traverser.update(false) + * }) + * //=> {eh: false} + * + */ + Traverse.prototype.update = function update(value) { + set$2(this.root, this.path, value); + }; + + /** + * @desc mark the iteration as done, clear the map + * @NOTE this recycles the instance in the pooler to re-use allocated objects + * @memberOf Traverse + * @private + * @since 5.0.0 + * + * @return {void} + * + * @see Traverse.iterate + * + * @example + * + * traverse([]).destructor() + * + */ + Traverse.prototype.destructor = function destructor() { + this.iteratee = undefined; + this.parent = undefined; + this.reset(); + + this.clear(); + }; + + /* prettier-ignore */ + /** + * @TODO handler for Set & Map so they can be skipped or traversed, for example when cloning... + * @TODO add hook to add custom checking if isIteratable + * @TODO deal with .isRoot if needed + * @TODO examples with clone and stop + * + * @memberOf Traverse + * @protected + * @sig on(key: null | Primitive, val: any, instance: Traverse): any + * + * @param {Function} on callback fn for each iteration + * @return {*} this.iteratee + * + * @example + * + * iterate([]) + * //=> [] + * //=> on(null, []) + * + * @example + * + * iterate([1]) + * //=> [1] + * //=> on(null, [1]) + * //=> on('1', 1) + * + * @example + * + * //primitive - same for any number, string, symbol, null, undefined + * iterate(Symbol('eh')) + * //=> Symbol('eh') + * //=> on(Symbol('eh')) + * + * @example + * + * var deeper = {eh: 'canada', arr: [{moose: true}, 0]} + * iterate(deeper) + * //=> deeper // returns + * //=> on(null, deeper, this) // root + * + * //=> on('eh', 'canada', this) // 1st branch + * + * //=> on('arr', [{moose: true}, 0], this) + * //=> on('arr.0', [{moose: true}], this) + * //=> on('arr.0.moose', true, this) + * //=> on('arr.1', [0], this) + * + * + */ + Traverse.prototype.iterate = function iterate(on) { + var this$1 = this; + + /* istanbul ignore next : dev */ + if (ENV_DEBUG) { + // require('fliplog') + // .bold(this.path.join('.')) + // .data(parents.keys()) + // .echo() + console.log('\n...iterate...\n'); + } + + if (this.isAlive === false) { + /* istanbul ignore next : dev */ + if (ENV_DEBUG) { + console.log('DEAD'); + } + + return Traverse.release(this) + } + + var node = this.iteratee; + + // convert to iteratable + if (map(node)) { + node = index$6(node); + } + else if (set(node)) { + node = toArr(node); + } + + // @TODO: maybe only right before sub-loop + this.addParent(this.depth, node); + + var nodeIsArray = array(node); + var nodeIsObj = nodeIsArray || obj(node); + + // --- + + // @event + if (!_undefined(this.onBefore)) { + // eslint-disable-next-line no-useless-call + this.onBefore(this); + } + + /* istanbul ignore next : dev */ + if (ENV_DEBUG) { + // const str = require('pretty-format')({nodeIsObj, nodeIsArray, node}) + // require('fliplog').verbose(1).data({nodeIsObj, nodeIsArray, node}).echo() + // console.log(node, parents) + // console.log(str) + console.log({nodeIsObj: nodeIsObj, nodeIsArray: nodeIsArray, node: node}); + } + + /** + * call as root, helpful when we + * - iterate something with no keys + * - iterate a non-iteratable (symbol, error, native, promise, etc) + */ + if (_true(this.isRoot)) { + on.call(this, null, node, this); + this.isRoot = false; + } + + var isObjOrArray = nodeIsArray || nodeIsObj; + + // if (isObjOrArray) { + // // @event + // if (!isUndefined(this.onBefore)) { + // // eslint-disable-next-line no-useless-call + // this.onBefore(this) + // } + // } + + // -------------------- + // IF OBJWITHOUTKEYS, IF ARRAY WITHOUT LENGTH... + if (isObjOrArray && empty(node)) { + on.call(this, this.key, node, this); + this.iteratee = node; + } + + // -------------------- + + else if (isObjOrArray) { + this.depth = this.path.length; + + // @TODO SAFETY WITH `props(node)` <- fixes Error + var keys$$2 = nodeIsArray ? node : keys(node); + + /* istanbul ignore next : dev */ + if (ENV_DEBUG) { + console.log({keys: keys$$2}); + // require('fliplog').verbose(1).data(this).echo() + } + + // @event + // if (!isUndefined(this.onBefore)) this.onBefore() + + // @NOTE: safety here + // this.checkIteratable(node) + + // const last = keys[keys.length - 1] + + // @loop + for (var key = 0; key < keys$$2.length; key++) { + // if (ENV_DEBUG) + // console.log('iterating:', {key}) + + // --- safety --- + if (this$1.isAlive === false) { + /* istanbul ignore next : dev */ + if (ENV_DEBUG) { + console.log('DEAD'); + } + + return Traverse.release(this$1) + } + + // @NOTE: look above add prev add parent + // addParent(this.depth, node) + + + // ----- setup our data ---- + + // to make it deletable + if (node !== this$1.iteratee) { this$1.parent = node; } + + this$1.key = nodeIsArray ? key : keys$$2[key]; + // this.isLast = key === last + + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('alive', this$1.key); + } + + // @event + if (!_undefined(this$1.onPre)) { + // eslint-disable-next-line no-useless-call + this$1.onPre(this$1); + } + + + var value = node[this$1.key]; + + this$1.checkIteratable(value); + // addParent(value) + var pathBeforeNesting = this$1.path.slice(0); + + // @NOTE: can go forward-backwards if this is after the nested iterating + this$1.path.push(this$1.key); + this$1.depth = this$1.path.length; + + // ----- continue events, loop deeper when needed ---- + + // @NOTE since we check isAlive at the beginning of each loop + // could use .skip alongisde .stop + // @TODO @IMPORTANT @HACK @FIXME right here it should also handle the .stop + on.call(this$1, this$1.key, value, this$1); + if (_true(this$1.skipBranch)) { + this$1.skipBranch = false; + continue + } + + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + // require('fliplog').data(parents).echo() + // require('fliplog').data(this).echo() + } + + // handle data + if (_true(this$1.isCircular)) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('(((circular)))', this$1.key); + } + + // on.call(this, this.key, value, this) + // this.path.pop() + this$1.path = pathBeforeNesting; + + // this.isCircular = false + // break + continue + // return + } + + + // && + if (_true(this$1.isIteratable)) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('(((iteratable)))', this$1.key); + } + + this$1.iteratee = value; + this$1.iterate(on); + this$1.path = pathBeforeNesting; + } + + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + if (this$1.isIteratable === false) { + console.log('not iteratable', this$1.key); + } + + console.log('----------------- post ----------', node); + } + + // @event + if (!_undefined(this$1.onPost)) { + // eslint-disable-next-line no-useless-call + this$1.onPost(this$1); + } + + // cleanup, backup 1 level + this$1.path.pop(); + + this$1.removeParent(node); + } + + // this.path.pop() + this.depth = this.path.length; + } + else { + // this.isLast = false + on.call(this, this.depth, node, this); + } + + // @NOTE: careful + // removeParent(node) + + // @NOTE: just for .after ? + this.iteratee = node; + + // @event + if (!_undefined(this.onAfter)) { + // eslint-disable-next-line no-useless-call + this.onAfter(this); + } + + this.path.pop(); + + return this.iteratee + }; + + // is smaller, but probably slower + // function onEvent(property) { + // return function(fn) { + // this[property] = function + // } + // } + + // when it's some sort of itertable object, loop it further + // @TODO: need to handle these better without totally messing with bad scope + Traverse.prototype.pre = function(fn) { + this.onPre = fn; + }; + Traverse.prototype.post = function(fn) { + this.onPost = fn; + }; + Traverse.prototype.before = function(fn) { + this.onBefore = fn; + }; + Traverse.prototype.after = function(fn) { + this.onAfter = fn; + }; + + // ----------------------- + + /** + * @TODO merge with dopemerge? + * @TODO needs tests converted back for this (observe tests do cover somewhat) + * + * @param {*} arg defaults to this.iteratee + * @return {*} cloned + * + * @example + * + * var obj = {} + * var cloned = traverse().clone(obj) + * obj.eh = true + * eq(obj, cloned) + * //=> false + * + */ + Traverse.prototype.clone = clone; + + /** + * @todo ugh, how to clone better with *recursive* objects? + * @param {any} src wip + * @return {any} wip + */ + Traverse.prototype.copy = copy; + + /** + * @desc clone any value + * @version 5.0.0 + * @since 4.0.0 + * @memberOf Traverse + * @extends copy + * @extends Traverse + * + * @param {*} arg argument to clone + * @return {*} cloned value + * + * @see dopemerge + * @example + * + * var obj = {eh: true} + * clone(obj) === obj //=> false + * + * var obj = {eh: true} + * var obj2 = clone(obj) + * obj.eh = false + * console.log(obj2.eh) //=> true + * + */ + function clone(arg) { + var obj$$2 = _undefined(arg) ? this.iteratee : arg; + if (primitive$2(obj$$2)) { return obj$$2 } + var cloned = emptyTarget(obj$$2); + var current = cloned; + + traverse(obj$$2).forEach(function (key, value, traverser) { + // t.isRoot + if (_null(key)) { return } + + var copied = copy(value); + if (traverser.isCircular && array(value)) { copied = value.slice(0); } + set$2(current, traverser.path, copied); + + // current[key] = traverser.copy(value) + // if (isObj(value)) current = current[key] + }); + + return cloned + } + + // @TODO could just have traverse = Traverse.getPooled ? + pooler(Traverse); + function traverse(value) { + return Traverse.getPooled(value) + } + + var traverse_1 = traverse; + var eq_1 = _eq(traverse); + var clone_1 = clone; + var copy_1 = copy; + + + + traverse_1.eq = eq_1; + traverse_1.clone = clone_1; + traverse_1.copy = copy_1; + + var index$10 = new Map(); + + /* ___filename___: dist/deps/traverse.js */ + + /* ___filename___: dist/deps/dot/paths.js */ + + + + + + + var run = 0; + + /* prettier-ignore */ + /** + * @desc gathers dot.prop from any value, with a prefixed/base key + * @since 4.0.0 + * + * @param {Primitive} key prefixing key for the paths, root path/key + * @param {Traversable} value traversable value to extract paths from + * @param {boolean | undefined} [longest] optionally filter to keep only longest/deepest paths + * @return {Array} paths[] + * + * @see deps/traverse + * @TODO should build a trie if doing this + * @NOTE had `onlyLongest` & `asString` but can just .join(',') to match + * + * @example + * + * dotPropPaths('', {oh: {eh: true}}) + * //=> ['oh.eh'] + * + * dotPropPaths('moose', {oh: {eh: true}}) + * //=> ['moose.oh.eh'] + * + */ + var paths = function(key, value, longest) { + // if (cache.has(value)) return cache.get(value) + + var paths = []; + + /* istanbul ignore next: debug */ + if (debug) { + console.log({value: value}); + } + + // gather all paths in the object + // filter to ensure only the longest paths are kept + // + // .map the paths to `dot-prop`, + // `matcher` takes in an array so it will work for all + traverse_1(value).forEach(function(x) { + // const currentPath = this.paths + var currentPath = this.path; + + /* istanbul ignore next: debug */ + if (debug) { + console.log('paths', run++, this.path); + } + + // ignore + if (!currentPath) { return } + else if (!currentPath.length) { return } + + // dot-prop the array of paths + // if we have a key, prefix it + paths.push( + (key ? key + '.' : '') + + (currentPath.join ? currentPath.join('.') : currentPath) + ); + }); + + if (_true(longest)) { + // concat a string of all paths so we can unique each branch + // @example `canada.arr.0` vs `canada.arr` + paths = paths.filter(function (path) { return !paths.some(function (otherPath) { return otherPath !== path && index$4(otherPath, path); } + ); }); + } + + // cache.set(value, paths) + + return paths + }; + + /* ___filename___: dist/deps/is/number.js */ + + + + /** + * @param {*} x value + * @return {boolean} isNumber + * + * @since 3.0.0 + * @memberOf is + * @func isNumber + * @see is/real + * @extends numberPrimitive + * @variation also returns true for new Number object + * + * @see http://stackoverflow.com/questions/18082/validate-decimal-numbers-in-javascript-isnumeric + * @alternate !isNaN(parseFloat(n)) && isFinite(n) + * + * @example + * + * isNumber(1) + * //=> true + * isNumber(new Number(1)) + * //=> true + * isNumber(Number(1)) + * //=> true + * isNumber(NaN) + * //=> true + * + * isNumber(null) + * //=> false + * isNumber(undefined) + * //=> false + * isNumber(void 0) + * //=> false + * isNumber({}) + * //=> false + * isNumber('') + * //=> false + * isNumber(false) + * //=> false + * + * @NOTE was not needed except for abstract == + * const isObj = require('./obj') + * const isSymbol = require('./symbol') + * (isObj(x) || isSymbol(x) + * ? false + * : (/^0x[0-9a-f]+$/i).test(x) || + * (/^[-+]?(?:\d+(?:\.\d*)?|\.\d+)(e[-+]?\d+)?$/).test(x)) + * + */ + var number = function (x) { return numberPrimitive(x) || toS(x) === '[object Number]'; }; + + /* ___filename___: dist/deps/is/number.js */ + + /* ___filename___: dist/deps/is/stringOrNumber.js */ + + + + /** + * Checks if `value` is classified as a `String` primitive or object. + * + * @since 3.0.0 + * @category Lang + * @memberOf is + * @param {*} x The value to check. + * @return {boolean} Returns `true` if `value` is a string, else `false`. + * + * @see https://github.com/infernojs/inferno/blob/master/packages/inferno-shared/src/index.ts#L23 + * @see https://github.com/lodash/lodash/blob/master/isString.js + * + * @example + * + * isString('abc') + * // => true + * + * isString(1) + * // => false + */ + var stringOrNumber = function (x) { return string(x) || number(x); }; + + /* ___filename___: dist/deps/is/real.js */ + + + /** + * @param {*} x value + * @return {boolean} isReal + * + * @since 3.0.0 + * @memberOf is + * @func isReal + * @see is/null + * @see is/undefined + * + * @see http://2ality.com/2013/04/quirk-implicit-conversion.html + * @see https://javascriptrefined.io/nan-and-typeof-36cd6e2a4e43 + * @see https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/isNaN + * + * @NOTE eslint-disable-next-line no-self-compare + * && x !== x + * + * @extends isNullOrUndefined + * @variation *not* isNullOrUndefined && false for NaN + * + * @example + * + * isReal(null) + * //=> false + * isReal(void 0) + * //=> false + * const nan = Number(undefined) + * isReal(nan) + * //=> false + * + * isReal({eh: true}) + * //=> true + * isReal({}) + * //=> true + * isReal(Object) + * //=> true + * isReal([]) + * //=> true + * isReal(new Set()) + * //=> true + * isReal(function() {}) + * //=> true + * isReal('') + * //=> true + * isReal(1) + * //=> true + * + */ + var real = function (x) { return !nullOrUndefined(x) && !Number.isNaN(x); }; + + /* ___filename___: dist/deps/is/objPure.js */ + + + + + + /** + * @name isObjPure + * @memberOf is + * @alias isObjNotArrayOrFunction + * @since 3.0.0 + * + * + * @param {*} x value to check + * @return {boolean} is obj & !null & !undefined & !array & !function + * + * @extends isArray + * @extends isObjTypeof + * @extends isNullOrUndefined + * @extends isFunction + * + * @example + * + * isObjPure(function() {}) + * //=> false + * isObjPure(null) + * //=> false + * isObjPure([]) + * //=> false + * + * isObjPure({}) + * //=> true + * + */ + var objPure = function (x) { return !nullOrUndefined(x) && !array(x) && !_function(x) && objTypeof(x); }; + + /* ___filename___: dist/deps/is/objWithKeys.js */ + + + + /** + * @TODO @NOTE need to be more careful, needs to check for vanilla objects, not native ones since e.g. Error has no keys + * + * @param {*} x value + * @return {boolean} isObjWithKeys + * + * @since 3.0.0 + * @memberOf is + * @func isObjWithKeys + * @see is/obj + * @see is/objWithKeys + * @see is/objStrict + * @see is/null + * + * @extends isObj + * @variation Object.keys(obj).length !== 0 + * + * @example + * + * isObjWithKeys({eh: true}) + * //=> true + * isObjWithKeys({}) + * //=> false + * isObjWithKeys(new Object()) + * //=> false + * isObjWithKeys(Object.create(null)) + * //=> false + * isObjWithKeys(null) + * //=> false + * isObjWithKeys(new Set()) + * //=> false + * isObjWithKeys(function() {}) + * //=> false + * isObjWithKeys('') + * //=> false + * isObjWithKeys(1) + * //=> false + * + */ + var objWithKeys = function (val) { return obj(val) && keys(val).length !== 0; }; + + /* ___filename___: dist/deps/conditional/or.js */ + + + /** + * @desc first fn || second fn, curried + * @name or + * @memberOf conditional + * @since 4.0.1 + * @func + * + * @param {Function} left first fn + * @param {Function} right second fn + * @param {*} x value to pass into left & right, curried + * @return {boolean} one of the functions return truthy + * + * @example + * const {isTrue, isFalse} = require('chain-able') + * + * const either = or(isFalse, isTrue) + * + * either([true]) + * //=> true + * + * either([new Boolean(true)]) + * //=> false + * + * either([1]) + * //=> false + * + * // because curried + * or(isTrue, isFalse, true) //=> true + * + */ + var or = curry(3, function (left, right, x) { return left(x) || right(x); }); + + /* ___filename___: dist/deps/conditional/or.js */ + + /* ___filename___: dist/deps/is/matcher.js */ + + + + + /** + * @func isMatcher + * @memberOf is + * @since 3.0.0 + * + * @param {*} x value to check + * @return {boolean} isFunction || isRegExp + * + * @see is/regexp + * @see is/function + * @see conditionals/or + * + * @example + * + * isMatcher(/(.*)/) + * //=> true + * + * isMatcher(x => true) + * //=> true + * + * isMatcher(1) + * //=> false + * isMatcher('.*') + * //=> false + * + */ + var matcher = or(_function, regexp); // x => isFunction(x) || isRegExp(x) + // x instanceof RegExp + + /* ___filename___: dist/deps/is/objPure.js */ + + /* ___filename___: dist/deps/is/objWithKeys.js */ + + /* ___filename___: dist/deps/is/real.js */ + + /* ___filename___: dist/deps/is/matcher.js */ + + // dont need these yet + + + // const isClass = require('./class') + // const isEnumerable = require('./enumerable') + // const isMapish = require('./mapish') + + /** + * @member is + * @types is + * @tests is/* + * + * @see https://github.com/lodash/lodash/issues/3237 + * @type {Object} + */ + var index$12 = { + isObjWithKeys: objWithKeys, + isObj: obj, + // isObject: isObj, + isObjPure: objPure, + isObjNotNull: objNotNull, + isFunction: _function, + isReal: real, + toS: toS, + isDate: date, + isRegExp: regexp, + isError: error$1, + isBoolean: boolean_1, + isNumber: number, + isString: string, + isMap: map, + isSet: set, + isSymbol: symbol, + isPrototypeOf: prototypeOf, + isArray: array, + // new + isIterator: iterator$2, + isUndefined: _undefined, + isNull: _null, + isNill: nullOrUndefined, + isTrue: _true, + isMatcher: matcher, + }; + + /* ___filename___: dist/deps/string/camelCase.js */ + /* prettier-ignore */ + /** + * @desc camelCase + * @since 0.2.0 + * @symb 🐫 + * + * @param {string} str string to turn into camelCase + * @return {string} camelCased string + * + * @tutorial https://github.com/substack/camelize/blob/master/test/camel.js + * @tutorial https://github.com/andrewplummer/Sugar/blob/9c018a257a38714b81f7df033b74d236dbf1e861/lib/string.js + * @tutorial http://stackoverflow.com/questions/2970525/converting-any-string-into-camel-case + * @tutorial https://github.com/sindresorhus/camelcase + * @see https://stackoverflow.com/questions/1533131/what-useful-bitwise-operator-code-tricks-should-a-developer-know-about + * @TODO s.charAt(0).toLowerCase() + string.slice(1) + * + * @types deps + * @tests deps/camelCase + * + * @example + * + * camelCase('snake_case') + * //=> 'snakeCase' + * + */ + var camelCase = function (str) { return str + // spaces with underscore + .replace(/\s+/g, '_') + // < underscores & dashes until whitespace or end + // > .toUpperCase x & '_' + .replace(/[_.-](\w|$)/g, function (m, x) { return x.toUpperCase(); }); }; + + /* ___filename___: dist/deps/conditional/not.js */ + /** + * @desc return a negated function + * @name not + * @memberOf conditional + * @since 4.0.1 + * @func + * + * @param {Function} fn any function + * @return {Function} !Function + * + * @example + * + * const falsed = not(x => true) + * const trued = not(x => false) + * + * trued() + * //=> true + * + * falsed() + * //=> false + * + */ + var not = function (fn) { return function (x) { return !fn(x); }; }; + + // function not(predicate) { + // return function() { + // return !predicate.apply(this, arguments) + // } + // } + + /* ___filename___: dist/deps/conditional/and.js */ + /** + * @desc first fn & second fn + * @name and + * @memberOf conditional + * @since 4.0.1 + * @func + * + * @param {Function} left first fn + * @param {Function} right second fn + * @return {boolean} both functions return truthy + * + * @example + * + * const both = and(x => typeof x === 'boolean', x => x === true) + * + * both([true]) + * //=> true + * + * both([false]) + * //=> false + * + * both([1]) + * //=> false + * + */ + var and = function (left, right) { return function (x) { return left(x) && right(x); }; }; + + /* ___filename___: dist/deps/conditional/all.js */ + + + /** + * map all values in an array to see if all match + * @memberOf conditional + * + * @since 4.0.1 + * @param {Function} predicate match the value + * @param {Array} array to match against predicate + * @return {boolean} all match predicate + * + * @see fp/curry + * + * @example + * + * const allBoolean = all(x => typeof x === 'boolean'q) + * + * allBoolean([true]) + * //=> true + * + * allBoolean([1]) + * //=> false + * + */ + var all = curry(2, function (predicate, arr) { + for (var i in arr) { + if (!predicate(arr[i])) { return false } + } + return true + }); + + var all_1 = all; + + /* ___filename___: dist/deps/conditional/and.js */ + + /* ___filename___: dist/deps/conditional/all.js */ + + /* ___filename___: dist/deps/is/arrayOf.js */ + + + + + /** + * @desc every item in an array matches predicate + * @since 4.0.0 was in validatorBuilder + * @version 5.0.0 + * + * @param {Function} predicate test to pass on every item in an array + * @return {boolean} all match predicate + * + * @example + * + * isArrayOf(isTrue)([true, true]) //=> true + * isArrayOf(isEmpty)(['']) //=> true + * + * isArrayOf(isBoolean)([true, false, 1, 2, 0]) //=> false + * isArrayOf(isString)(['string', Number]) //=> false + * + */ + var arrayOf = function isArrayOf(predicate) { + return and(array, all_1(predicate)) + }; + + /* ___filename___: dist/deps/conditional/not.js */ + + /* ___filename___: dist/deps/is/notRealOrIsEmpty.js */ + + + + + + /** + * @SIZE: another 10bytes for these fns + * @name isNotRealOrIsEmpty + * + * @see is/isReal + * @see is/isEmpty + * @see conditional/and + * @see conditional/not + * + * @type {Function} + */ + var notRealOrIsEmpty = and(not(real), empty); + + /* ___filename___: dist/deps/fp/replace.js */ + + + /** + * Replace a substring or regex match in a string with a replacement. + * + * @func + * @memberOf fp + * @since v5.0.0 + * @category String + * @sig RegExp|String -> String -> String -> String + * + * @param {RegExp|String} pattern A regular expression or a substring to match. + * @param {String} replacement The string to replace the matches with. + * @param {String} str The String to do the search and replacement in. + * @return {String} The result. + * + * @see https://github.com/ramda/ramda/blob/master/src/replace.js + * + * @example + * + * replace('foo', 'bar', 'foo foo foo'); //=> 'bar foo foo' + * replace(/foo/, 'bar', 'foo foo foo'); //=> 'bar foo foo' + * + * // Use the "g" (global) flag to replace all occurrences: + * replace(/foo/g, 'bar', 'foo foo foo'); //=> 'bar bar bar' + * + */ + var replace = curry(3, function replace(regex, replacement, str) { + return str.replace(regex, replacement) + }); + + /* ___filename___: dist/ChainedMapBase.js */ + + /* ___filename___: dist/deps/string/camelCase.js */ + + /* ___filename___: dist/deps/is/arrayOf.js */ + + /* ___filename___: dist/deps/is/notRealOrIsEmpty.js */ + + /* ___filename___: dist/deps/fp/replace.js */ + + /* ___filename___: dist/deps/validators/validatorBuilder.js */ + /** + * @since 4.0.0 <- moved out of the store, into scoped + * @since 1.0.0 + * @desc library of validators to use by name + * @modifies this.validators + * @param {Object} validators + */ + + + + + + + + + + + + + + var validators = new ChainedMapBase(); + + // eslint-disable-next-line + var stripArithmeticSymbols = replace(/[?\[\]!\|]/g, ''); + var escapedKey = function (x) { return camelCase('is-' + x); }; + var enummy = function (enums) { return function (x) { return enums === x || enums.includes(x); }; }; + + // @TODO: .remap!!! + // @TODO: can use these to return noops with error logging on development + var get$2 = function (key) { return validators.get(key) || validators.get(escapedKey(key)) || enummy(key); }; + var has = function (key) { return validators.has(key) || validators.get(escapedKey(key)); }; + var set$4 = function (key, value) { return validators.set(key, value); }; + var doesNotHave = not(has); + + /** + * @desc add custom types for validation + * @category types + * @category schema + * @types schema + * + * @since 4.0.0 <- used with schema, used in method chain + * @since 3.0.0 <- took out + * @since 1.0.0 + * + * @param {Object} types custom Types + * + * @see deps/validators/validatorFactory + * + * @example + * + * addTypes({yaya: x => typeof x === 'string'}) + * + * const chain = new Chain().methods('eh').type('yaya').build() + * + * chain.eh('good') + * //=> chain + * + * chain.eh(!!'throws') + * //=> TypeError(false != {yaya: x => typeof x === 'string'}) + * + * @example + * + * const custom = {} + * custom.enums = enums => x => enums.includes(x) + * custom['*'] = x => true + * addTypes(custom) + * //-> void + * + * new Chain().methods('eh').type('*').build().eh + * //=> validateType(custom['*']) + * + */ + var addTypes = function (types) { return validators.from(index$2(validators.entries(), types)); }; + + addTypes(index$12); + + var includesAndOr = function (x) { return x.includes('|') || x.includes('&'); }; + + /** + * @memberOf schema + * @category types + * + * @param {string} fullKey a key with `|` and/or '&' + * @return {Function} validator + * + * @example + * + * const isStringOrNumber = typeListFactory('string|number') + * + * isStringOrNumber(1) + * //=> true + * isStringOrNumber('one') + * //=> true + * isStringOrNumber(Object) + * //=> false + * + */ + function typeListFactory(fullKey) { + // already have it + if (has(fullKey)) { + return get$2(fullKey) + } + + // get all types + var orTypes = fullKey.split('|'); + var andTypes = fullKey.split('&'); + + // ensure we have all validators - sets up conditionals + for (var v = 0; v < orTypes.length; v++) { + builder(orTypes[v]); + } + + // go through all valid options, if any are true, good to go + set$4(fullKey, function (x) { + for (var v = 0; v < orTypes.length; v++) { + if (get$2(orTypes[v])(x)) { + return true + } + } + return false + }); + + return get$2(fullKey) + } + + // @TODO how to iterate properly with the bitwise fn + AND + // add another param? ignore overly complex |& things? just allow 1? + // just show how to use these shorthand fn builders + + /** + * @desc transform arithmetic strings into types + * @since 4.0.0-alpha.1 + * @category types + * + * @param {Matchable} fullKey arithmetic type key + * @return {Matchable} function to match with, with .inspect for easy debugging + * + * @types schema + * @test typed + * @test schema + * @see is + * @todo coercing values to certain types: arithmeticTypeFactory('') + * + * @example + * + * arithmeticTypeFactory('?string') + * //=> x => !isReal(x) || isString(x) + * + * @example + * + * arithmeticTypeFactory('?string|string[]') + * //=> x => isString(x) || isArrayOf(isString)(x) + * + * @example + * + * arithmeticTypeFactory('!string') + * //=> x => not(isString)(x) + * + * @example + * + * types.addTypes({star: x => true}) + * arithmeticTypeFactory('object|function|star') + * //=> x => isObj(x) || isFunction(x) || isStar(x) + * + * @example + * + * arithmeticTypeFactory('===') + * //=> x => (['===']).includes(x) + */ + function arithmeticTypeFactory(fullKey) { + var key = stripArithmeticSymbols(fullKey); + var fn = get$2(key); + var optionalType = "?" + key; + var typeOrArrayOrType = key + "[]"; + var notType = "!" + key; + + var isValidOrNotRealOrEmptyStr = or(fn, notRealOrIsEmpty); + var isValidOrArrayOfValid = or(fn, arrayOf(fn)); + if (doesNotHave(optionalType)) { + set$4(optionalType, isValidOrNotRealOrEmptyStr); + } + if (doesNotHave(typeOrArrayOrType)) { + set$4(typeOrArrayOrType, isValidOrArrayOfValid); + } + if (doesNotHave(notType)) { + set$4(notType, not(fn)); + } + + return get$2(fullKey) + } + + // ---- + // ; function split + // ---- + + // v- annoying on comments with ifs + /* prettier-ignore */ + /** + * @desc @pattern @builder -> builds using multiple factories depending on conditons + * or abstractFactory whatever + * opinionated: if it's a function, it's a validator... + * + * @category types + * @since 4.0.0 + * @param {string | Function | Primitive} fullKey arithmetic key to the validator + * @return {Function} validator + * + * @see https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Functions/Default_parameters + * @NOTE if/else is for uglifying ternaries, even though else if is not needed + * @NOTE if key is number, iterating the array + * + * @example + * + * // functionType + * const isString = x => typeof x === 'string' + * builder(isString) + * // => isString + * + * @example + * + * // stringType (built in, or custom-keyed validator, or eqeqeq) + * builder('string') + * // => isString + * + * const enummy = builder('enum') + * // => x => ['enum'].includes(x) + * + * @example + * + * // arithmeticType + * builder('string|string[]') + * // => isString || isArrayOf(isString) + * + */ + function builder(fullKey) { + if (_function(fullKey)) { + /* istanbul ignore next: dev */ + if (debug) { + console.log('functionType', {fullKey: fullKey}); + } + return fullKey + } + else if (string(fullKey) && includesAndOr(fullKey)) { + /* istanbul ignore next: dev */ + if (debug) { + console.log('andOrType', {fullKey: fullKey}); + } + return typeListFactory(fullKey) + } + else { + /* istanbul ignore next: dev */ + if (debug) { + console.log('arithmeticType', {fullKey: fullKey}, arithmeticTypeFactory(fullKey)); + } + return arithmeticTypeFactory(fullKey) + } + } + + builder.has = has; + builder.get = get$2; + builder.set = set$4; + builder.addTypes = addTypes; // was merge + builder.map = validators; + var validatorBuilder = builder; + + /* ___filename___: dist/deps/dot/paths.js */ + + /* ___filename___: dist/deps/is/stringOrNumber.js */ + + /* ___filename___: dist/deps/validators/validatorBuilder.js */ + + /* ___filename___: dist/deps/validators/schemaBuilder.js */ + + + + + + + + + + + var isNotNested = function (x) { return stringOrNumber(x) || + boolean_1(x) || + !real(x) || + error$1(x) || + regexp(x); }; + + var validateType = function (type, value, nestedSchema) { + var validator = nestedSchema || validatorBuilder(type); + return validator(value) + }; + + /** + * @desc pass the property & schema in, get a nestable typeValidator out + * @since 4.0.0-alpha.1 + * @category types + * @category schema + * + * @param {Primitive} property property name of the currently nested schema + * @param {Schema | Type} nestedSchema a nested schema with Type validators, or a Type validator + * @return {Function} typeValidator + * + * @example + * + * // property name here is `dates`, then `created`, then `at` + * nestedSchema = { + * dates: { + * created: { + * at: 'date' + * } + * } + * } + * + * input = { + * dates: { + * created: { + * at: new Date() + * } + * } + * } + * + * input = new Date() + * input = { + * dates: { + * mismatch: true + * } + * } + * + */ + var schemaFactory = function (property, nestedSchema) { + /** + * @desc build a recursive schema for all around runtime type safety + * @category types + * @category schema + * @memberOf schema + * @symb 🛂 + * @since 4.0.0-beta.1 + * + * @param {any} input the input to validate + * @return {boolean} valid + * + * @see is + * + * @example + * + * const typeValidator = schemaFactory('eh', x => typeof x === 'string') + * + * var isValid = typeValidator('stringy') + * //=> true + * + * var isValid = typeValidator(Number) + * //=> false + * + * @example + * + * const isNumber = x => typeof x === 'number' + * const typeValidator = schemaFactory('eh', {canada: 'number'}) + * + * var isValid = typeValidator({canada: 1}) + * //=> true + * + * var isValid = typeValidator({}) + * //=> false + * + * var isValid = typeValidator({canada: false}) + * //=> false + * + * var isValid = typeValidator(1) + * //=> false + * + */ + function typeValidator(input) { + if (isNotNested(input)) { + // @@DEBUGGER + return validateType(property, input, nestedSchema) + } + var longestPaths = paths(false, input, true); + + // @@DEBUGGER + + for (var l = 0; l < longestPaths.length; l++) { + var fullPath = longestPaths[l] || property; + var type = get(nestedSchema, fullPath); + var value = get(input, fullPath.split('.')); + + // @@DEBUGGER + + if (!validateType(type, value)) { + // @@DEBUGGER + return false + } + + // @@DEBUGGER + } + return true + } + + /* istanbul ignore next: devs */ + if (dev) { + typeValidator.inspect = function () { return ({property: property, nestedSchema: nestedSchema}); }; + typeValidator.toString = function () { return JSON.stringify(typeValidator.inspect(), null, 2); }; + } + return typeValidator + }; + var schemaBuilder = schemaFactory; + + /* ___filename___: dist/deps/validators/schemaBuilder.js */ + + /* ___filename___: dist/plugins/schema.js */ + /* eslint complexity: "OFF" */ + + // util + + + + + + var isFunction$1 = _undefined; + // logic + + + + var SCHEMA_KEY = 'schema'; + + var isObjOrArray = function (x) { return (obj(x) && !isFunction$1(x)) || array(x); }; + + // const meta = require('../deps/meta') + // const or = require('../deps/conditional/or') + // const and = require('../deps/conditional/and') + // const not = require('../deps/conditional/not') + // const condition = Condition(Condition.is(isFunction).and().not(isObj)).or(isArray) + // const isObjNotFn = and(not(isFunction), isObj) + // const isObjOrArray = or(isObjNotFn, isArray) + + /** + * @desc handles: + * 1. recursively building nestable schemas, + * 2. creating MethodChains for all types + * 3. carrying over the inheritable properties + * 4. @modifies @injects @decorates .add(customValidators) + * @pattern decorator...builder...plugin... + * + * @param {Schema} obj + * @return {MethodFactory} @chainable + */ + var schema = function schema(obj$$2) { + var this$1 = this; + + var parent = this.parent; + var ref = this.entries(); + var onValid = ref.onValid; + var onInvalid = ref.onInvalid; + var define = ref.define; + var getSet = ref.getSet; + var keys$$2 = keys(obj$$2); + + for (var k = 0; k < keys$$2.length; k++) { + var key = keys$$2[k]; + var value = obj$$2[key]; + + // parent.method ? parent.method(key) : + var builder = this$1.newThis().name(key); // MethodChain + + // @TODO: PLUCK METHOD FOR USING VALID KEYS + // @TODO: + // const entryKeys = ObjectKeys(entries) + // const entries = this.entries() + // for (let e = 0; e < entryKeys.length; e++) { + // const entryKey = entryKeys[e] + // const entry = entries[entryKey] + // builder[entryKey](entry) + // } + if (onInvalid) { builder.onInvalid(onInvalid); } + if (onValid) { builder.onValid(onValid); } + if (define) { builder.define(); } + if (getSet) { builder.getSet(); } + + var type = value; + if (isObjOrArray(value)) { + // @@DEBUGGER + + // could just assign to type + var traversableValidator = schemaBuilder(key, value); + + if (dev) { + traversableValidator.schema = value; + } + + type = traversableValidator; + } + + // @HACK @FIXME @TODO: this should not happen, + // just when using babel and decorating not calling constructor... + // likely needs to `return this` on each? + // parent.store = parent.store || new Map() + // parent.meta = meta(parent) + if (parent.meta) { + parent.meta(SCHEMA_KEY, key, value); + } + + builder.type(type).build(); + } + + return parent + }; + + /* ___filename___: dist/deps/encase/withSpecification.js */ + + + /** + * @desc a special encased wrapper with no try catch but same api + * @name withSpecification + * @func + * @memberOf encase + * @since 4.0.0 + * + * @param {Function} specification match + * @param {Function} call cb to determine valid or invalid + * @param {Function} onInvalid cb when invalid + * @param {Function} onInvalid cb when valid + * @return {Function} a lot of functions... + * + * @see fp/curry + * + * @example + * const onInvalid = console.error + * const onValid = console.debug + * const onCall = console.log + * const encased = withSpecification(x => true)(onCall)(onValid, onInvalid) + * + * encased(1, 2, 3) //=> onCall (did not throw) + */ + var withSpecification = curry(4, function (specification, call, onInvalid, onValid) { return function (a, b, c) { + var result = call(a, b, c); + if (specification(result)) { return onInvalid(result) } + else { return onValid(result) } + }; }); + + /* ___filename___: dist/deps/validators/error.js */ + + + + + /* istanbul ignore next: dev */ + var thrower = function (error) { return function () { + if (dev) { + console.log(error); + } + + throw error + }; }; + + /** + * @desc enhance an Error, enable rethrowing & better inspection + * @memberOf encase + * @category types + * @category encase + * + * @since 4.0.0-alpha.1 + * @param {Primitive} method method being decorated + * @param {Type} type type to validate with + * @return {Function} function that returns a decorated TypeError with .inspect & metadata (arg, thrown, meta) + * + * @TODO js stringify if development + * + * @see MethodChain + * @see validators/schemaBuilder + * @see validators/validatorBuilder + * @see plugins/encase + * + * @example + * const badValidator = x => { + * if (x === 'bad') { + * throw new Error('bad!') + * } + * } + * const enhancer = enhanceError('eh', badValidator) + * + * // called by plugins/encase when throws or invalid + * let error + * let arg = 'bad' + * try { + * error = badValidator(arg) + * } + * catch (e) { + * error = enhancer(arg, e, {metadata: true}) + * } + * + * console.log(error) + * //=> {[eh]: { type: badValidator, arg: 'bad', json, str, rethrow }} + * //=> console.log on DEVELOPMENT + */ + var error$3 = function (method, type) { return function (arg, thrown, meta) { + var argToString = toS(arg); + var data = { + [method]: { + type: type, + arg: { + val: arg, + str: argToString, + json: JSON.stringify(arg), + }, + }, + }; + + var error = assign( + new TypeError((argToString + " != " + type)), + data, + meta + ); + + // put it back in its place + if (thrown && thrown.message) { error.message += thrown.message; } + if (thrown && thrown.stack) { error.stack = thrown.stack; } + + /* istanbul ignore next: dev */ + if (dev) { + // since we are just inspecting the metadata on dev + error.inspect = function () { + var devMsg = 'inspecting on development'; + var thrownMsg = "thrown: " + thrown; + var eMsg = "compare: " + (error.message); + var errorName = "name: " + (error.name); + var argMsg = "arg: " + arg + ";\nstr: " + (toS( + arg + )) + " " + (typeof arg) + ";\njson: " + (JSON.stringify(arg)); + var typeMsg = "type: " + type; + var stackMsg = 'stack: ' + error.stack; + var dashMsg = "-----"; + var msg = "\n" + dashMsg + " " + devMsg + " " + dashMsg + "\n"; + if (meta) { msg += "meta: " + (JSON.stringify(meta)) + "\n"; } + msg += thrownMsg + "\n" + eMsg + "\n" + errorName + "\n\n"; + msg += typeMsg + "\n" + argMsg; + msg += "\n\n" + stackMsg + "\n" + dashMsg + "\n"; + return msg + }; + } + + error.reThrow = thrower(error); + return error + }; }; + + /* ___filename___: dist/deps/encase/tryCatch.js */ + + + /** + * @TODO could curry + * + * @memberOf encase + * @see https://github.com/fluture-js/Fluture#encase + * @since 4.0.0 <- moved out into a dep + * @since 1.0.0 + * + * @param {Function} call + * @return {boolean | any} validation/encased function call result + */ + var tryCatch = curry(3, function (call, onValid, onInvalid) { return function (a, b, c) { + var result; + try { + result = call(a, b, c); + return onValid ? onValid(result) : result + } + catch (error) { + // error.caught = true + // @NOTE: defaults to rethrow... if (isTrue(rethrow)) throw error + if (onInvalid) { return onInvalid(error) } + else { return error } + } + }; }); + + /* ___filename___: dist/deps/encase/tryCatch.js */ + + /* ___filename___: dist/deps/encase/encase.js */ + + + /** + * @version 5.0.0 wrapped tryCatch & withSpecification in curry + * @version 4.0.1 added custom encaser + * @since 4.0.0 + * @member encase + * @symb 🛡 + * + * @param {Function} call function to _encase_ + * @param {Function | undefined} [encaser=tryCatch] function to encase _with_ + * @return {Function} -> FunctionObject{onInvalid, onValid, rethrow, call} + * + * @example + * + * const throws = x => { + * if (x === false) { + * throw new Error('invalid - cannot be false') + * } + * return true + * } + * const api = encase(throws) + * + * + * api.onValid(console.log) + * api.onInvalid(console.error) + * + * //--- invalid + * api.call(false) + * //=> 'invalid - cannot be false' + * + * //--- valid + * api.call(true) + * //=> 'true' + * + */ + var encase = function (call, encaser) { + var encased = encaser ? encaser(call) : tryCatch(call); + + // @TODO rethink this scoped approach + // left, right, rethrow + var onInvalid; + var onValid; + + var config = function (a, b, c) { return encased(onValid, onInvalid)(a, b, c); }; + + config.then = config.onInvalid = function (fn) { + onInvalid = fn; + return config + }; + config.catch = config.onValid = function (fn) { + onValid = fn; + return config + }; + + return config + }; + + /* ___filename___: dist/deps/encase/encase.js */ + + var index$14 = encase; + + /* ___filename___: dist/deps/validators/error.js */ + + /* ___filename___: dist/plugins/encase.js */ + + + + var ERROR_META = {m: 1}; + + /** + * 3 steps + * 0. enhance error + * 1. encase function with a specification + * 2. build a function to call onInvalid or onInvalid depending + * + * @since 4.0.0 + * + * @param {string} name name of the method + * @param {Object | Function} parent object being decorated by MethodChain + * @param {Object} built the current state of the decoration + * @return {Function} curried finisher, for specification + * + * @name methodEncasingFactory + * @func methodEncasingFactory + * @symb ⛑🏭 + * @types encase + * + * @example + * + * methodEncasingFactory('eh', {}, {onSet: console.log}) + * //=> Function + * + */ + function methodEncasingFactory(name, parent, built) { + /** + * @name scopedEncase + * @func scopedEncase + * @category type + * @since 4.0.0-beta.1 + * + * @param {Function} fnToEncase depending on the result of this, call + * @param {string | Function | undefined} [type=undefined] Type + * @param {Function | undefined} [specification=undefined] Specification + * @return {Function} the method... + * + * @example + * + * const fnToEncase = arg => arg === true + * const onInvalid = (error, key, arg, instance) => console.log(arguments) + * const onValid = (key, arg, instance) => console.log(arguments) + * const encased = scopedEncase(fnToEncase) + * .onValid(onValid) + * .onInvalid(onInvalid) + * //=> typedOnCall + * + */ + return function scopedEncase(fnToEncase, type, specification) { + // @@debugger + var enhanceError = error$3(name, type, fnToEncase, parent); + + // if specification is not passed in, undefined defaults to tryCatch + var encased = index$14(fnToEncase, specification); + + // our configured functions, with fallback defaults + var onSet = built.onCall || built.onSet; + var onValid = built.onValid || onSet; + + // default to re-throw + var onInvalid = + built.onInvalid || + (function (arg, error) { return enhanceError(arg, error, ERROR_META).reThrow(); }); + + /** + * @desc this is the actual built function + * @name typedOnCall + * @func typedOnCall + * @category type + * @since 4.0.0-beta.1 + * + * @param {any} arg arg to validate + * @return {Function} typedOnCall(argToValidate: any) + * + * @example + * + * const encased = encase(fnToEncase) + * .onValid() + * .onInvalid(function) + * .call() + * + */ + return function typedOnCall(arg) { + var this$1 = this; + + // nodejs way - error first, data second, instance last + var callInvalid = function (error) { + // @@debugger + onInvalid.call(this$1, enhanceError(arg, error), arg, name, this$1); + }; + + // @TODO: ensure it isn't a syntax error and is a type error + // if it is already an error, we should only enhance it + // @example `TypeError: Cannot read property 'call' of undefined` + encased + .onInvalid(callInvalid) + // @NOTE: onValid defaults to `this.set(name, arg)` + .onValid(function (result) { + // @@debugger + onValid.call(this$1, arg, name, this$1); + }) + .call(this, arg); + + return this + } + } + } + + var encase_1 = methodEncasingFactory; + + /* ___filename___: dist/deps/encase/withSpecification.js */ + + /* ___filename___: dist/plugins/encase.js */ + + /* ___filename___: dist/plugins/types.js */ + + + + + + + + // we'll be opinionated and say either `false` or `throw` + var spec = withSpecification(not(_false)); + + /** + * @pattern factory plugin + * @param {string} name + * @param {Object} parent + * @param {Object} built + * @return {void} + */ + var types = function validatorPlugin(name, parent, built) { + // core domain of this fn, used by validators and configured fns + var type = built.type; + + if (type) { + // if (ENV_DEVELOPMENT) { + // this.debugSteps('added built type') + // } + + // create our validator in the factory, + var validator = validatorBuilder(type); + + // then encase it, prepare a TypeError factory + var encase = encase_1(name, parent, built); + var validatorMethod = encase(validator, type, spec); + + /* istanbul ignore next: dev */ + if (dev) { + validatorMethod.type = type; + } + + this.onCall(validatorMethod).onSet(validatorMethod); + } + }; + + /* ___filename___: dist/plugins/obj.js */ + + + // @TODO optimize size here ez + var obj$2 = function(methods, name) { + var this$1 = this; + + var obj = methods[name]; + + if (_function(obj)) { + return function () { + // @TODO: IS THIS THE BEST DEFAULT?! + this$1.define(false); + this$1.onCall(obj); + // .onSet(obj).onGet(obj) + } + } + else { + return function () { + this$1.from(obj); + // @NOTE: this is reserved + if (obj.set) { this$1.onSet(obj.set); } + if (obj.get) { this$1.onGet(obj.get); } + if (obj.call) { this$1.onCall(obj.call); } + if (obj.set && obj.get) { + this$1.define().getSet(); + } + } + } + }; + + /* ___filename___: dist/plugins/decorate.js */ + + + + /** + * decorates a parent when the argument is provided + * BUT THE FUNCTIONS WILL STILL BE SCOPED TO CURRENT PARENT + * for easy factory chaining + * + * @since 4.0.0-alpha.1 + * @memberOf MethodChain + * @param {Object} parentToDecorate object to put the method on instead + * @return {MethodChain} @chainable + * + * @see MethodChain + * + * @TODO this is more like a preset since it *adds* plugins? + * more of methodFactory now + * + * @example + * + * const chain = new Chain() + * const obj = {} + * chain.method('ehOh').decorate(obj).build() + * typeof obj.ehOh + * //=> 'function' + * + */ + var decorate = function(parentToDecorate) { + // @TODO is objStrict? + // if (parentToDecorate) { + this.target(parentToDecorate); + + // can use this to "undecorate" + // if (!parentToDecorate.meta) <- checks already inside of meta() + parentToDecorate.meta = index$8(parentToDecorate); + + // default returns result of calling function, + // else .parentToDecorate + return this.plugin(function(name, parent) { + parentToDecorate.meta(decorated, name); + + // @NOTE: so we can return... + /* prettier-ignore */ + return this + .returns(function returnsFunction(result) { + return result || parentToDecorate + }) + .callReturns(true) + }) + }; + + /* ___filename___: dist/plugins/autoIncrement.js */ + /** + * @plugin + * @param {Primitive} name method name + * @param {Object} parent Parent + * @return {MethodChain} @chainable + */ + var autoIncrement = function(name, parent) { + return this.initial(0).onCall(function () { return parent.tap(name, function (num) { return num + 1; }); }) + }; + + /* ___filename___: dist/plugins/autoGetSet.js */ + + + /** + * @memberOf MethodChain + * @plugin + * + * @param {Primitive} name method name being built + * @param {Object} parent parent containing the method + * @return {MethodChain} @chainable + * + * @see MethodChain + * + * @example + * + * const chain = new Chain() + * chain.methods('eh').plugin(autoGetSet).build() + * + * chain.eh(1) + * //=> Chain + * chain.eh() + * //=> 1 + * + */ + function autoGetSet(name, parent) { + var auto = function (arg) { return (_undefined(arg) ? parent.get(name) : parent.set(name, arg)); }; + + // so we know if we defaulted them + auto.autoGetSet = true; + return this.onSet(auto).onGet(auto).onCall(auto) + } + + var autoGetSet_1 = autoGetSet; + + /* ___filename___: dist/deps/util/getDescriptor.js */ + var getDescriptor = Object.getOwnPropertyDescriptor; + + /* ___filename___: dist/deps/argumentor.js */ + /** + * @desc turns arguments into an array, used as a util, for opt + * + * @since 3.0.0 + * @return {Array} + * + * @see https://github.com/aretecode/awesome-deopt + * @see https://github.com/petkaantonov/bluebird/wiki/Optimization-killers + * + * @example + * + * function eh() { + * const args = argumentor.apply(null, arguments).slice(1) + * + * console.log(args) + * //=> [1, 10, 100] + * } + * eh(0, 1, 10, 100) + * + */ + var argumentor = function() { + var arguments$1 = arguments; + + var len = arguments.length; + var args = new Array(len > 1 ? len - 1 : 0); + for (var i = 0; i < len; ++i) { args[i] = arguments$1[i]; } + return args + }; + + /* ___filename___: dist/deps/util/getPrototypeOf.js */ + var getPrototypeOf = Object.getPrototypeOf; + + /* ___filename___: dist/deps/util/getPrototypeOf.js */ + + /* ___filename___: dist/deps/util/props.js */ + + + + var getOwnPropertyNames = Object.getOwnPropertyNames; + var getOwnPropertySymbols = Object.getOwnPropertySymbols; + + // @TODO https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/getOwnPropertyDescriptors + // const getOwnPropertyDescriptors = Object.getOwnPropertyDescriptors + + /** + * @desc properties, property symbols, object keys + * ^ all again for prototype + * + * @param {Object} obj object to get properties & symbols from + * @return {Array} properties + * + * @example + * var obj = {key: true} + * allProperties(obj) + * //=> ['key'] + * + * @example + * class One { + * method() {} + * } + * class Two extends One { + * eh() {} + * } + * allProperties(new Two()) + * //=> ['eh', 'method'] + * + */ + function allProperties(obj) { + var proto = getPrototypeOf(obj); + return [].concat( + getOwnPropertyNames(obj), + getOwnPropertySymbols(obj), + keys(obj), + proto ? allProperties(proto) : [] + ) + } + + var props = allProperties; + + /* ___filename___: dist/deps/util/props.js */ + + /* ___filename___: dist/deps/gc.js */ + + + + + + // function gc() { + // if (typeof window !== 'undefined') window.global = window + // if (typeof global.gc === 'function') global.gc() + // } + + /** + * @see https://stackoverflow.com/questions/1947995/when-should-i-use-delete-vs-setting-elements-to-null-in-javascript + * @see https://v8project.blogspot.ca/2015/08/getting-garbage-collection-for-free.html + * @see https://github.com/natewatson999/js-gc + * @see https://github.com/siddMahen/node-gc + * @see http://buildnewgames.com/garbage-collector-friendly-code/ + * @see https://stackoverflow.com/questions/27597335/ensuring-object-can-be-garbage-collected + * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Memory_Management + * + * @TODO blacklist = [] param + * @TODO put all GC events into a cached map and debounce the operation + * + * @since 4.0.0 + * @desc remove all methods, mark for garbage collection + * @param {Object} obj object to traverse and clear + * @return {void} + * + * @example + * + * var scoped = {} + * var ref = () => scoped + * var obj = {scoped, ref, eh: true} + * + * markForGarbageCollection(obj) + * //=> void + * + * obj + * //=> undefined|{} + * + */ + function markForGarbageCollection(obj$$2) { + // @TODO: ArrayOrObj loop... like tons of libs do... + var props$$1 = obj(obj$$2) ? props(obj$$2) : obj$$2; //isArray(obj) ? obj + + for (var p = 0; p < props$$1.length; p++) { + if (obj(obj$$2[p])) { + markForGarbageCollection(obj$$2[p]); + } + delete obj$$2[p]; + } + + // traverse(obj).forEach(function(x) { + // const {value} = this + // + // // @NOTE: just delete the main path first, later we can use cleaner + // // const shouldIgnore = path + // // .map(pathPart => ignore.includes(pathPart)) + // // .includes(true) + // // !shouldIgnore && + // + // /* istanbul ignore else: safety for bottom up */ + // // ensure the longest paths in traverser are used... + // if (!isArray(value) && !isObj(value)) { + // this.remove() + // } + // }) + + // simple fast easy cleanup + // for (let p = 0; p < props.length; p++) { + // delete obj[p] + // } + + props$$1 = undefined; + obj$$2 = undefined; + } + + var gc = markForGarbageCollection; + + /* ___filename___: dist/plugins/schema.js */ + + /* ___filename___: dist/plugins/types.js */ + + /* ___filename___: dist/plugins/obj.js */ + + /* ___filename___: dist/plugins/decorate.js */ + + /* ___filename___: dist/plugins/autoIncrement.js */ + + /* ___filename___: dist/plugins/autoGetSet.js */ + + /* ___filename___: dist/deps/util/getDescriptor.js */ + + /* ___filename___: dist/deps/argumentor.js */ + + /* ___filename___: dist/deps/gc.js */ + + /* ___filename___: dist/MethodChain.js */ + /* eslint complexity: "OFF" */ + /* eslint import/max-dependencies: "OFF" */ + + /** + * @TODO clarify .set vs .call + * {@link https://github.com/iluwatar/java-design-patterns/tree/master/property property-pattern} + * {@link https://github.com/iluwatar/java-design-patterns/tree/master/prototype prototype-pattern} + * {@link https://github.com/iluwatar/java-design-patterns/tree/master/step-builder step-builder-pattern} + * {@link https://github.com/iluwatar/java-design-patterns/tree/master/builder builder-pattern} + * {@link https://github.com/addyosmani/essential-js-design-patterns/blob/master/diagrams/mixins.png mixin-png} + * {@link https://sourcemaking.com/design_patterns/creational_patterns creational-patterns} + * {@link https://sourcemaking.com/design_patterns/factory_method factory-method} + * {@link https://medium.com/javascript-scene/javascript-factory-functions-vs-constructor-functions-vs-classes-2f22ceddf33e constructors} + * {@link https://www.sitepoint.com/factory-functions-javascript/ js-factory-functions} + */ + + // core + + + + + // plugins + + + + + + + + // const validatorBuilder = require('./deps/validators/validatorBuilder') + // obj + + + + + + // utils + + + + + // is + + + + + + + + var DEFAULTED_KEY = 'defaulted'; + var METHOD_KEYS = [ + 'onInvalid', + 'onValid', + 'initial', + 'default', + 'type', + 'callReturns', + 'target', + 'onSet', + 'onCall', + 'onGet', + ]; + + // const SET_KEY = METHOD_KEYS[0] + + function getSetFactory(_this, name, desc) { + _this[camelCase(("set-" + name))] = desc.set; + _this[camelCase(("get-" + name))] = desc.get; + } + + function aliasFactory(name, parent, aliases) { + if (!_undefined(aliases)) { + for (var a = 0; a < aliases.length; a++) { + define(parent, aliases[a], getDescriptor(parent, name)); + } + } + } + + // @TODO to use as a function + // function _methods() {} + // _methods.use(obj) { + // this.obj = obj + // return _methods + // } + // _methods.extend = _methods.use + // _methods.methods = function(methods) { + // return new MethodChain(this.obj) + // } + + var methodFactories = {}; + + /** + * ❗ using `+` will call `.build()` in a shorthand fashion + * + * @member MethodChain + * @inheritdoc + * @class + * @extends {ChainedMap} + * @type {Map} + * + * @since 4.0.0 + * + * @types MethodChain + * @tests MethodChain + * + * @TODO maybe abstract the most re-usable core as a protected class + * so the shorthands could be used, and more functionality made external + * @TODO need to separate schema from here as external functionality & add .add + * @TODO .prop - for things on the instance, not in the store? + * !!! .sponge - absorn properties into the store + */ + var MethodChain = (function (ChainedMap) { + function MethodChain(parent) { + var this$1 = this; + + // timer.start('methodchain') + + ChainedMap.call(this, parent); + + // ---------------- + var set = this.set.bind(this); + + this.newThis = function () { return new MethodChain(parent); }; + this.toNumber = function () { return this$1.build(0); }; + + /** + * @example + * + * chain + * .method('eh') + * .type(`?string`) + * .type(`string[]`) + * .type(`string|boolean`) + * .type(`boolean[]|string[]`) + * .type(`!date`) + * + */ + this.extend(METHOD_KEYS); + + // shorthand + this.method = this.methods = function (name) { + if (this$1.length) { return this$1.build().methods(name) } + else { return this$1.name(name) } + }; + + // default argument... + this.encase = function (x) { + return set('encase', parent[x] || x || true) + }; + + // alias + this.then = this.onValid.bind(this); + this.catch = this.onInvalid.bind(this); + + this.returns = function (x, callReturns) { return set('returns', x || parent).callReturns(callReturns); }; + + // @NOTE replaces shorthands.chainWrap + this.chainable = this.returns; + + /** + * @desc alias methods + * @since 2.0.0 + * + * @param {string | Array} aliases aliases to remap to the current method being built + * @return {MethodChain} @chainable + * + * @NOTE these would be .transform + * + * @example + * + * const chain = new Chain() + * chain.methods(['canada']).alias(['eh']).build() + * chain.eh('actually...canada o.o') + * chain.get('canada') + * //=> 'actually...canada o.o') + * + */ + this.alias = function (aliases) { return this$1.tap('alias', function (old, merge) { return merge(old, toArr(aliases)); }); }; + this.plugin = function (plugin) { return this$1.tap('plugins', function (old, merge) { return merge(old, toArr(plugin)); }); }; + + this.camelCase = function () { return set('camel', true); }; + + // @NOTE: x = true is much prettier, but compiles badly + var defaultToTrue = function (x) { return (_undefined(x) ? true : x); }; + this.define = function (x) { return set('define', defaultToTrue(x)); }; + this.getSet = function (x) { return set('getSet', defaultToTrue(x)); }; + + // @TODO unless these use scoped vars, they should be on proto + // @NOTE shorthands.bindMethods + this.bind = function (target) { return set('bind', _undefined(target) ? parent : target); }; + this.autoGetSet = function () { return this$1.plugin(autoGetSet_1); }; + + this.plugin(types); + + if (objWithKeys(methodFactories)) { + keys(methodFactories).forEach(function (factoryName) { + this$1[factoryName] = function (arg) { return methodFactories[factoryName].call(this$1, arg); }; + if (dev) { + this$1[factoryName].methodFactory = true; + } + }); + } + } + + if ( ChainedMap ) MethodChain.__proto__ = ChainedMap; + MethodChain.prototype = Object.create( ChainedMap && ChainedMap.prototype ); + MethodChain.prototype.constructor = MethodChain; + + /** + * @desc setup methods to build + * @category builder + * @memberOf MethodChain + * + * @since 4.0.0-beta.1 <- moved to plugin + * @since 4.0.0 + * + * @param {string | Object | Array} methods method names to build + * @return {MethodChain} @chainable + * + * @example + * + * var obj = {} + * new MethodChain(obj).name('eh').build() + * typeof obj.eh + * //=> 'function' + * + */ + MethodChain.prototype.name = function name (methods) { + var this$1 = this; + + var names = methods; + + /** + * @desc this is a plugin for building methods + * schema defaults value to `.type` + * this defaults values to `.onCall` + */ + if (!array(methods) && obj(methods)) { + names = keys(methods); + for (var name = 0; name < names.length; name++) { + this$1.plugin(obj$2.call(this$1, methods, names[name])); + } + } + return this.set('names', names) + }; + + /** + * an object that contains nestable `.type`s + * they are recursively (using an optimized traversal cache) mapped to validators + * ❗ this method auto-calls .build, all other method config calls should be done before it + * + * @TODO link to `deps/is` docs + * + * @version 4.0.0-beta.1 <- moved to plugin + * @since 4.0.0 + * + * @category types + * @memberOf MethodChain + * + * @param {Object} obj schema + * @return {MethodChain} @chainable + * + * @TODO move out into a plugin to show how easy it is to use a plugin + * and make it able to be split out for size when needed + * + * @TODO inherit properties (in plugin, for each key) + * from this for say, dotProp, getSet + * + * @TODO very @important + * that we setup schema validation at the highest root for validation + * and then have some demo for how to validate on set using say mobx + * observables for all the way down... + * + * @typedef `schema(schema: Obj): ChainAble` + * + * @example + * + * chain + * .methods() + * .define() + * .getSet() + * .onInvalid((error, arg, instance) => console.log(error)) + * .schema({ + * id: '?number', + * users: '?object|array', + * topic: '?string[]', + * roles: '?array', + * creator: { + * name: 'string', + * email: 'email', + * id: 'uuid', + * }, + * created_at: 'date', + * updated_at: 'date|date[]', + * summary: 'string', + * }) + * + * //--- valid + * chain.created_at = new Date() + * chain.setCreatedAt(new Date()) + * + * isDate(chain.created_at) === true + * + * //--- nestable validation 👍 + * chain.merge({creator: {name: 'string'}}) + * + * //--- invalid + * chain.updated_at = false + * + */ + MethodChain.prototype.schema = function schema$$1 (obj$$1) { + return schema.call(this, obj$$1) + }; + + /** + * @desc set the actual method, also need .context - use .parent + * @memberOf MethodChain + * @since 4.0.0 + * + * @param {any} [returnValue=undefined] returned at the end of the function for ease of use + * @return {MethodChain} @chainable + * + * @TODO if passing in a name that already exists, operations are decorations... (partially done) + * @see https://github.com/iluwatar/java-design-patterns/tree/master/step-builder + * + * @example + * + * var obj = {} + * const one = new MethodChain(obj).methods('eh').getSet().build(1) + * //=> 1 + * + * typeof obj.getEh + * //=> 'function' + * + */ + MethodChain.prototype.build = function build (returnValue) { + var this$1 = this; + + var parent = this.parent; + var names = toArr(this.get('names')); + var shouldTapName = this.get('camel'); + + for (var name = 0; name < names.length; name++) { + this$1._build(shouldTapName ? camelCase(names[name]) : names[name], parent); + } + + // timer.stop('methodchain').log('methodchain').start('gc') + + // remove refs to unused + this.clear(); + delete this.parent; + gc(this); + + // very fast - timer & ensuring props are cleaned + // timer.stop('gc').log('gc') + // require('fliplog').quick(this) + + return _undefined(returnValue) ? parent : returnValue + }; + + /** + * @memberOf MethodChain + * + * @since 4.0.0 + * @protected + * @param {Primitive} name method name + * @param {Object} parent being decorated + * @param {Object} built method being built + * @return {void} + * + * @TODO optimize the size of this + * with some bitwise operators + * hashing the things that have been defaulted + * also could be plugin + * + * @example + * + * ._defaults('', {}, {}) + * + * + * @example + * + * let methodFactories + * + * ### `onSet` + * + * > defaults to `this.set(key, value)` + * + * ```ts + * public onSet(fn: Fn): MethodChain + * ``` + * + * ### `onCall` + * + * > defaults to .onSet ^ + * + * ```ts + * public onCall(fn: Fn): MethodChain + * ``` + * + * ### `onGet` + * + * > defaults to `this.get(key)` + * + * ```ts + * public onGet(fn: Fn): MethodChain + * ``` + * + */ + MethodChain.prototype._defaults = function _defaults (name, parent, built) { + // defaults + var defaultOnSet = function (arg) { return parent.set(name, arg); }; + var defaultOnGet = function () { return parent.get(name); }; + + // so we know if we defaulted them + defaultOnSet[DEFAULTED_KEY] = true; + defaultOnGet[DEFAULTED_KEY] = true; + + // when we've[DEFAULTED_KEY] already for another method, + // we need a new function, + // else the name will be scoped incorrectly + var onCall = built.onCall; + var onSet = built.onSet; + var onGet = built.onGet; + if (!onGet || onGet[DEFAULTED_KEY]) { + this.onGet(defaultOnGet); + } + if (!onCall || onCall[DEFAULTED_KEY]) { + this.onCall(defaultOnSet); + } + if (!onSet || onSet[DEFAULTED_KEY]) { + this.onSet(defaultOnSet); + } + }; + + /** + * @protected + * @since 4.0.0-alpha.1 + * @memberOf MethodChain + * + * @param {Primitive} name + * @param {Object} parent + * @return {void} + * + * @TODO allow config of method var in plugins since it is scoped... + * @TODO add to .meta(shorthands) + * @TODO reduce complexity if perf allows + * @NOTE scoping here adding default functions have to rescope arguments + */ + MethodChain.prototype._build = function _build (name, parent) { + var this$1 = this; + + var method; + var existing; + var entries = function () { return this$1.entries(); }; + + // could ternary `let method =` here + if (hasOwnProperty_1(parent, name)) { + existing = getDescriptor(parent, name); + + // avoid `TypeError: Cannot redefine property:` + if (_false(existing.configurable)) { + return + } + + // use existing property, when configurable + method = existing.value; + + if (dev) { + method.decorated = true; + } + + this.onCall(method).onSet(method); + } + else if (parent[name]) { + method = parent[name]; + + if (dev) { + method.decorated = true; + } + + this.onCall(method).onSet(method); + } + + // scope it once for plugins & type building, then get it again + var built = entries(); + + this._defaults(name, parent, built); + + // plugins can add methods, + // useful as plugins/presets & decorators for multi-name building + var instancePlugins = built.plugins; + if (instancePlugins) { + for (var plugin = 0; plugin < instancePlugins.length; plugin++) { + built = entries(); + instancePlugins[plugin].call(this$1, name, parent, built); + } + } + + // after last plugin is finished, or defaults + built = entries(); + + // wrap in encasing when we have a validator or .encase + // @NOTE: validator plugin was here, moved into a plugin + if (built.encase) { + var encased = encase_1.call(this, name, parent, built)(method); + + if (dev) { + encased.encased = method; + } + + this.onCall(encased).onSet(encased); + method = encased; + built = entries(); + } + + // not destructured for better variable names + var shouldAddGetterSetter = built.getSet; + var shouldDefineGetSet = built.define; + var defaultValue = built.default; + + // can only have `call` or `get/set`... + var onGet = built.onGet; + var onSet = built.onSet; + var onCall = built.onCall; + var initial = built.initial; + var bind = built.bind; + var returns = built.returns; + var callReturns = built.callReturns; + var alias = built.alias; + + // default method, if we do not have one already + if (!method) { + method = function (arg) { + if ( arg === void 0 ) arg = defaultValue; + + return onCall.call(parent, arg); + }; + + if (dev) { + method.created = true; + } + } + + if (bind) { + // bind = bindArgument || parent + method = method.bind(bind); + } + if (returns) { + var ref = method; + method = function() { + var args = argumentor.apply(null, arguments); + + // eslint-disable-next-line prefer-rest-params + var result = ref.apply(parent, args); + + return _true(callReturns) + ? returns.apply(parent, [result].concat(args)) + : returns + }; + } + + if (!_undefined(initial)) { + parent.set(name, initial); + } + + // --------------- stripped ----------- + + /** + * !!!!! @TODO put in `plugins.post.call` + * !!!!! @TODO ensure unique name + * + * can add .meta on them though for re-decorating + * -> but this has issue with .getset so needs to be on .meta[name] + */ + + /* istanbul ignore next: dev */ + if (dev) { + define(onGet, 'name', { + value: camelCase(((onGet.name) + "+get-" + name)), + }); + define(onSet, 'name', { + value: camelCase(((onSet.name) + "+set-" + name)), + }); + define(onCall, 'name', { + value: camelCase(((onCall.name) + "+call-" + name)), + }); + define(method, 'name', {value: camelCase(("" + name))}); + + if (built.type) { method.type = built.type; } + if (initial) { method.initial = initial; } + if (bind) { method.bound = bind; } + if (returns) { method.returns = returns; } + if (alias) { method.alias = alias; } + if (callReturns) { method.callReturns = callReturns; } + if (onGet) { method._get = onGet; } + if (onSet) { method._set = onSet; } + // eslint-disable-next-line + if (onCall != onCall) { method._call = onCall; } + } + + /* istanbul ignore next: dev */ + if (debug) { + console.log({ + name: name, + defaultValue: defaultValue, + initial: initial, + returns: returns, + onGet: onGet, + onSet: onSet, + method: method.toString(), + }); + } + + // ----------------- ;stripped ------------ + + // @TODO WOULD ALL BE METHOD.POST + // --- could be a method too --- + var getterSetter = {get: onGet, set: onSet}; + var descriptor = shouldDefineGetSet ? getterSetter : {value: method}; + if (existing) { descriptor = assign(existing, descriptor); } + + // [TypeError: Invalid property descriptor. + // Cannot both specify accessors and a value or writable attribute, #] + if (descriptor.value && descriptor.get) { + delete descriptor.value; + } + if (!_undefined(descriptor.writable)) { + delete descriptor.writable; + } + + var target = this.get('target') || parent; + + define(target, name, descriptor); + + if (shouldAddGetterSetter) { + if (target.meta) { target.meta(shorthands, name, onSet); } + getSetFactory(target, name, getterSetter); + } + + aliasFactory(name, target, alias); + + // if (built.metadata) { + // target.meta(SHORTHANDS_KEY, name, set) + // } + // require('fliplog') + // .bold('decorate') + // .data({ + // // t: this, + // descriptor, + // shouldDefineGetSet, + // method, + // str: method.toString(), + // // target, + // name, + // }) + // .echo() + }; + + // --- + + /** + * @desc add methods to the parent for easier chaining + * @alias extendParent + * @memberOf MethodChain + * + * @since 4.0.0-beta.1 <- moved to plugin + * @since 4.0.0 <- moved from Extend + * @since 1.0.0 + * + * @param {Object} [parentToDecorate=undefined] decorate a specific parent shorthand + * @return {ChainedMap} @chainable + * + * @see plugins/decorate + * @see ChainedMap.parent + * + * @example + * + * var obj = {} + * new MethodChain({}).name('eh').decorate(obj).build() + * typeof obj.eh + * //=> 'function' + * + * @example + * + * class Decorator extends Chain { + * constructor(parent) { + * super(parent) + * this.methods(['easy']).decorate(parent).build() + * this.methods('advanced') + * .onCall(this.advanced.bind(this)) + * .decorate(parent) + * .build() + * } + * advanced(arg) { + * this.set('advanced', arg) + * return this.parent + * } + * easy(arg) { + * this.parent.set('easy-peasy', arg) + * } + * } + * + * class Master extends Chain { + * constructor(parent) { + * super(parent) + * this.eh = new Decorator(this) + * } + * } + * + * const master = new Master() + * + * master.get('easy-peasy') + * //=> true + * + * master.eh.get('advanced') + * //=> 'a+' + * + * @example + * + * +chain.method('ehOh').decorate(null) + * //=> @throws Error('must provide parent argument') + * + */ + MethodChain.prototype.decorate = function decorate$$1 (parentToDecorate) { + /* istanbul ignore next: devs */ + if (dev) { + if (!(parentToDecorate || this.parent.parent)) { + throw new Error('must provide parent argument') + } + } + return decorate.call(this, parentToDecorate || this.parent.parent) + }; + + /** + * @desc adds a plugin to increment the value on every call + * @modifies this.initial + * @modifies this.onCall + * + * @memberOf MethodChain + * @version 4.0.0-beta.1 <- moved to plugin + * @version 4.0.0 <- renamed from .extendIncrement + * @since 0.4.0 + * + * @return {MethodChain} @chainable + * + * @see plugins/autoIncrement + * + * @example + * + * chain.methods(['index']).autoIncrement().build().index().index(+1).index() + * chain.get('index') + * //=> 3 + * + */ + MethodChain.prototype.autoIncrement = function autoIncrement$$1 () { + return this.plugin(autoIncrement) + }; + + return MethodChain; + }(ChainedMapBase)); + + /** + * @desc add methodFactories easily + * @static + * @since 4.0.0-beta.2 + * + * @param {Object} methodFactory factories to add + * @return {void} + * + * @example + * + * function autoGetSet(name, parent) { + * const auto = arg => + * (isUndefined(arg) ? parent.get(name) : parent.set(name, arg)) + * + * //so we know if we defaulted them + * auto.autoGetSet = true + * return this.onSet(auto).onGet(auto).onCall(auto) + * } + * MethodChain.addPlugin({autoGetSet}) + * + * + * const chain = new Chain() + * chain.methods('eh').autoGetSet().build() + * + * chain.eh(1) + * //=> chain + * chain.eh() + * //=> 1 * + * + */ + MethodChain.add = function addMethodFactories(methodFactory) { + assign(methodFactories, methodFactory); + }; + methodFactories = MethodChain.add; + + var MethodChain_1 = MethodChain; + + /* ___filename___: dist/deps/is/mapish.js */ + + + + /** + * @func isMapish + * + * @memberOf is + * @since 3.0.0 + * @extends isMap + * @variation also checks `instanceof Chainable` + * + * @param {*} x value to check + * @return {boolean} isMapish + * + * @example + * + * isMapish(new Map) + * //=> true + * + * isMapish(new Chain) + * //=> true + * + * isMapish({}) + * //=> false + * + * isMapish(1) + * //=> false + * + */ + var mapish = function (x) { return map(x) || x instanceof Chainable; }; + + /* ___filename___: dist/MethodChain.js */ + + /* ___filename___: dist/deps/is/mapish.js */ + + /* ___filename___: dist/MergeChain.js */ + /* eslint complexity: "OFF" */ + + + + + + + + + + + + + var ON_EXISTING_KEY = 'onExisting'; + var ON_VALUE_KEY = 'onValue'; + var MERGER_KEY = 'merger'; + var MERGER_OPTIONS_KEY = 'opts'; + var OBJ_KEY = 'obj'; + + /** + * @since 1.0.0 + * @type {Map} + * @extends {ChainedMapBase} + * @member MergeChain + * @memberOf Chainable + * + * @types MergeChain + * @tests MergeChain + * @see deps/dopemerge + * + * {@link https://sourcemaking.com/design_patterns/visitor visitor-pattern} + * + * @TODO consider just making this a function, + * because 80/20 onValue merger & onExisting + * are rarely used & are easily overridable with .merge + */ + var MergeChain = (function (ChainedMapBase$$1) { + function MergeChain(parent) { + ChainedMapBase$$1.call(this, parent); + + /* prettier-ignore */ + this + .extend([ON_EXISTING_KEY, ON_VALUE_KEY, OBJ_KEY]) + .set(ON_VALUE_KEY, function () { return true; }) + .set(MERGER_KEY, index$2); + } + + if ( ChainedMapBase$$1 ) MergeChain.__proto__ = ChainedMapBase$$1; + MergeChain.prototype = Object.create( ChainedMapBase$$1 && ChainedMapBase$$1.prototype ); + MergeChain.prototype.constructor = MergeChain; + + /** + * @desc options for merging with dopemerge + * @modifies this.merger | this.opts + * + * @memberOf MergeChain + * @since 1.0.2 + * @param {Object | Function} opts when object: options for the merger. when function: is the merger + * @return {MergeChain} @chainable + * @see dopemerge + * + * @example + * { + * stringToArray: true, + * boolToArray: false, + * boolAsRight: true, + * ignoreTypes: ['null', 'undefined', 'NaN'], + * debug: false, + * } + * + * @example + * .merger(require('lodash.mergewith')()) + */ + MergeChain.init = function init (parent) { + return new MergeChain(parent) + }; + + MergeChain.prototype.merger = function merger (opts) { + if (_function(opts)) { return this.set(MERGER_KEY, opts) } + return this.set(MERGER_OPTIONS_KEY, opts) + }; + + // [v] messes comments on conditional brace style + /* prettier-ignore */ + /** + * @desc merges object in, goes through all keys, checks cbs, dopemerges + * + * @since 1.0.0 + * + * @param {Object} [obj2=undefined] object to merge in, defaults to this.get('obj') + * @return {MergeChain} @chainable + * + * @see ChainedMap + * @TODO issue here if we extend without shorthands & + * we want to merge existing values... :s + * + * + * @example + * + * const chain = new Chain() + * chain.merge({canada: {eh: true}}) + * chain.merge({canada: {arr: [0, {'1': 2}], eh: {again: true}}}) + * chain.entries() + * //=> {canada:{ eh: {again: true}, arr: [0, {'1': 2}] }} + * + */ + MergeChain.prototype.merge = function merge (obj2) { + var this$1 = this; + + // better uglifying + var parent = this.parent; + var get = function (key) { return this$1.get(key); }; + + var onExisting = get(ON_EXISTING_KEY); + var onValue = get(ON_VALUE_KEY); + var opts = get(MERGER_OPTIONS_KEY); + var obj = obj2 || get(OBJ_KEY); + var merger = get(MERGER_KEY); + var shorthands$$1 = parent.meta ? parent.meta(shorthands) : {}; + var keys$$1 = keys(obj); + + // @@debugger + + /* istanbul ignore next: devs */ + if (dev) { + if (!obj) { + console.log({onExisting: onExisting, opts: opts, obj: obj, merger: merger, shorthands: shorthands$$1, keys: keys$$1, parent: parent}); + throw new Error('must provide an object to merge') + } + } + + /** + * @private + * + * since this would be slower + * if I want to not have a speedy default when using .onExisting + * should @note to use .extend + * when using chains without a class & doing .merge (edge-case) + * + * @param {Primitive} key key (shorthands[key] or just key) + * @param {*} value obj[key] + * @return {void} + * + * @TODO could use .eq here + * @TODO if (isMapish(obj)) obj = obj.entries() + * + * @example + * var obj = {key: 1} + * + * MergeChain.init(obj).merge({key: ['value']}) + * + * // goes to this internal scoped function + * handleExisting('key', ['value']) + * // if there is .onValue or .onExisting, use them, default deepmerge + * + * obj + * //=> {key: [1, 'value']} + * + */ + var handleExisting = function (key, value) { + /** + * @desc when fn is a full method, not an extended shorthand + * @since 0.5.0 + * + * @param {Primitive} keyToSet key we chose to set + * @param {*} valueToSet value we chose to set (merged, existing, new) + * @return {Parent | Chain | *} .set or [keyToSet] return + * + * @example + * + * MergeChain.init(new Chain().extend(['eh'])) + * + * //isFunction: true => call parent[keyToSet](valueToSet) + * setChosen('eh', 1) + * //=> parent + * parent.get('eh') + * //=> 1 + * + * //=>isFunction: false => parent.set(keyToSet, valueToSet) + * setChosen('oh', 1) + * //=> parent //<- unless .set is overriden + * parent.get('oh') + * //=> 1 + * + */ + var setChosen = function (keyToSet, valueToSet) { return (_function(parent[key]) + ? parent[keyToSet](valueToSet) + : parent.set(keyToSet, valueToSet)); }; + + /** + * check if it's shorthanded + * -> check if it has a value already + */ + if (_true(parent.has(key))) { + // get that value + var existing = parent.get(key); + + /** + * if we have onExisting, call it + * else default to dopemerge + */ + if (_undefined(onExisting)) { + /* istanbul ignore next: devs */ + if (debug) { + console.log( + 'parent has: no onExisting', + {existing: existing, [key]: value} + ); + } + setChosen(key, merger(existing, value, opts)); + } + else { + /* istanbul ignore next: devs */ + if (debug) { + console.log( + 'parent has: has onExisting', + {existing: existing, onExisting: onExisting, [key]: value} + ); + } + + /** + * maybe we should not even have `.onExisting` + * since we can just override merge method... + * and then client can just use a custom merger... + * + * could add and remove subscriber but that's overhead and + * tricky here, because if we set a value that was just set... + */ + setChosen(key, onExisting(existing, value, opts)); + } + } + else { + /* istanbul ignore next: devs */ + if (debug) { + console.log('parent does not have', {[key]: value}); + } + setChosen(key, value); + } + }; + + for (var k = 0, len = keys$$1.length; k < len; k++) { + // key to the current property in the data being merged + var key = keys$$1[k]; + + // we have our value, no we can change the key if needed for shorthands + var value = obj[key]; + + // @NOTE: when shorthands is an object, key is the method it should call + if (!_undefined(shorthands$$1[key]) && shorthands$$1[key] !== key) { + /* istanbul ignore next: devs */ + if (debug) { + console.log( + 'had a shorthand with a diff key than the object (likely @alias)', + {shorthandMethod: shorthands$$1[key], key: key, value: value} + ); + } + key = shorthands$$1[key]; + } + + // method for the key + var method = parent[key]; + + /* istanbul ignore next: sourcemaps trigger istanbul here incorrectly */ + // use onValue when set + if (!onValue(value, key, this$1)) { + /* istanbul ignore next: devs */ + if (debug) { + console.log('had onValue, was false, ignored', {onValue: onValue, key: key, value: value}); + } + continue + } + // when property itself is a Chainable + else if (mapish(method)) { + /* istanbul ignore next: devs */ + if (debug) { + console.log('has method or shorthand'); + } + parent[key].merge(value); + } + // we have a method or shorthand + else if (method) { + /* istanbul ignore next: devs */ + if (debug) { + console.log('has method or shorthand', {method: method, key: key, value: value}); + } + handleExisting(key, value); + } + // default to .set on the store + else { + /* istanbul ignore next: devs */ + if (debug) { + console.log('went to default', {method: method, key: key, value: value}); + } + parent.set(key, value); + } + } + + return parent + }; + + return MergeChain; + }(ChainedMapBase)); + + /** + * @memberOf MergeChain + * @method onExisting + * @since 0.9.0 + * @example + * + * const {Chain, MergeChain} = require('chain-able') + * + * const chain = new Chain().set('str', 'stringy') + * + * MergeChain.init(chain) + * .onExisting((a, b) => a + b) + * .merge({str: '+'}) + * + * chain.get('str') + * //=> 'stringy+' + * + */ + + var MergeChain_1 = MergeChain; + + // @TODO re-enable this later + // module.exports = new MethodChain(MergeChain.prototype) + // .methods(['onExisting', 'onValue', 'obj']) + // .build(MergeChain) + + /* ___filename___: dist/MergeChain.js */ + + /* ___filename___: dist/ChainedMap.js */ + + + + + + /** + * @desc ChainedMap composer + * @category Chainable + * @category Map + * @memberOf ChainedMapBase + * @class ChainedMap + * @since 0.0.1 + * @alias ComposeMap + * @extends {ChainedMapBase} + * + * @param {Class | Object | Composable} [SuperClass=ChainedMapBase] class to extend + * @return {Class} ChainedMap + * + * @see ChainedMapBase + * @tests ChainedMap + * @types ChainedMap + * + * @example + * + * const heh = class {} + * const composed = ChainedMap.compose(heh) + * const hehchain = new Composed() + * hehchain instanceof heh + * //=> true + * + */ + + var ComposeChainedMap = function (SuperClass) { + var Composed = + SuperClass === ChainedMapBase + ? SuperClass + : ChainedMapBase.compose(SuperClass); + + var ChainedMap = (function (Composed) { + function ChainedMap () { + Composed.apply(this, arguments); + } + + if ( Composed ) ChainedMap.__proto__ = Composed; + ChainedMap.prototype = Object.create( Composed && Composed.prototype ); + ChainedMap.prototype.constructor = ChainedMap; + + ChainedMap.prototype.methods = function methods (names) { return this.method(names) }; + + /** + * @desc the way to easily start building methods when using chainable instances + * + * @since 4.0.0 + * @category methods + * @alias methods + * + * @param {string | Array | Primitive} names method names to add to the object + * @return {MethodChain} @chainable + * + * @see MethodChain + * + * @example + * + * const chain = new Chain() + * chain.method('eh').build() + * chain.eh(true) + * chain.get('eh') + * // => true + * + */ + ChainedMap.prototype.method = function method (names) { + return new MethodChain_1(this).name(names) + }; + + /** + * @desc merges an object with the current store + * @since 0.4.0 + * @category merge + * + * @param {Object} obj object to merge + * @param {Function | null} [handleMergeFn=undefined] return the merger to the callback + * @return {ChainedMap} @chainable + * + * @TODO needs to pass in additional opts somehow... + * @see deps/dopemerge + * @see MergeChain + * + * @example + * + * const chain = new Chain() + * chain.set('eh', [1]) + * chain.merge({eh: [2]}) + * chain.get('eh') + * // => [1, 2] + * + * @example + * + * const chain = new Chain() + * chain.set('emptyArr', []) + * chain.merge({emptyArr: []}, mergeChain => + * mergeChain.onExisting((a, b) => []).merger((a, b) => []).merge() + * ) + * chain.get('emptyArr').length) + * //=> 0 + * + */ + ChainedMap.prototype.merge = function merge (obj, handleMergeFn) { + var merger = MergeChain_1.init(this); + + if (_undefined(handleMergeFn)) { + merger.merge(obj); + } + else { + handleMergeFn(merger.obj(obj)); + } + + return this + }; + + return ChainedMap; + }(Composed)); + + return ChainedMap + }; + + var composed = ComposeChainedMap(ChainedMapBase); + composed.compose = ComposeChainedMap; + + var ChainedMap = composed; + + /* ___filename___: dist/ChainedSet.js */ + + + + /** + * @class + * @category Chainable + * @category Set + * @memberOf Chainable + * @member ChainedSet + * + * @TODO could add .first .last ? + * @NOTE had Symbol.isConcatSpreadable but it was not useful + * + * @tutorial https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set + * @see http://2ality.com/2015/09/well-known-symbols-es6.html + * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/isConcatSpreadable + * @see Chainable + * @tests ChainedSet + * @types ChainedSet + * + * @extends {Chainable} + * @prop {Set} store + * @type {Set} + */ + var ChainedSet = (function (Chainable$$2) { + function ChainedSet(parent) { + Chainable$$2.call(this, parent); + this.store = new Set(); + } + + if ( Chainable$$2 ) ChainedSet.__proto__ = Chainable$$2; + ChainedSet.prototype = Object.create( Chainable$$2 && Chainable$$2.prototype ); + ChainedSet.prototype.constructor = ChainedSet; + + /** + * @desc appends a new element with a specified value to the end of the .store + * @memberOf ChainedSet + * @since 0.4.0 + * + * @param {any} value any value to add to **end** of the store + * @return {ChainedSet} @chainable + * + * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set/add mozilla-set-add} + * {@link https://github.com/lodash/lodash/blob/master/.internal/addSetEntry.js#L9 lodash-add-set-entry} + * @see {@link mozilla-set-add} + * @see {@link lodash-add-set-entry} + * + * @example + * + * const people = new ChainedSet() + * people + * .add('sam') + * .add('sue') + * + * for (let name of people) console.log(name) + * //=> sam, sue + * + */ + ChainedSet.prototype.add = function add (value) { + this.store.add(value); + return this + }; + + /** + * @desc inserts the value at the **beginning** of the Set + * @memberOf ChainedSet + * @since 0.4.0 + * + * @param {any} value any value to add to **beginning** the store + * @return {ChainedSet} @chainable + * + * @example + * + * const people = new ChainedSet() + * people + * .add('sue') + * .prepend('first') + * + * for (let name of people) console.log(name) + * //=> first, sue + * + */ + ChainedSet.prototype.prepend = function prepend (value) { + this.store = new Set([value].concat(Chainable$$2.prototype.values.call(this))); + return this + }; + + /** + * @desc merge any Array/Set/Iteratable/Concatables into the array, at the end + * @since 0.4.0 + * @memberOf ChainedSet + * + * @param {Array | Set | Concatable} arr values to merge in and append + * @return {ChainedSet} @chainable + * + * @example + * + * const people = new ChainedSet() + * people + * .add('sam') + * .add('sue') + * .prepend('first') + * .merge(['merged']) + * + * for (let name of people) console.log(name) + * //=> first, sam, sue, merged + * + */ + ChainedSet.prototype.merge = function merge (arr) { + var this$1 = this; + + var mergeable = toArr(arr); + for (var i = 0; i < mergeable.length; i++) { + this$1.store.add(mergeable[i]); + } + return this + }; + + return ChainedSet; + }(Chainable)); + + var ChainedSet_1 = ChainedSet; + + /* ___filename___: dist/ChainedMap.js */ + + /* ___filename___: dist/FactoryChain.js */ + + + + + + var ON_CHAIN_UP_DOWN_KEY = 'onChainUpDown'; + var ON_DONE_KEY = 'onDone'; + + /** + * @extends {ChainedMapBase} + * @inheritdoc + * @prop {Object} data + * @prop {Set} _calls + * @type {Map} + * + * {@link http://robdodson.me/javascript-design-patterns-factory/ abstract-factory-pattern} + * + * @member FactoryChain + * @category Chainable + * @tests FactoryChain + * @types FactoryChain + */ + var FactoryChain = (function (ChainedMap$$1) { + function FactoryChain(parent) { + ChainedMap$$1.call(this, parent); + + this.data = {}; + this._calls = new Set(); + + this.factory() + .extend(['optional', 'required', ON_CHAIN_UP_DOWN_KEY, ON_DONE_KEY]) + .set('len', 0); + } + + if ( ChainedMap$$1 ) FactoryChain.__proto__ = ChainedMap$$1; + FactoryChain.prototype = Object.create( ChainedMap$$1 && ChainedMap$$1.prototype ); + FactoryChain.prototype.constructor = FactoryChain; + + /** + * @desc chain back up to parent for any of these + * @since 2.0.0 + * + * @param {Array} methods methods to trigger `onChainUpDown` on + * @return {FactoryChain} @chainable + * + * @memberOf FactoryChain + * @emits onChainUpDown + * @TODO should have a debug log for this + * + * @example + * + * const {Chain, FactoryChain, ChainedSet} = require('chain-able') + * + * class Things extends Chain { + * constructor(parent) { + * super(parent) + * this.people = new ChainedSet(this) + * } + * person() { + * const person = new FactoryChain(this) + * person + * .props(['name', 'age', 'email']) + * .onChainUpDown(this.person) + * .chainUpDowns(['person']) + * .onDone(personChain => { + * this.people.add(personChain) + * return this + * }) + * + * return person + * } + * } + * + * const things = new Things() + * const returned = things + * .person() + * .name('sue') + * .person() + * .age(100) + * .name('john') + * .email('@') + * + */ + FactoryChain.prototype.chainUpDowns = function chainUpDowns (methods) { + var arguments$1 = arguments; + var this$1 = this; + + methods.forEach(function (m) { + this$1[m] = function () { + // @@debugger + this$1.end(); + return this$1.parent[m].apply(this$1.parent, arguments$1) + }; + }); + return this + }; + + /** + * @desc adds an *array* of properties, using FactoryChain.prop + * @since 2.0.0 + * + * @memberOf FactoryChain + * @param {Array} names property names + * @return {FactoryChain} @chainable + * + * @see FactoryChain.prop + * + * @example + * + * person.props(['name', 'age', 'email']) + * + * typeof person.name + * //=> 'function' + * + * person.name().age() + * //=> FactoryChain + * + * person.name().age().email() + * //=> ParentChain + * + * // person.name().age().person() + * //=> FactoryChain + * //^ because .person is `chainUpDowns` + * //^ so it finishes the old chain, and begins a new one + * + */ + FactoryChain.prototype.props = function props (names) { + var this$1 = this; + + names.forEach(function (name) { return this$1.prop(name); }); + return this + }; + + /* istanbul ignore next: sourcemaps trigger istanbul here incorrectly */ + /** + * @desc add property that are counted towards the call count for easy auto-ending chaining + * @since 2.0.0 + * + * @param {Primitive} name property name + * @param {Function | null | undefined} [onCall=undefined] callback for the property + * @return {FactoryChain} @chainable + * + * @memberOf FactoryChain + * + * @example + * + * person + * //.prop also accepts an optional callback, + * //for nestable nestable chains + * .prop('name') + * .prop('age') + * .prop('email') + * + */ + FactoryChain.prototype.prop = function prop (name, onCall) { + var this$1 = this; + + this.tap('len', function (len) { return len + 1; }); + + // so if we call a property twice, + // chain back up to parent, + // add a new chain + if (!_undefined(this[name]) && _true(this.has(ON_CHAIN_UP_DOWN_KEY))) { + this.end(); + return this.get(ON_CHAIN_UP_DOWN_KEY)()[name](onCall) + } + + // @TODO need to spread as needed + this[name] = function (args) { + // @@debugger + /* istanbul ignore next: devs */ + if (debug) { + console.log( + ("called " + name + " with:"), + args, + "calls length is now:", + this$1._calls.size + ); + } + if (_undefined(onCall)) { this$1.data[name] = args; } + else { onCall(args); } + + this$1._calls.add(name); + + // aka magicReturn + return this$1._calls.size === this$1.get('len') ? this$1.end() : this$1 + }; + return this + }; + + /** + * @desc access data being built when stepping through a factory + * @since 2.0.0 + * + * @param {Primitive} [prop=undefined] key of the data, or returns all data + * @return {any} this.data + * + * @memberOf FactoryChain + * + * @example + * + * .data['prop'] = 'eh' + * .getData('prop') + * //=> 'eh' + * .getData() + * //=> {prop: 'eh'} + * + * @example + * + * const person = new FactoryChain(this) + * const age = person.props(['name', 'age']).age(10).getData('age') + * expect(age).toBe(10) + * + */ + FactoryChain.prototype.getData = function getData (prop) { + /* istanbul ignore next: sourcemaps trigger istanbul here incorrectly */ + return _undefined(prop) ? this.data : this.data[prop] + }; + + /* istanbul ignore next: sourcemaps trigger istanbul here incorrectly */ + /** + * @desc creates/add the `.end` method, + * which checks how many methods have been called, + * and decides whether to return parent or not + * @modifies this.end + * + * @since 2.0.0 + * + * @param {Object} [obj={}] optional object to use for creating .end + * @return {FactoryChain} @chainable + * + * @memberOf FactoryChain + */ + FactoryChain.prototype.factory = function factory (obj) { + var this$1 = this; + + this.end = function (arg) { + // @@debugger + var ended; + + if (obj && !_undefined(obj.end)) { ended = obj.end; } + else if (this$1.has(ON_DONE_KEY)) { ended = this$1.get(ON_DONE_KEY); } + + if (ended) { ended = ended.call(this$1, this$1.data, this$1.parent, this$1, arg); } + + if (ended && ended !== this$1) { return ended } + else { return this$1.parent } + }; + + return this + }; + + return FactoryChain; + }(ChainedMap)); + + var FactoryChain_1 = FactoryChain; + + /* ___filename___: dist/deps/fp/pipe.js */ + /** + * Performs left-to-right function composition. The leftmost function may have + * any arity; the remaining functions must be unary. + * + * In some libraries this function is named `sequence`. + * + * @NOTE The result of pipe is not automatically curried. + * @NOTE This is a variation, is the internal version with only 2 functions, for now + * + * @func + * @memberOf fp + * @since v5.0.0 + * @category Function + * @sig (((a, b, ..., n) -> o), (o -> p), ..., (x -> y), (y -> z)) -> ((a, b, ..., n) -> z) + * @symb R.pipe(f, g, h)(a, b) = h(g(f(a, b))) + * + * @param {...Function} f function first + * @param {...Function} g function next + * @return {Function} + * + * @see R.compose + * @see https://github.com/ramda/ramda/blob/master/src/pipe.js + * + * @example + * + * var f = R.pipe(Math.pow, R.negate, R.inc); + * f(3, 4); // -(3^4) + 1 + * + */ + var pipe = function _pipe(f, g) { + return function() { + return g.call(this, f.apply(this, arguments)) + } + }; + + /* ___filename___: dist/deps/matcher/escape-string-regex.js */ + + + /** + * @func escapeStringRegExp + * @module escape-string-regexp + * @memberOf matcher + * @since 3.0.0 + * + * @param {string} str string to escape + * @return {string} escaped string + * + * {@link https://github.com/sindresorhus/escape-string-regexp escape-string-regexp} + * @see {@link escape-string-regexp *} 🍴 + * @see fp/replace + * + * @NOTE also as const escapeStringRegexp = require('escape-string-regexp'); + * + * @example + * + * const escaped = escapeStringRegexp('how much $ for a unicorn?'); + * //=> 'how much \$ for a unicorn\?' + * new RegExp(escaped); + * + */ + var escapeStringRegex = replace(/[|\\{}()[\]^$+*?.]/g, '\\$&'); + + /* ___filename___: dist/deps/fp/pipe.js */ + + /* ___filename___: dist/deps/matcher/escape-string-regex.js */ + + /* ___filename___: dist/deps/matcher/to-regexp.js */ + + + + + /** + * @func toRegExp + * @memberOf matcher + * @module to-regexp + * @extends escapeStringRegExp + * + * @param {string} str string to escape + * @return {string} escaped str + * + * @example + * + * toRegExp('*') + * => '.*' + * + * toRegExp('eh') + * => 'eh' + * + */ + var toRegexp = pipe(escapeStringRegex, replace(/\\\*/g, '.*')); + + /* ___filename___: dist/deps/matcher/to-regexp.js */ + + /* ___filename___: dist/deps/matcher/matcher.js */ + /** + * @name matcher + * @member matcher + * @see https://github.com/sindresorhus/matcher/blob/master/index.js + * @symb 🎯 + * @types matcher + * @tests deps/matcher + */ + + + + + + + var m = {}; + + /** + * @desc turn any string[], function[], or RegExp[] into a matcher + * @memberOf matcher + * @since 3.0.0 + * @func make + * + * @param {Array | string | Function | RegExp} pattern a matchable pattern + * @param {boolean | undefined} shouldNegate turn into a negated regex + * @param {boolean | undefined} alphaOmega should have regex start at the beginning and the end + * @return {Array | string | Function | RegExp} matchable + * + * @example + * + * matcher.make('*') + * //=> RegExp('.*', 'i') + * + * @example + * + * var any = new RgExp('.*', 'i') + * matcher.make(any) + * //=> any + * + * @example + * + * var strings = x => typeof x === 'string' + * matcher.make(strings) + * // {test: strings} + * + * @example + * + * var tester = {test: x => x === true} + * matcher.make(tester) + * // tester + * + * @example + * + * var noName = '!name' + * matcher.make(noName, true) + * // new RegExp('(?:name)', 'i') + * + * @example + * + * var noName = '!name' + * matcher.make(noName, true, true) + * // new RegExp('^(?:name)$', 'i') + * + */ + m.make = function (pattern, shouldNegate, alphaOmega) { + if (index$10.has(pattern)) { return index$10.get(pattern) } + + var matchable = pattern; + if (matcher(matchable) && !matchable.test) { matchable.test = matchable; } + if (matcher(matchable)) { return matchable } + + // if (!matchable) { + // console.log({pattern, shouldNegate, alphaOmega}) + // throw new Error('eh') + // } + var negated = matchable[0] === '!'; + if (negated) { matchable = matchable.slice(1); } + matchable = toRegexp(matchable); + + if (negated && shouldNegate) { matchable = "(?!" + matchable + ")"; } + if (alphaOmega) { matchable = "^" + matchable + "$"; } + + matchable = new RegExp(("" + matchable), 'i'); + matchable.negated = negated; + + index$10.set(pattern, matchable); + return matchable + }; + + /** + * @desc same as .make but also accepts inputs, and returns an array + * @memberOf matcher + * @func match + * @since 3.0.0 + * + * @param {Array | string} inputs input to use patterns as predicates on + * @param {Array | string | Function | RegExp} patterns predicates to match with, transformed to Matcher + * @param {boolean | undefined} shouldNegate should negate, passed to matcher.make + * @param {boolean | undefined} alphaOmega should enforce regex @beginning and end, passed to .matcher + * @return {Array} + * + * @see Matcher.make + * @see compose/Observe + * + * @example + * + * + * matcher(['foo', 'bar', 'moo'], ['*oo', '!foo']); + * //=> ['moo'] + * + * matcher(['foo', 'bar', 'moo'], ['!*oo']); + * + * + * @example + * + * + * matcher('kinga', 'kinga') + * //=> ['kinga'] + * matcher('k*nga', 'kinga') + * //=> ['kinga'] + * matcher('kinga', 'nope') + * //=> [] + * + * matcher(new RegExp(/kinga/), 'kinga') + * //=> ['kinga'] + * matcher(new RegExp(/kinga/), 'nope') + * //=> ['nope'] + * + * matcher(x => x === 'kinga', 'kinga') + * //=> ['kinga'] + * matcher(x => x === 'kinga', 'nope') + * //=> [] + * + * matcher({test: x => x === 'kinga'}, 'kinga') + * //=> ['kinga'] + * matcher({test: x => x === 'kinga'}, 'nope') + * //=> [] + * + * + */ + m.matcher = function (inputs, patterns, shouldNegate, alphaOmega) { + patterns = toArr(patterns).map(function (p) { return m.make(p, shouldNegate, alphaOmega); }); + inputs = toArr(inputs); + + var firstNegated = patterns[0].negated; + var matchesToReturn = []; + + for (var i = 0; i < inputs.length; i++) { + var input = inputs[i]; + // If first pattern is negated we include everything to match user expectation + var matches = firstNegated; + for (var j = 0; j < patterns.length; j++) { + if (patterns[j].test(input)) { + matches = !patterns[j].negated; + } + } + + if (matches) { matchesToReturn.push(input); } + } + + return matchesToReturn + }; + + /** + * @TODO replace to-test + */ + // m.test = (inputs, patterns) => m.matcher(inputs, patterns).length !== 0 + + var matcher$2 = assign(m.matcher, m); + + /* ___filename___: dist/deps/matcher/matcher.js */ + + var index$18 = matcher$2; + + /* ___filename___: dist/deps/dot/has.js */ + + + + + /** + * @name dot.has + * @memberOf dot + * @func + * @since 3.0.0 + * @extends dot/getPathSegments + * + * @param {Object} obj the object to retrieve the nested property from. + * @param {Dottable | string | Array} path dot-prop-path to use + * @return {boolean} has at path + * + * @example + * + * dot.has({a: {b: 2}}, 'a.b'); //=> true + * dot.has({a: {b: 2}}, ['a', 'b']); //=> true + * dot.has({c: {b: 2}}, ['a', 'b']); //=> undefined + * + */ + var has$1 = function dotHas(obj$$2, path) { + if (!dottable(obj$$2, path)) { + return false + } + + var pathArr = segments(path); + + for (var i = 0; i < pathArr.length; i++) { + if (obj(obj$$2)) { + if (!(pathArr[i] in obj$$2)) { + return false + } + + obj$$2 = obj$$2[pathArr[i]]; + } + else { + return false + } + } + + return true + }; + + /* ___filename___: dist/deps/dot/delete.js */ + + + + + + /** + * @desc delete a path on an object + * @name dot.delete + * @memberOf dot + * @func + * @since 3.0.0 + * @extends dot/getPathSegments + * + * @param {Object} obj the object to DELETE the nested property from. + * @param {Dottable | string | Array} path dot-prop-path to use + * @return {void} + * + * + * @example + * + * dot.get({a: {b: 2}}, 'a.b'); //=> 2 + * dot.get({a: {b: 2}}, ['a', 'b']); //=> 2 + * dot.get({c: {b: 2}}, ['a', 'b']); //=> undefined + * + */ + var _delete = function dotdelete(obj$$2, path) { + if (!dottable(obj$$2, path)) { + return + } + + var pathArr = segments(path); + + for (var i = 0; i < pathArr.length; i++) { + var p = pathArr[i]; + + if (i === lengthMinusOne(pathArr)) { + delete obj$$2[p]; + return + } + + obj$$2 = obj$$2[p]; + + if (!obj(obj$$2)) { + return + } + } + }; + + /* ___filename___: dist/deps/dot/has.js */ + + /* ___filename___: dist/deps/dot/delete.js */ + + /* ___filename___: dist/deps/dot/dot-prop.js */ + + + + + + var dotProp = { + has: has$1, + get: get, + set: set$2, + delete: _delete, + }; + + /* ___filename___: dist/deps/dot/dot-prop.js */ + + var index$20 = dotProp; + + /* ___filename___: dist/compose/Observe.js */ + + + // const eq = require('../deps/traversers/eq') + + + + + + var eq$1 = traverse_1.eq; + + /** + * scoped clones + * @private + * @type {Map} + */ + var objs = new Map(); + + /** + * @desc > subscribe to changes + * ❗ called only on **change** + * observers are only called when data they subscribe to changes + * + * @since 3.0.1 + * @class Observe + * @member Observe + * @extends {ChainedMap} + * @extends {DotProp} + * @memberOf compose + * @category Chainable + * + * @param {Class | Composable} Target composable class + * @return {Observe} class + * + * @tests Observe + * @types Observe + * + * @see ChainedMap + * @see DotProp + * @see deps/matcher + * @see deps/traversers/eq + * @see deps/traverse + * @see DotProp + * + * {@link https://github.com/iluwatar/java-design-patterns/tree/master/observer observer-pattern} + * {@link https://github.com/ReactiveX/rxjs/blob/master/src/Subscriber.ts reactivex} + * {@link https://github.com/sindresorhus/awesome-observables awesome-observables} + * {@link https://medium.com/@benlesh/learning-observable-by-building-observable-d5da57405d87 building-observables} + * {@link https://github.com/addyosmani/essential-js-design-patterns/blob/master/diagrams/observer.png js-observer-png} + * {@link https://github.com/addyosmani/essential-js-design-patterns/blob/master/diagrams/publishsubscribe.png pubsub-png} + * {@link https://github.com/tusharmath/observable-air observable-air} + * + * @see {@link reactivex} + * @see {@link awesome-observables} + * @see {@link building-observables} + * @see {@link observer-pattern} + * @see {@link observable-air} + * + * @example + * + * const {compose} = require('chain-able') + * const {DotProp} = compose + * new DotProp() + * //=> DotProp + * + */ + var Observe = function (Target) { + // return class Observe extends Target { + /** + * @desc observe properties when they change + * + * @method + * @memberOf Observe + * @since 4.0.0 <- refactored with dot-prop + * @since 1.0.0 + * + * @param {Matchable} properties Matchable properties to observe + * @param {Function} fn onChanged + * @return {Target} @chainable + * + * @see traversers/eq + * @see toarr + * @see matcher + * + * {@link https://jsfiddle.net/wqxuags2/28/ for a Demo Clock with observable} + * + * @see {@link for a Demo Clock with observable} + * @see examples/playground/TodoStore + * + * @TODO gotta update `data` if `deleting` too... + * @TODO un-observe + * @TODO should hash these callback properties + * @TODO just throttle the `.set` to allow easier version of .commit + * + * @example + * + * const Target = require('chain-able') + * + * const chain = new Target() + * const log = arg => console.log(arg) + * + * chain + * .extend(['eh']) + * .observe('eh', data => log(data)) + * .eh(true) + * //=> {eh: true} + * + * @example + * + * chain + * .extend(['canada', 'timbuck']) + * .observe(['canad*'], data => console.log(data.canada)) + * .canada(true) + * .canada(true) + * .timbuck(false) + * + * //=> true + * //=> false + * + * // only called when changed, + * // otherwise it would be 2 `true` & 1 `false` + * + */ + Target.prototype.observe = function chainObserve(properties, fn) { + var this$1 = this; + + var props = toArr(properties); + var hashKey = props.join('_'); + var data = {}; + + /* prettier-ignore */ + return this.meta(observers, function (changed) { + /** + * match the keys, make the data out of it + */ + var m = index$18(changed.key, props); + + // @@debugger + + for (var i = 0; i < m.length; i++) { + var segments$$2 = segments(m[i]); + index$20.set(data, segments$$2, this$1.get(segments$$2)); + } + + /** + * if we have called it at least once... + * and it has not changed, leave it + * else + * clone it + * call the observer + */ + if (objs.has(hashKey) && eq$1(objs.get(hashKey), data)) { + // @@debugger + return + } + + // @@debugger + + /** + * it did change - clone it for next deepEquals check + */ + objs.set(hashKey, traverse_1(data).clone()); + + /** + * call the observer - it matched & data changed + */ + fn.call(this$1, data, this$1); + }) + }; + return Target + }; + + /* ___filename___: dist/compose/Shorthands.js */ + /** + * @since 2.0.0 + */ + + + + + /** + * @class Shorthands + * @member Shorthands + * @extends {ChainedMap} + * @extends {DotProp} + * @memberOf compose + * @category Chainable + * + * @param {Class | Composable} Target composable class + * @return {Shorthands} class + * + * @tests Shorthands + * @types Shorthands + * + * @see ChainedMap + * @see DotProp + * @see deps/matcher + * @see deps/traversers/eq + * @see deps/traverse + * @see DotProp + * + * {@link https://github.com/ReactiveX/rxjs/blob/master/src/Subscriber.ts reactivex} + * {@link https://github.com/sindresorhus/awesome-observables awesome-observables} + * {@link https://medium.com/@benlesh/learning-observable-by-building-observable-d5da57405d87 building-observables} + * @see {@link reactivex} + * @see {@link awesome-observables} + * @see {@link building-observables} + * + * @example + * + * const {compose} = require('chain-able') + * const {DotProp} = compose + * new DotProp() + * //=> DotProp + * + */ + var Shorthands = function (Target) { + return (function (Target) { + function Shorthands(parent) { + Target.call(this, parent); + + if (parent && parent.meta) { + this.meta.debug = parent.meta.debug; + } + else { + this.debug(false); + } + } + + if ( Target ) Shorthands.__proto__ = Target; + Shorthands.prototype = Object.create( Target && Target.prototype ); + Shorthands.prototype.constructor = Shorthands; + + // https://github.com/fluents/chain-able/issues/32 + // find(key, data = this.entries(true)) { + // let val = null + // const matcher = new RegExp(key.replace(/[|\\{}()[\]^$+*?.]/g, '\\$&')) + // // console.debug(`key: ${key} `) + // const cb = (x, traverser) => { + // if (matcher.test(traverser.key) || traverser.path.includes(key)) { + // val = x + // traverser.stop() + // // console.error({x}) + // } + // // console.debug(`path: ${traverser.path.join('.')} prop: ${traverser.key}`) + // // console.dir({x, path: traverser.path, key: traverser.key}) + // } + // + // traverse(data).forEach(function(x) { + // cb(x, this) + // }) + // return val + // } + + /** + * @desc sets on store not this.set for easier extension + * + * @since 4.0.0 <- moved from Extend to Shorthands + * @since 0.2.0 + * + * @param {boolean} [should=true] shouldDebug + * @return {Chainable} @chainable + * + * @NOTE is inherited by any chain with a parent with .meta.debug + * + * @example + * + * const Chain = require('chain-able') + * const chain = new Chain() + * chain.debug() + * + * chain.get('debug') + * //=> true + * + * // not in entries + * chain.entries() + * //=> {} + * + */ + Shorthands.prototype.debug = function debug (should) { + this.meta.debug = _undefined(should) ? true : should; + return this + }; + + /** + * @desc sets a value **only** when .has is false + * aka set if the value has not been set + * + * @memberOf ShorthandChain + * @since 1.0.2 + * + * @param {Primitive} name key to set if it has not been done so already + * @param {any} value value to set when key has not been already set + * @return {ShorthandChain} @chainable + * + * @see ChainedMapBase.set + * + * @example + * + * const chain = new Chain() + * + * chain.set('eh', true) + * + * // eh is already set ^, ignored + * chain.setIfEmpty('eh', false) + * + * chain.get('eh') + * //=> true + * + * @example + * + * new Chain().setIfEmpty('canada', true).entries() + * //=> {canada: true} + * + * @example + * + * // longhand way to do the same thing + * if (chain.has('eh') === false) { + * chain.set('eh', false) + * } + * + * // or using .when + * chain.when(!chain.has('eh'), instance => instance.set('eh', false)) + * + */ + Shorthands.prototype.setIfEmpty = function setIfEmpty (name, value) { + if (_false(this.has(name))) { return this.set(name, value) } + else { return this } + }; + + /** + * @desc returns any value passed in + * return a value at the end of a chain regardless + * + * @memberOf ShorthandChain + * @since 3.0.0 + * + * @param {any} value value to return at the end of a chain + * @return {any} value + * + * @example + * + * const chain = new Chain() + * + * const saveAndDebug = env => chain + * .from({env: env.NODE_ENV}) + * .return(JSON.stringify(env)) + * + * console.log(saveAndDebug(process.env)) + * //=> value of process.env + */ + Shorthands.prototype.return = function return$1 (value) { + return value + }; + + /** + * @desc wrap a value, if it's a Function call it, return this + * aka execute something and return this + * + * @memberOf ShorthandChain + * @since 2.0.0 + * @param {Function | any} fn function to call, or just any value + * @return {ShorthandChain} @chainable + * + * @example + * + * const {eh} = chain.wrap(chain => chain.eh = true) + * //=> true + * + * @example + * + * new Chain() + * .wrap(encased => encased.fn = arg => { + * throw new Error('encased yo') + * }) + * .method('fn') + * .encase() + * .catch(error => { + * //=> Error('encasedYo') + * }) + * .build() + * .fn(true) + * + */ + Shorthands.prototype.wrap = function wrap (fn) { + if (_function(fn)) { fn.call(this, this); } + return this + }; + + return Shorthands; + }(Target)) + }; + + /* ___filename___: dist/deps/matcher/to-test.js */ + + + + + /** + * @desc like matcher, but .isMatch + * @since 3.0.0 + * + * @param {Matchable} matchable any matchable + * @param {any} [arg1=undefined] arg to match with + * @param {any} [arg2=undefined] optional second arg to pass into tester + * @return {boolean} is a match, passes the test + * + * @NOTE as else-if for easier ternary uglification + * + * @example + * + * matcher('kinga', 'kinga') + * //=> true + * matcher('k*nga', 'kinga') + * //=> true + * matcher('kinga', 'nope') + * //=> false + * + * matcher(new RegExp(/kinga/), 'kinga') + * //=> true + * matcher(new RegExp(/kinga/), 'nope') + * //=> false + * + * matcher(x => x === 'kinga', 'kinga') + * //=> true + * matcher(x => x === 'kinga', 'nope') + * //=> false + * + * matcher({test: x => x === 'kinga'}, 'kinga') + * //=> true + * matcher({test: x => x === 'kinga'}, 'nope') + * //=> false + * + */ + var toTest = function (matchable, arg1, arg2) { + if (string(matchable)) { return !!new RegExp(escapeStringRegex(matchable)).test(arg1) } + else if (_function(matchable) && !matchable.test) { return !!matchable(arg1) } + else { return !!matchable.test(arg1, arg2) } + }; + + /* ___filename___: dist/deps/matcher/to-test.js */ + + /* ___filename___: dist/deps/matcher/any-key-val.js */ + + + /** + * the original simple to-test matcher for traversable, + * will be merged into, or simplified as simplified into matcher + * + * @since 2.0.0 + * + * @TODO should use matcher, + * @TODO should inprove the callback data... + * + * @types matcher + * + * @param {Matchable[]} keys matchable keys + * @param {Matchable[]} vals matchable values + * @return {boolean} matched or not + * + * @example + * + * anyKeyVal([], [])(0, 0) + * //=> false + * + * anyKeyVal([() => true], [])(0, 0) + * //=> true + * + */ + var anyKeyVal = function (keys, vals) { return function (prop, val) { + for (var i = 0; i < keys.length; i++) { + if (toTest(keys[i], prop, val)) { return true } + } + for (var i$1 = 0; i$1 < vals.length; i$1++) { + if (toTest(vals[i$1], val, prop)) { return true } + } + return false + }; }; + + /* ___filename___: dist/deps/matcher/any-key-val.js */ + + /* ___filename___: dist/TraverseChain.js */ + + + + + + + var TRAVERSED_KEY = 1; + var EXTENSION_KEYS = ['obj', 'keys', 'vals', 'onNonMatch', 'onMatch', 'clone']; + + /** + * @since 1.0.0 + * @type {Map} + * @extends {ChainedMapBase} + * + * @memberOf Chainable + * @member Traverse + * @see deps/traverse + * @category traverse + * @types TraverseChain + * @tests TraverseChain + * @symb 👣 + * + * @prop {Object} obj + * @prop {Array} [keys] + * @prop {Array} [vals] + * @prop {Function} [onMatch] + * @prop {Function} [onNonMatch] + * @prop {boolean} [clone] + */ + var TraverseChain = (function (ChainedMapBase$$2) { + function Traverser(parent) { + ChainedMapBase$$2.call(this, parent); + this.call = this.traverse.bind(this); + + /* prettier-ignore */ + this + .extend(EXTENSION_KEYS) + .keys([]) + .vals([]) + .onMatch(function (arg, traverser) { return traverser.remove(); }); + } + + if ( ChainedMapBase$$2 ) Traverser.__proto__ = ChainedMapBase$$2; + Traverser.prototype = Object.create( ChainedMapBase$$2 && ChainedMapBase$$2.prototype ); + Traverser.prototype.constructor = Traverser; + + /** + * @desc runs traverser, checks the tests, calls the onMatch + * @modifies this.cleaned + * + * @alias call + * @since 1.0.0 + * @param {boolean} [shouldReturn=false] returns traversed object + * @return {any} this.obj/data cleaned + * + * @memberOf TraverseChain + * + * @example + * + * const traversed = new Chain() + * .merge({flat: 0, one: {two: true}}) + * .traverse(false) + * .vals([/true/]) + * .onMatch((current, traverser) => { + * traverser.path.join('.') + * //=> 'one.two' + * + * current + * //=> true + * + * typeof traverser.update === typeof traverser.remove + * typeof traverser.update === 'function' + * //=> true + * + * traverser.remove() + * //=> void + * }) + * .onNonMatch(val => { + * // ignore + * }) + * .call(true) + * + * traversed + * //=> {flat: 0} + * + */ + Traverser.prototype.traverse = function traverse$1 (shouldReturn) { + var ref = this.entries(); + var obj = ref.obj; + var keys = ref.keys; + var vals = ref.vals; + var onMatch = ref.onMatch; + var onNonMatch = ref.onNonMatch; + var clone = ref.clone; + var result = clone ? traverse_1(obj).clone() : obj; + + // diff between keys and val is order of arg in ^ tester + var matcher = anyKeyVal(keys, vals); + + /* istanbul ignore next: debug */ + if (debug) { + console.log('matcher for traverse...', keys, vals); + } + + // bound to the traverser + traverse_1(result).forEach(function(key, x, traverser) { + if (traverser.isRoot) { + // nothing + } + else if (matcher(key, x)) { + /* istanbul ignore next: debug */ + if (debug) { + console.log('------- match ------- ', key, x); + } + + onMatch(x, traverser); + } + else if (onNonMatch) { + /* istanbul ignore next: debug */ + if (debug) { + console.log('------- NONmatch ------- ', key, x); + } + + onNonMatch(x, traverser); + } + }); + + this.set(TRAVERSED_KEY, result); + return _true(shouldReturn) ? result : this + }; + + /** + * value traversed in traverse + * @since 1.0.0 + * @see TraverseChain.traverse + * @return {Object | Array | any} traversed + * + * @example + * + * const traverser = new Traverser() + * traverser.obj(['duck', 'duck', 'goose']) + * traverser.vals(['g**se']) + * traverser.traverse() + * + * traverser.traversed() + * //=> ['goose'] + * + * @example + * + * const eh = { + * me: true, + * nested: { + * really: { + * deep: { + * super: false, + * not: 'eh', + * canada: true, + * modules: [{parser: 'hi'}], + * }, + * matchme: 'minime', + * notme: 'eh', + * }, + * }, + * } + * + * const chain = new Chain() + * Object.assign(chain, eh) + * + * const traverser = chain + * .merge(eh) + * .traverse(true) + * .keys([/super/, /parser/, /store/, /meta/]) + * .vals([/minime/]) + * .call(false) + * + * traverser.traversed() + * //=> { + * className: 'DotProp', + * me: true, + * nested: { + * really: { + * deep: { + * not: 'eh', + * canada: true, + * modules: [{}], + * }, + * notme: 'eh', + * }, + * }, + * } + * + */ + Traverser.prototype.traversed = function traversed () { + return this.get(TRAVERSED_KEY) + }; + + return Traverser; + }(ChainedMapBase)); + + /* ___filename___: dist/TraverseChain.js */ + + /* ___filename___: dist/compose/Transform.js */ + + + + + + + + + + + /** + * @param {Class | Composable} Target composable class + * @return {TransformChain} class + * @example + * compose(class {}) + * //=> TransformChain + */ + var Transform = function (Target) { + var set = Target.prototype.set; + + /** + * @class TransformChain + * @member TransformChain + * @extends {ChainedMap} + * @memberOf compose + * @category Chainable + * + * @tests TransformChain + * @types TransformChain + * + * @symb 🤖 + * @type {Map} + * + * @see deps/traverse + * @see TraverseChain + * + * {@link https://github.com/iluwatar/java-design-patterns/tree/master/state state-pattern} + * {@link https://github.com/iluwatar/java-design-patterns/tree/master/strategy strategy-pattern} + */ + // return class Transform extends Target { + // ------------------------------------------- + + /** + * @desc traverse `this`, or `this.entries` + * @since 1.0.2 + * + * @param {boolean | traversable} [useThis=false] use the instance properties that are `mapish` as well + * @return {TraverseChain} @chainable + * + * @see TraverseChain + * @see js-traverse + * + * @example + * TAKE FROM TRAVERSECHAIN + */ + Target.prototype.traverse = function traverseChain(useThis) { + if ( useThis === void 0 ) useThis = false; + + /* prettier-ignore */ + return new TraverseChain(this) + .obj(_false(useThis) + ? this.entries(true) + : _true(useThis) + ? this + : useThis + ) + }; + + /** + * @since 1.0.2 + * @memberOf TransformChain + * + * @param {string | Function} key currently just string + * @param {Function} value callback accepting the value as only arg to transform with + * @return {TransformChain} @chainable + * + * @TODO dot-prop here + * + * @example + * + * // coerce values with .id into the value they hold + * chain + * .transform('dis', val => (typeof val === 'string' ? val : val.id)) + * + * chain.set('dis', 'eh') + * chain.get('dis') + * //=> 'eh' + * + * chain.set('dis', {id: 'eh'}) + * chain.get('dis') + * //=> 'eh' + * + * + * @example + * + * import {format} from 'date-fns/esm' + * import {Chain} from 'chain-able' + * + * const chain = new Chain() + * chain.transform('created_at', date => format(date, 'MM/DD/YYYY')) + * chain.set('created_at', new Date()) + * + * // is formatted human-readable pretty! + * const {created_at} = chain.entries() + * //=> '02/11/2014' + * + */ + Target.prototype.transform = function transform(key, value) { + return this.meta(transformers, key, value) + }; + + /** + * @memberOf TransformChain + * + * @override + * @inheritdoc + * @since 1.0.0 + * + * @param {Primitive} key key to set with + * @param {any} val value to set for key + * @param {undefined | string | Array} dotPropKey special key used for initializing dot prop values in an optimized way to keep reference + * @return {Chainable} @chainable + * + * @see this.observe, this.transform + */ + Target.prototype.set = function transformSet(key, val, dotPropKey) { + var this$1 = this; + + var value = val; + + // get + var transformers$$2 = this.meta(transformers, key); + for (var t = 0; t < transformers$$2.length; t++) { + value = transformers$$2[t].call(this$1, value, this$1); + } + + // super.set(key, value) + set.call(this, key, value); + + // get + var observers$$2 = this.meta(observers); + + // skip the below if we have no observers + if (!observers$$2.length) { + return this + } + + var data = {key: dotPropKey, value: value}; + if (_undefined(dotPropKey)) { + data.key = obj(value) ? paths(key, value) : key; + } + + for (var o = 0; o < observers$$2.length; o++) { + observers$$2[o](data); + } + + return this + }; + + // @TODO + // // https://stackoverflow.com/questions/31158902/is-it-possible-to-sort-a-es6-map-object + // ordered(comperator = null) { + // // this.set = this.before(this.set) + // this.set = (key, value) => { + // // have to iterate over the keys before setting + // // and then after merging in values, update + // if (this.store.has(key)) { + // // first + // let keys = this.store.keys() + // if (isFunction(comperator)) keys = keys.sort(comperator) + // + // // after + // const store = this.store + // this.store = new Map() + // keys.forEach(keyInOrder => this.store.set(key, store.get(key))) + // store.clear() + // } + // } + // } + + // --- remap --- + /** + * @desc remap properties from 1 to another, for example, apis with inconsistent naming + * @memberOf TransformChain + * @since 1.0.0 + * @symb 🗺 + * + * @param {string | Object} from property name string, or {[from]: to} + * @param {string} [to=undefined] property name to change key to + * @return {Chain} @chainable + * + * @see TransformChain.transform + * @IDEA could also be a function, but then might as well use .transform + * + * @example + * + * chain + * .remap('dis', 'dat') + * .from({dis: true}) + * + * chain.entries() + * //=> {dat: true} + * + * @example + * + * chain + * .remap({dis: 'dat'}) + * .from({dis: 1, other: true}} + * + * chain.entries() + * //=> {dist: 1, other: true} + * + */ + Target.prototype.remap = function chainRemap(from, to) { + var this$1 = this; + + var remap = from; + if (!obj(from)) { remap = {[from]: to}; } + + /* prettier-ignore */ + keys(remap).forEach(function (key) { return this$1.transform(key, function (val) { + this$1.set(remap[key], val); + return val + }); }); + + return this + }; + + return Target + }; + + /* ___filename___: dist/deps/is/dot.js */ + + + + var dot$1 = function isDot(x) { + return array(x) || (string(x) && x.includes('.')) + }; + + /* ___filename___: dist/deps/is/dot.js */ + + /* ___filename___: dist/compose/DotProp.js */ + /** + * @since 2.0.0 + */ + + + + /** + * @desc checks if this.meta.dot != false & isDot(key) - scoped + * + * @private + * @since 3.0.1 + * + * @param {string} key key in .get/.has/.delete/set + * @param {DotProp} thisArg Chain + * @return {boolean} shouldDot + * + * @see DotProp.dot + * @see deps/is/dot + * @see deps/meta + * @see https://lodash.com/docs/#get + * @see https://github.com/sindresorhus/dot-prop + * + * @example + * + * const chain = new DotProp() + * shouldDot('me.me', chain) + * //=> true + * + * const chain = new DotProp() + * shouldDot('me', chain) + * //=> false + * + * const chain = new DotProp() + * chain.dot(false) + * shouldDot('me.me', chain) + * //=> false + * + */ + var shouldDot = function (key, thisArg) { return thisArg.meta.dot !== false && dot$1(key); }; + + /** + * @class DotProp + * @member Observe + * @extends {ChainedMap} + * @memberOf compose + * @category Chainable + * + * @param {Class | Composable} Target composable class + * @return {DotProp} class + * + * @tests DotProp + * @types DotProp + * + * @see deps/dot + * + * @example + * + * const {compose} = require('chain-able') + * const {DotProp} = compose + * new DotProp() + * //=> DotProp + * + * @example + * + * const chain = new Chain() + * + * chain.set('moose.simple', 1) + * //=> Chain + * + * chain.get('moose.simple') + * //=>1 + * + * chain.get('moose') + * //=> {simple: 1} + * + * chain.set('moose.canada.eh', true).set('moose.canada.igloo', true) + * //=> Chain + * + * //set, has, get, delete :-) + * chain.delete('moose.canada.eh') + * //=> Chain + * + * //also works with an array (moose.canada.igloo) + * chain.get(['moose', 'canada', 'igloo']) + * //=> true + * + */ + var DotProp = function (Target) { + // is this any better? + var entries = Target.prototype.entries; + var set = Target.prototype.set; + var has = Target.prototype.has; + var get = Target.prototype.get; + var del = Target.prototype.delete; + + /** + * @method dot + * @methodTarget DotProp + * @since 3.0.1 + * + * @param {boolean} [useDot=undefined] use dot prop or not + * @return {DotProp} @chainable + * + * @see deps/meta + * + * @example + * + * const chain = new Target() + * chain.dot(false) + * chain.set('moose.simple', 1) + * + * toArr(chain.store.keys()) + * //=> ['moose.simple'] + * + */ + Target.prototype.dot = function enableDisableDot(useDot) { + this.meta.dot = useDot; + return this + }; + + /** + * @desc since we have a map, + * we need to ensure the first property is available + * otherwise we have an empty map.entries obj + * which does nothing by reference + * @since 3.0.1 + * @memberOf DotProp + * + * @override + * @inheritdoc + * + * @see TargetedMap.set + * @see .dot + * + * @example + * const chain = new Target() + * + * chain.set('moose.simple', 1) + * //=> Target store:Map: { moose: { simple: 1 } } + */ + Target.prototype.set = function dotSet(key, val) { + if (shouldDot(key, this)) { + // first accessor + // @example: `canada` in `canada.eh` + var prop = key.split('.').shift(); + + // we already know it is .dot, call super instead + // if (!super.has(prop)) super.set(prop, {}) + + // spread + var data = entries.call(this); + + // set on the spread data + index$20.set(data, key, val); + + // is already by ref, but be extra safe, + observables + return set.call(this, prop, data[prop], key) + } + return set.call(this, key, val) + }; + + /** + * @desc dot-prop enabled get + * @method get + * @memberOf DotProp + * + * @since 3.0.1 + * @override + * @inheritdoc + * + * @param {Primitive} key dot prop key, or any primitive key + * @param {any} [fallback=undefined] fallback value, if it cannot find value with key path + * @return {any} value for path, or fallback value if provided + * + * @see ChainedMap.get + * @see deps/dot + * @see deps/is/dot + * + * @TODO dot-prop on non-store instance.property when using nested chains... + * + * @example + * + * chain.set('moose.simple', 1) + * //=> Chain + * + * chain.get('moose.simple') + * //=>1 + * + * chain.get('moose') + * //=> {simple: 1} + * + * @example + * + * //also works with an array (moose.simple) + * chain.get(['moose', 'simple']) + * //=> 1 + * + */ + Target.prototype.get = function dotGet(key, fallback) { + return shouldDot(key, this) + ? index$20.get(entries.call(this), key, fallback) + : get.call(this, key) + }; + + /** + * @method has + * @methodOf DotProp + * @since 3.0.1 + * @override + * @inheritdoc + * + * @see deps/dot + * @see deps/is/dot + * + * @example + * + * chain.set('one.two', 3) + * chain.has('one.two') + * //=> true + * + */ + Target.prototype.has = function dotHas(key) { + return shouldDot(key, this) + ? index$20.has(entries.call(this), key) + : has.call(this, key) + }; + + /** + * @method delete + * @methodOf DotProp + * @since 3.0.1 + * + * @override + * @inheritdoc + * @see deps/dot + * @see deps/is/dot + * + * @example + * + * chain.set('moose.canada.eh', true) + * chain.set('moose.canada.igloo', true) + * //=> Chain + * + * chain.delete('moose.canada.eh') + * //=> Chain + * + * chain.has('moose.canada.eh') + * //=> true + * + * //still has moose.canada.igloo + * chain.has('moose.canada') + * //=> true + * + */ + Target.prototype.delete = function dotDelete(key) { + return shouldDot(key, this) + ? index$20.delete(entries.call(this), key) + : del.call(this, key) + }; + + return Target + }; + + /* ___filename___: dist/compose/Observe.js */ + + /* ___filename___: dist/compose/Shorthands.js */ + + /* ___filename___: dist/compose/Transform.js */ + + /* ___filename___: dist/compose/DotProp.js */ + + /* ___filename___: dist/compose/compose.js */ + + + + + + + + + var ComposableExtensions = [Observe, Shorthands, Transform, DotProp]; + + /** + * @desc compose chains all the way up from Chainable + * @since 3.0.0 + * + * @param {Class | Function | undefined} [target=ChainedMap] class or function to extend + * @param {Array | undefined} [extensions=[Observe, Shorthands, Transform, DotProp]] Array of extensions to compose together left to right + * @return {Class | Function} composed + * + * @tutorial examples/playground/compose + * @tutorial examples/babel/decorators + * + * @name compose + * @func compose + * @member compose + * @tests compose + * @types compose + * @symb 🎼 + * + * @see https://formidable.com/blog/2017/infinite-state-composition-with-freactal/ + * @see https://blog.javascripting.com/2016/02/02/encapsulation-in-redux/ + * @see https://www.barbarianmeetscoding.com/blog/2016/01/04/safer-javascript-object-composition-with-traits-and-traits-dot-js/ + * @see https://medium.com/javascript-scene/why-learn-functional-programming-in-javascript-composing-software-ea13afc7a257 + * @see https://hackernoon.com/javascript-functional-composition-for-every-day-use-22421ef65a10 + * @see https://github.com/stoeffel/awesome-fp-js + * + * @example + * + * class Eh extends compose() {} + * new Eh() instanceof Chainable + * //=> true + * + * @example + * + * class Target {} + * class Eh extends compose(Target) {} + * new Eh() instanceof Target + * //=> true + * + * @example + * + * class Target {} + * const mixin = SuperClass => class extends SuperClass {} + * class Eh extends compose(Target, ) {} + * new Eh() instanceof Chainable + * //=> true + * + * @example + * + * class Winning {} + * class Yes extends compose(Winning) { + * get winning() { + * return true + * } + * } + * const yes = new Yes() + * yes instanceof Winning && yes.winning + * //=> true + * + */ + function compose(target, extensions) { + var extend = _undefined(extensions) ? ComposableExtensions : extensions; + var composed = target; + + if (target && target instanceof Object) { + composed = ChainedMap.compose(Chainable.compose(target)); + } + else { + composed = ChainedMap; + } + + for (var index = 0; index < extend.length; index++) { + composed = extend[index](composed) || composed || ChainedMap; + } + + return composed + } + + compose.Observe = Observe; + compose.Shorthands = Shorthands; + compose.Transform = Transform; + compose.DotProp = DotProp; + + var compose_1 = compose; + + /* ___filename___: dist/compose/compose.js */ + + var index$16 = compose_1; + + /* ___filename___: dist/deps/fp/mapWhere.js */ + + + + + /** + * Creates an array of values by running each property of `object` thru + * `iteratee`. The iteratee is invoked with three arguments: (value, key, object). + * + * @memberOf fp + * @since 5.0.0 + * @category Object + * + * @param {Object} obj The object to iterate over. + * @param {Function} predicate The function invoked per iteration. + * @return {Array} Returns the new mapped array. + * + * @see https://github.com/lodash/lodash/blob/master/map.js + * + * @example + * + * const square = n => n * n + * map({ 'a': 4, 'b': 8 }, square) + * // => [16, 64] (iteration order is not guaranteed) + * + */ + function mapWhere(obj, predicate) { + var output = {}; + var isArrayObj = array(obj); + var keys = keysObjOrArray(obj); + + for (var index = 0; index < keys.length; index++) { + var key = isArrayObj ? index : keys[index]; + var value = obj[key]; + + if (predicate(value, key, obj)) { + output[key] = value; + } + } + + return output + } + + var mapWhere_1 = curry(2, mapWhere); + + /* ___filename___: dist/deps/reduce/toObj.js */ + var toObj = function reduceObj(array, iterator) { + return array.reduce(function(reduced, next) { + iterator(reduced, next); + return reduced + }, {}) + }; + + /* ___filename___: dist/deps/fp/mapWhere.js */ + + /* ___filename___: dist/deps/reduce/toObj.js */ + + /* ___filename___: dist/deps/reduce/clean.js */ + + + + + + + // const [isNotReal, isNotEmpty] = [isReal, isEmpty].map(not) + // const isNotEmptyOrNotReal = or(isNotReal, isNotEmpty) + var mapNotEmpty = mapWhere_1('_', function (x) { return real(x) && !empty(x); }); + + /** + * @desc goes through the maps, + * and the map values, + * reduces them to array + * then to an object using the reduced values + * + * @memberOf reduce + * @since 4.0.0 <- moved as a dep function + * @since 0.4.0 + * + * @param {Object} obj object to clean, usually .entries() + * @return {Object} reduced object, without `notReal` values + * + * @TODO seems to be overkill with reducing mapping just copy & ignore or delete? + * + * @see reduce + * @see isObjWithKeys + * @see isNotEmptyArray + * @see isReal + * @see http://underscorejs.org/#reduce + * + * @example + * + * const map = new ChainedMap() + * + * map + * .set('emptyArr', []) + * .set('arr', [1]) + * .set('nill', null) + * .set('emptyObj', {}) + * .set('obj', {keys: true}) + * + * clean(map.entries()) + * //=> {arr: [1], obj: {keys: true}} + * + */ + var clean = function clean(obj) { + var mapped = mapNotEmpty(obj); + var keys$$2 = keys(mapped); + var iterator = function (reduced, key) { return (reduced[key] = mapped[key]); }; + + return toObj(keys$$2, iterator) + }; + + /* ___filename___: dist/deps/traversers/eq.js */ + var eq$2 = traverse_1.eq; + + var index$22 = validatorBuilder; + + /* ___filename___: dist/ChainedSet.js */ + + /* ___filename___: dist/FactoryChain.js */ + + /* ___filename___: dist/deps/reduce/clean.js */ + + /* ___filename___: dist/deps/traversers/eq.js */ + + var index = createCommonjsModule(function (module) { + // dep + + // core + + + + // merge + + + + // easy + + + // composer + + + // export + var exp = index$16(); + exp.chainable = function (parent) { return new exp(parent); }; + exp.builder = function (obj) { return new MethodChain_1(obj); }; + exp.Chain = exp; + exp.compose = index$16; + + // deps + exp.traverse = traverse_1; + exp.addMethodFactories = MethodChain_1.add; + + exp.toArr = toArr; // exp.toarr = + exp.camelCase = camelCase; + exp.dot = index$20; + exp.matcher = index$18; + exp.reduce = index$6; + exp.clean = clean; + exp.meta = index$8; + exp.eq = eq$2; + exp.types = index$22; + exp.encase = index$14; + + exp.addTypes = exp.types.addTypes; + + // core + exp.Chainable = Chainable; + exp.ChainedSet = ChainedSet_1; + exp.ChainedMap = ChainedMap; + exp.FactoryChain = FactoryChain_1; + exp.MethodChain = MethodChain_1; + + // merge + exp.MergeChain = MergeChain_1; + exp.merge = index$2; + + exp.is = index$12; + + assign(exp, exp.is); + + // @NOTE: no need for exporting as an __esModule, + // it adds additional checking wrapper + module.exports = exp; + + + }); + + var index$1 = unwrapExports(index); + + return index$1; + +}))); +//# sourceMappingURL=index.js.map diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index d494751..c30d1b4 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -1,3 +1,174 @@ +# v5.0.0-beta.1-5 + +https://lh3.googleusercontent.com/-G9TxkDCz4No/WBnw5HgDhaI/AAAAAAAANTE/grSmWeThmJYJkbMs0QunPnj9GtRK5-hQwCJoC/w1060-h798-p-rw/map-filter-reduce-in-emoji-1.png + +### 5 +- 🔩 /native/ folder + - 🕴 for exporting native/built-in prototype methods and such + +- 🆙 conditional/ + - ℹ️ more docs to `all` & `and` & `not` & `some` + - 🐏 curry `not` + - /includes + - 🐏 curry + - ❔ use isString > isArray as first check + +- ⚖️ `eq` 🛁 minor clean + ℹ️🔗 doclinks 👕 lint tweaks +- 🆕 add expressions/ +- 🚚 move ignored to meta/ +- 🚚🔬 move dopemerge map & set example into skipped test +- 🚚 move concat to /array + +- 🐏 🎁 add fp/ + - 🐏 🎁 fp: ⬅️ reverse 👷 construct 📞 invoke ℹ️️ docs + - ℹ️️ more docs to arity, always, curry, replace, prop + - 🛅 shorten firstIndex, lastIndex + - ⬅️🆕 reverse + - 👷🆕 construct (used in index when exporting .build & .init/.chainable) + - ❔🆕 includesCount (RESEARCH BETTER NAME) (occurs?) + - ❔🆕 hasInMatching + - 📞🆕 invoke + - 🕴 export more in the index + - 🤸`|` pipe split into pipeTwo + pipe (for dynamic length args & 2 args) + +- 🐏 🎁 fp/ ...again + - ℹ️ more docs 👷 construct/ 🆕🙃 flip 🆕 invoker + - ℹ️️ more docs to first, firstIndex, includesCount, last, lastIndex, reverse + - 🔬 more adapted tests + - 🆕 invoker + - 🆕🙃 flip + - 🙃🙃 flip2 (just first2 args) +- 👷 construct/ + - map, set, regexp + +- ❔ is/ + - ❔ is/ ℹ️ℹ️ℹ️️ docs 🆕🆕🆕 🔬🔩 + - ℹ️️ docs: arguments, array, boolean, buffer, hasIn, objNotNull, prototypeOf, string, undefined, arrayOf, asyncish, async, dot, enumerable, function, generator, json, toS/getTag + - ⚒ fix ℹ️ docs ⌨️ typo in primitive + - 🔬 tests for 🆕 + - ❔🆕 isMatch + - ❔🆕 isInstanceOf + - ❔🆕 isUndefinedLike + - ❔🆕 isWeakMap + - ❔🆕 isWeakSet + - ❔🆕 isIteratable (moved from traverse) + - ❔🆕 isCircular + - ❔🆕 isBooleanPrimitive (split from isBoolean) + - ❔🆕 isMatch (not exported boolean version of matcher) + - ❔🆕 isBrowser (using util/localGlobal & isUndefinedLike) + - 🔩 use native/ in isNative + - 🆙 use `or` in isAsyncish + +- 🆕 add expressions/ +- to/ + - array + - string + - boolean + - number + - object + - integer + - map + - set + - setToArray + - coerce + +- 🖇 util/ + - 🆙 utils/ 🕴 exports + - 🆕🌏 localGlobal (window || global) + - 🔢 lengthFromZero + - ℹ️️ docs + - 😡 use lengthFromZero in `argumentor` + - ⛑ hasOwnProperty add `isNill` safety + - assign - added commented out polyfil when needed for future reference +- build/ + - remap all to export + + +- 🔎🌎 WEBSITE! + - https://github.com/js-org/dns.js.org/pull/1364#issuecomment-316629304 + - https://chain-able.js.org + +- ❗ BREAKING: + - rename is objLoose & objPure & objStrict -> into understandable names that convey what they do + +- 🤖📖 docgen + - 🛅 built dev version for links from docgen site until upgraded + - 📜📒 makefile scripts to make docgen & site + - make website + - docgen metadata for fuzzy search content + - fix doc html links + - ℹ️️ℹ️️ℹ️️ a ton of docblocks in src for outputting better docs +- 📘⛓ examples: + - 📘⛓ example: SwitchChain + - 📘⛓ example: RegExp chain + - 📘⛓ example: ObjectDefineChain + - ⚪️ Frisbee 🆙 with updates +- misc + - ternary in transform.remap + - 🌊〰️ update typings +- 🖇 utils + - ❔🆕 isEmpty + - ❔🆕 isJSON + - ❔🆕 isArguments + - ❔🆕 isBuffer + - ❔🆕 move reusable `is` functions from validator builder into files + - ❔🆕 isNotNested + - ❔🆕 isPrimitive + - ❔🆕 isIn + - ❔🆕 isArrayOf + - ❔ isStringOrNumber 🆓 use `conditional/or` + - 🤸 split isNumber + - + isNumberPrimitive + - 🗝️ keys for objOrArray + - 🆓 use some curry in izzez + - 🆓 reduce: use 🆓 fp on 🛁 clean + - 🆓 conditionals utils wrap with curry + ℹ️️ + - 🐫 add camelCase 🔬 tests + 🚚 move to string/ folder + +- 🆓🎁 FP + - start them, update,️dℹ️️ docblock, 🔬 test, (ramda lodash thanks for some parts of some) + - prop + - pipe + - path, + - map, + - curry + - first + - firstIndex + - last + - lastIndex + - arity + - replace + - mapWhere + - always + - remove + - arity + +- 👣 Traverse + - 🏰 ground up refactor for deopt + - 🎱 add InstancePooler with tests + - add reset, adjust delete (needs a better .remove for array .splice) + - 🤸🛁 split & clean + - ℹ️️ re-document + - 👾 variable name clarity + - 📝 todos + - 🤸🎯 split dopemerge emptyTarget to a reusable file + - refactor equals + - 👾 simplify `isArrayOrObj && isObjWithKeys` -> isEmpty + - rename .iteratee to .node, + +- 🛡 encase + - 🆓 wrap encase: tryCatch & withSpec with curry + - ℹ️️ docblocks for dot-prop + - 🆓 use fp/replace on escape + +- 🏗 build & 📇 metadata + - lego-cli for later + - 📇 metadata for docgen + - 📇 metadata yarn lock pkg json stuff + - 🏗🔌 comment plugin to add filenames to output + - 🏸 cdn server hosting in installations in readme for site + - ⚒ minor eq path require fix + # 🏷 v4.1.0 - 🏰 refactoring to add prototype methods, instead of many multi-inherit - 📜📒 Makefile @@ -148,7 +319,7 @@ - removed .extendsGetSet, .defineGetSet, .extendIncrement, .extendWith, .extendAlias, .decorateParent, .typed - replaced ^ with .alias(), .getSet(), .decorate(obj), .define(), .autoIncrement(), .default(), .initial(), .bind(), .encase(), .call(), .get(), .set(), .returns(), .camelCase(), .factory(for extending), .build with + support - removed compose/Extend, compose/Child, compose/immutable, compose/Extend, compose/Types, compose/Symbols, compose/Debug, compose/define - - .schema feature + - 🎁 .schema feature - optional types, array types, or types - 📐🛂🏭 refactor out schema factory - integrated histories from deepmerge, dot-prop, traverse-js, webpack-chain (all commit hashes change, extremely likely they are not used anywhere, even so there is a branch backup so hardly 100% breaking) diff --git a/docs/docdown/Chainable.md b/docs/docdown/Chainable.md index a68d8c7..4ffd315 100644 --- a/docs/docdown/Chainable.md +++ b/docs/docdown/Chainable.md @@ -5,30 +5,24 @@ ## `Chainable` -* `` +* `` +* `Chainable.` +* `Chainable.[Iterator]` +* `Chainable.[Primitive]` +* `Chainable.clear` +* `Chainable.delete` +* `Chainable.end` +* `Chainable.has` +* `Chainable.length` +* `Chainable.values` +* `Chainable.when` ## `Chainable.constructor` -* `Chainable.constructor` - - - - - -## `Chainable.prototype` -* `Chainable.prototype.` -* `Chainable.prototype.[Iterator]` -* `Chainable.prototype.[Primitive]` -* `Chainable.prototype.clear` -* `Chainable.prototype.delete` -* `Chainable.prototype.end` -* `Chainable.prototype.has` -* `Chainable.prototype.length` -* `Chainable.prototype.values` -* `Chainable.prototype.when` +* `Chainable.constructor` @@ -42,12 +36,15 @@ -

# compose

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/Chainable.js#L445 "View in source") [Ⓣ][1] +

compose

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/Chainable.js#L444 "View in source") [Ⓣ][1] unknown -#### Since + +#### @Since 3.0.0 #### Example @@ -63,56 +60,21 @@ chain instanceof Target - - - - -## `Chainable.constructor` - - - -

# Chainable.constructor(parent=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/Chainable.js#L65 "View in source") [Ⓣ][1] - -Function - -#### Since -0.0.1 - -#### Arguments -1. `parent=undefined` *(Chainable|ParentType|any)*: ParentType - -#### Example -```js -class ChainedMap extends Chainable {} -const map = new ChainedMap() -map.className -//=> ChainedMap - -``` ---- - - - - - - - -## `Chainable.prototype` - 🌊 Types: Chainable.d  🔬 Tests: Chainable  -

# Chainable.prototype.

+

Chainable.

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/Chainable.js#L10 "View in source") [Ⓣ][1] (Chainable): Trait class that can inherit any class passed into compose, extended by ChainedMap & ChainedSet -### @classProps +#### @classProps * {parent} * {className} @@ -125,17 +87,20 @@ map.className 🔬 Tests: iteration  -

# Chainable.prototype.[Iterator]()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/Chainable.js#L117 "View in source") [Ⓣ][1] +

Chainable.[Iterator]()

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/Chainable.js#L122 "View in source") [Ⓣ][1] (generator): Iterator for looping values in the store -### @notes +#### @notes * assigned to a variable so buble ignores it -#### Since + +#### @Since 0.5.0 #### Returns @@ -178,12 +143,15 @@ for (const arr of set) { -

# Chainable.prototype.[Primitive](hint=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/Chainable.js#L382 "View in source") [Ⓣ][1] +

Chainable.[Primitive](hint=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/Chainable.js#L13 "View in source") [Ⓣ][1] + +(Function): symbol method for toString, toJSON, toNumber -Function -#### Since +#### @Since 1.0.2 #### Arguments @@ -215,8 +183,10 @@ chain + '' -

# Chainable.prototype.clear([clearPropertiesThatAreChainLike=true])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/Chainable.js#L236 "View in source") [Ⓣ][1] +

Chainable.clear([clearPropertiesThatAreChainLike=true])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/Chainable.js#L23 "View in source") [Ⓣ][1] (Function): clears the map, goes through this properties, calls .clear if they are instanceof Chainable or Map @@ -243,12 +213,15 @@ chain.entries() -

# Chainable.prototype.delete(key=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/Chainable.js#L275 "View in source") [Ⓣ][1] +

Chainable.delete(key=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/Chainable.js#L283 "View in source") [Ⓣ][1] (Function): calls .delete on this.store.map -#### Since + +#### @Since 0.3.0 #### Arguments @@ -274,12 +247,15 @@ chain.get('eh') -

# Chainable.prototype.end()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/Chainable.js#L162 "View in source") [Ⓣ][1] +

Chainable.end()

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/Chainable.js#L167 "View in source") [Ⓣ][1] (Function): for ending nested chains -#### Since + +#### @Since 0.4.0 #### Returns @@ -299,12 +275,15 @@ child.end() -

# Chainable.prototype.has(keyOrValue=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/Chainable.js#L298 "View in source") [Ⓣ][1] +

Chainable.has(keyOrValue=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/Chainable.js#L10 "View in source") [Ⓣ][1] + +(Function): checks whether the store has a value for a given key -Function -#### Since +#### @Since 0.3.0 #### Arguments @@ -328,12 +307,15 @@ chain.has('canada') -

# Chainable.prototype.length()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/Chainable.js#L416 "View in source") [Ⓣ][1] +

Chainable.length()

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/Chainable.js#L414 "View in source") [Ⓣ][1] Function -#### Since + +#### @Since 0.5.0 #### Returns @@ -349,19 +331,22 @@ for (var i = 0; i < chain.length; i++) -

# Chainable.prototype.values()

+

Chainable.values()

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/Chainable.js#L20 "View in source") [Ⓣ][1] (Function): spreads the entries from ChainedMap.store.values allocates a new array, adds the values from the iterator -### @notes +#### @notes * look at Chainable.constructor to ensure not to use `new Array...` * moved from ChainedMap and ChainedSet to Chainable @2.0.2 * this was [...] & Array.from(this.store.values()) -#### Since + +#### @Since 0.4.0 #### Returns @@ -381,8 +366,10 @@ chain.values() -

# Chainable.prototype.when(condition=undefined, [trueBrancher=Function], [falseBrancher=Function])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/Chainable.js#L188 "View in source") [Ⓣ][1] +

Chainable.when(condition=undefined, [trueBrancher=Function], [falseBrancher=Function])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/Chainable.js#L193 "View in source") [Ⓣ][1] (Function): when the condition is true, trueBrancher is called, else, falseBrancher is called @@ -406,6 +393,40 @@ chains.when(prod, c => c.set('prod', true), c => c.set('prod', false)) + + +## `Chainable.constructor` + + + +

Chainable.constructor(parent=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/Chainable.js#L68 "View in source") [Ⓣ][1] + +Function + + +#### @Since +0.0.1 + +#### Arguments +1. `parent=undefined` *(Chainable|ParentType|any)*: ParentType + +#### Example +```js +class ChainedMap extends Chainable {} +const map = new ChainedMap() +map.className +//=> ChainedMap + +``` +--- + + + + + [1]: #chainable "Jump back to the TOC." diff --git a/docs/docdown/ChainedMap.md b/docs/docdown/ChainedMap.md index 16e67fd..5588b5f 100644 --- a/docs/docdown/ChainedMap.md +++ b/docs/docdown/ChainedMap.md @@ -4,22 +4,22 @@ -## `CM` -* `CM` +## `ChainedMapBase` +* `ChainedMapBase.ComposeChainedMap` ## `merge` -* `merge` +* `merge` ## `method` -* `method` +* `method` @@ -29,7 +29,7 @@ -## `CM` +## `ChainedMapBase` @@ -38,22 +38,25 @@ 🔬 Tests: ChainedMap  -

# CM([SuperClass=ChainedMapBase])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/ChainedMap.js#L31 "View in source") [Ⓣ][1] +

ChainedMapBase.ComposeChainedMap([SuperClass=ChainedMapBase])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/ChainedMap.js#L33 "View in source") [Ⓣ][1] (Function): ChainedMap composer -### @see +#### @see -* fluents/chain able/blob/master/src/deps/dopemerge/dopemerge.js -* fluents/chain able/blob/master/src/merge chain.js +* fluents/chain able/blob/master/src/deps/dopemerge/dopemerge.js +* fluents/chain able/blob/master/src/merge chain.js -### @extends +#### @extends ChainedMapBase -#### Since + +#### @Since 0.0.1 #### Arguments @@ -83,22 +86,25 @@ hehchain instanceof heh -

# merge(obj=undefined, [handleMergeFn=undefined])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/ChainedMap.js#L99 "View in source") [Ⓣ][1] +

merge(obj=undefined, [handleMergeFn=undefined])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/ChainedMap.js#L101 "View in source") [Ⓣ][1] (Function): merges an object with the current store -### @see +#### @see -* fluents/chain able/blob/master/src/deps/dopemerge/dopemerge.js -* fluents/chain able/blob/master/src/merge chain.js +* fluents/chain able/blob/master/src/deps/dopemerge/dopemerge.js +* fluents/chain able/blob/master/src/merge chain.js -### @todos +#### @todos - [ ] needs to pass in additional opts somehow... -#### Since + +#### @Since 0.4.0 #### Arguments @@ -139,17 +145,20 @@ const chain = new Chain() -

# method(names=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/ChainedMap.js#L63 "View in source") [Ⓣ][1] +

method(names=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/ChainedMap.js#L65 "View in source") [Ⓣ][1] (Function): the way to easily start building methods when using chainable instances -### @see +#### @see + +* fluents/chain able/blob/master/src/deps/dopemerge/dopemerge.js +* fluents/chain able/blob/master/src/merge chain.js -* fluents/chain able/blob/master/src/deps/dopemerge/dopemerge.js -* fluents/chain able/blob/master/src/merge chain.js -#### Since +#### @Since 4.0.0 #### Arguments @@ -175,4 +184,4 @@ chain.get('eh') - [1]: #cm "Jump back to the TOC." + [1]: #chainedmapbase "Jump back to the TOC." diff --git a/docs/docdown/ChainedMapBase.md b/docs/docdown/ChainedMapBase.md index 63d6e8e..182f935 100644 --- a/docs/docdown/ChainedMapBase.md +++ b/docs/docdown/ChainedMapBase.md @@ -4,15 +4,15 @@ -## `ChainedMapBase.prototype` -* `ChainedMapBase.prototype.CMC` -* `ChainedMapBase.prototype.compose` -* `ChainedMapBase.prototype.entries` -* `ChainedMapBase.prototype.extend` -* `ChainedMapBase.prototype.from` -* `ChainedMapBase.prototype.get` -* `ChainedMapBase.prototype.set` -* `ChainedMapBase.prototype.tap` +## `ChainedMapBase` +* `ChainedMapBase.ComposeChainedMapBase` +* `ChainedMapBase.compose` +* `ChainedMapBase.entries` +* `ChainedMapBase.extend` +* `ChainedMapBase.from` +* `ChainedMapBase.get` +* `ChainedMapBase.set` +* `ChainedMapBase.tap` @@ -22,7 +22,7 @@ -## `ChainedMapBase.prototype` +## `ChainedMapBase` @@ -30,25 +30,29 @@ 🔬 Tests: ChainedMap  -

# ChainedMapBase.prototype.CMC

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/ChainedMapBase.js#L18 "View in source") [Ⓣ][1] +

ChainedMapBase.ComposeChainedMapBase

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/ChainedMapBase.js#L23 "View in source") [Ⓣ][1] (Chainable): this is to avoid circular requires because MergeChain & MethodChain extend this yet .method & .merge use those chains +...also, it serves as a non-references creator for extending new instances of Chainable, where it splits into *(Map | Set)* -> composed prototype decorators -### @classProps +#### @classProps * {meta} meta fn * {store} main store -### @extends +#### @extends Chainable -#### Since + +#### @Since 4.0.0-alpha.1 --- @@ -57,13 +61,15 @@ Chainable -

# ChainedMapBase.prototype.cmc([SuperClass=Chainable])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/ChainedMapBase.js#L291 "View in source") [Ⓣ][1] +

ChainedMapBase.cmc([Target=Chainable])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/ChainedMapBase.js#L296 "View in source") [Ⓣ][1] (Composer): ChainedMapBase composer #### Arguments -1. `[SuperClass=Chainable]` *(Class|Composable|Object)*: class to extend +1. `[Target=Chainable]` *(Class|Composable|Object)*: class to extend #### Returns *(Class)*: ChainedMapBase @@ -83,12 +89,15 @@ hehchain instanceof heh -

# ChainedMapBase.prototype.entries([chains=false])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/ChainedMapBase.js#L23 "View in source") [Ⓣ][1] +

ChainedMapBase.entries([chains=false])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/ChainedMapBase.js#L17 "View in source") [Ⓣ][1] (Function): spreads the entries from ChainedMapBase.store *(Map)* return store.entries, plus all chain properties if they exist -#### Since + +#### @Since 0.4.0 #### Arguments @@ -112,12 +121,15 @@ map.set('a', 'alpha').set('b', 'beta').entries() -

# ChainedMapBase.prototype.extend(methods=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/ChainedMapBase.js#L170 "View in source") [Ⓣ][1] +

ChainedMapBase.extend(methods=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/ChainedMapBase.js#L175 "View in source") [Ⓣ][1] (Function): shorthand methods, from strings to functions that call .set -#### Since + +#### @Since 0.4.0 #### Arguments @@ -144,17 +156,20 @@ eq(chain2.eh, chain1.eh) -

# ChainedMapBase.prototype.from(obj=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/ChainedMapBase.js#L128 "View in source") [Ⓣ][1] +

ChainedMapBase.from(obj=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/ChainedMapBase.js#L133 "View in source") [Ⓣ][1] (Function): checks each property of the object calls the chains accordingly -### @todos +#### @todos - [ ] could also add parsing stringified -#### Since + +#### @Since 0.5.0 #### Arguments @@ -177,12 +192,15 @@ eq(from, eh) -

# ChainedMapBase.prototype.get(key=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/ChainedMapBase.js#L22 "View in source") [Ⓣ][1] +

ChainedMapBase.get(key=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/ChainedMapBase.js#L16 "View in source") [Ⓣ][1] (Function): get value for key path in the Map store ❗ `debug` is a special key and is *not* included into .store it goes onto .meta -#### Since + +#### @Since 0.4.0 #### Arguments @@ -208,12 +226,15 @@ chain.get('nope') -

# ChainedMapBase.prototype.set(key=undefined, value=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/ChainedMapBase.js#L18 "View in source") [Ⓣ][1] +

ChainedMapBase.set(key=undefined, value=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/ChainedMapBase.js#L15 "View in source") [Ⓣ][1] (Function): sets the value using the key on store adds or updates an element with a specified key and value -#### Since + +#### @Since 0.4.0 #### Arguments @@ -237,12 +258,15 @@ chain.get('eh') -

# ChainedMapBase.prototype.tap(name=undefined, fn=undefined)

+

ChainedMapBase.tap(name=undefined, fn=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/ChainedMapBase.js#L32 "View in source") [Ⓣ][1] (Function): tap a value with a function -#### Since + +#### @Since 4.0.0-alpha.1 <- moved from transform & shorthands #### Arguments @@ -285,4 +309,4 @@ const entries = new Chain() - [1]: #chainedmapbase.prototype "Jump back to the TOC." + [1]: #chainedmapbase "Jump back to the TOC." diff --git a/docs/docdown/ChainedSet.md b/docs/docdown/ChainedSet.md index fae56e5..177bf81 100644 --- a/docs/docdown/ChainedSet.md +++ b/docs/docdown/ChainedSet.md @@ -5,28 +5,10 @@ ## `ChainedSet` -* `` - - - - - -## `add` -* `add` - - - - - -## `merge` -* `merge` - - - - - -## `prepend` -* `prepend` +* `ChainedSet.` +* `ChainedSet.add` +* `ChainedSet.merge` +* `ChainedSet.prepend` @@ -44,28 +26,30 @@ 🔬 Tests: ChainedSet  -

# 

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/ChainedSet.js#L23 "View in source") [Ⓣ][1] +

ChainedSet.

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/ChainedSet.js#L25 "View in source") [Ⓣ][1] Set -### @notes +#### @notes * had Symbol.isConcatSpreadable but it was not useful -### @todos +#### @todos - [ ] could add .first .last ? -### @classProps +#### @classProps * {store} -### @extends +#### @extends Chainable @@ -73,20 +57,17 @@ Chainable - - -## `add` - - - -

# add(value=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/ChainedSet.js#L55 "View in source") [Ⓣ][1] +

ChainedSet.add(value=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/ChainedSet.js#L16 "View in source") [Ⓣ][1] (Function): appends a new element with a specified value to the end of the .store -#### Since + +#### @Since 0.4.0 #### Arguments @@ -108,20 +89,17 @@ for (let name of people) console.log(name) - - - - -## `merge` - -

# merge(arr=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/ChainedSet.js#L100 "View in source") [Ⓣ][1] +

ChainedSet.merge(arr=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/ChainedSet.js#L114 "View in source") [Ⓣ][1] (Function): merge any Array/Set/Iteratable/Concatables into the array, at the end -#### Since + +#### @Since 0.4.0 #### Arguments @@ -143,20 +121,17 @@ for (let name of people) console.log(name) - - -## `prepend` - - - -

# prepend(value=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/ChainedSet.js#L76 "View in source") [Ⓣ][1] +

ChainedSet.prepend(value=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/ChainedSet.js#L88 "View in source") [Ⓣ][1] (Function): inserts the value at the **beginning** of the Set -#### Since + +#### @Since 0.4.0 #### Arguments diff --git a/docs/docdown/FactoryChain.md b/docs/docdown/FactoryChain.md index 8ed54a1..a1e60a2 100644 --- a/docs/docdown/FactoryChain.md +++ b/docs/docdown/FactoryChain.md @@ -4,13 +4,13 @@ -## `FactoryChain.prototype` -* `FactoryChain.prototype.` -* `FactoryChain.prototype.chainUpDowns` -* `FactoryChain.prototype.factory` -* `FactoryChain.prototype.getData` -* `FactoryChain.prototype.prop` -* `FactoryChain.prototype.props` +## `FactoryChain` +* `FactoryChain.` +* `FactoryChain.chainUpDowns` +* `FactoryChain.factory` +* `FactoryChain.getData` +* `FactoryChain.prop` +* `FactoryChain.props` @@ -20,7 +20,7 @@ -## `FactoryChain.prototype` +## `FactoryChain` @@ -28,19 +28,21 @@ 🔬 Tests: FactoryChain  -

# FactoryChain.prototype.

+

FactoryChain.

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/FactoryChain.js#L7 "View in source") [Ⓣ][1] Map -### @classProps +#### @classProps * {data} * {_calls} -### @extends +#### @extends ChainedMapBase @@ -50,17 +52,20 @@ ChainedMapBase -

# FactoryChain.prototype.chainUpDowns(methods=undefined)

+

FactoryChain.chainUpDowns(methods=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/FactoryChain.js#L80 "View in source") [Ⓣ][1] (Function): chain back up to parent for any of these -### @todos +#### @todos - [ ] should have a debug log for this -#### Since + +#### @Since 2.0.0 #### Arguments @@ -109,12 +114,15 @@ const returned = things -

# FactoryChain.prototype.factory([obj={}])

+

FactoryChain.factory([obj={}])

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/FactoryChain.js#L223 "View in source") [Ⓣ][1] (Function): creates/add the `.end` method, which checks how many methods have been called, and decides whether to return parent or not -#### Since + +#### @Since 2.0.0 #### Arguments @@ -129,12 +137,15 @@ const returned = things -

# FactoryChain.prototype.getData([prop=undefined])

+

FactoryChain.getData([prop=undefined])

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/FactoryChain.js#L204 "View in source") [Ⓣ][1] (Function): access data being built when stepping through a factory -#### Since + +#### @Since 2.0.0 #### Arguments @@ -164,12 +175,15 @@ expect(age).toBe(10) -

# FactoryChain.prototype.prop(name=undefined, [onCall=undefined])

+

FactoryChain.prop(name=undefined, [onCall=undefined])

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/FactoryChain.js#L146 "View in source") [Ⓣ][1] (Function): add property that are counted towards the call count for easy auto-ending chaining -#### Since + +#### @Since 2.0.0 #### Arguments @@ -195,12 +209,15 @@ person -

# FactoryChain.prototype.props(names=undefined)

+

FactoryChain.props(names=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/FactoryChain.js#L120 "View in source") [Ⓣ][1] (Function): adds an *array* of properties, using FactoryChain.prop -#### Since + +#### @Since 2.0.0 #### Arguments @@ -236,4 +253,4 @@ person.name().age().email() - [1]: #factorychain.prototype "Jump back to the TOC." + [1]: #factorychain "Jump back to the TOC." diff --git a/docs/docdown/MergeChain.md b/docs/docdown/MergeChain.md index 0e7f2f8..ee87580 100644 --- a/docs/docdown/MergeChain.md +++ b/docs/docdown/MergeChain.md @@ -5,30 +5,24 @@ ## `MergeChain` -* `` - - - - - -## `MergeChain.prototype` -* `MergeChain.prototype.` -* `MergeChain.prototype.merger` -* `MergeChain.prototype.onExisting` +* `` +* `MergeChain.` +* `MergeChain.merger` +* `MergeChain.onExisting` ## `merge` -* `merge` +* `merge` ## `setChosen` -* `setChosen` +* `setChosen` @@ -42,7 +36,9 @@ -

# (parent=undefined)

+

(parent=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/MergeChain.js#L54 "View in source") [Ⓣ][1] Function @@ -68,34 +64,31 @@ console.dir(map) - - - - -## `MergeChain.prototype` - 🔬 Tests: MergeChain  -

# MergeChain.prototype.

+

MergeChain.

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/MergeChain.js#L9 "View in source") [Ⓣ][1] Map -### @todos +#### @todos - [ ] consider just making this a function, because 80/20 onValue merger & onExisting are rarely used & are easily overridable with .merge -### @extends +#### @extends ChainedMapBase -#### Since + +#### @Since 1.0.0 --- @@ -104,12 +97,15 @@ ChainedMapBase -

# MergeChain.prototype.merger(opts=undefined)

+

MergeChain.merger(opts=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/MergeChain.js#L93 "View in source") [Ⓣ][1] (Function): options for merging with dopemerge -#### Since + +#### @Since 1.0.2 #### Arguments @@ -138,12 +134,15 @@ ChainedMapBase -

# MergeChain.prototype.exports

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/MergeChain.js#L334 "View in source") [Ⓣ][1] +

MergeChain.exports

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/MergeChain.js#L335 "View in source") [Ⓣ][1] unknown -#### Since + +#### @Since 0.9.0 #### Example @@ -170,18 +169,21 @@ chain.get('str') -

# merge([obj2=undefined])

+

merge([obj2=undefined])

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/MergeChain.js#L122 "View in source") [Ⓣ][1] (Function): merges object in, goes through all keys, checks cbs, dopemerges -### @todos +#### @todos - [ ] issue here if we extend without shorthands & we want to merge existing values... :s -#### Since + +#### @Since 1.0.0 #### Arguments @@ -211,12 +213,15 @@ chain.entries() -

# setChosen(keyToSet=undefined, valueToSet=undefined)

+

setChosen(keyToSet=undefined, valueToSet=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/MergeChain.js#L199 "View in source") [Ⓣ][1] (Function): when fn is a full method, not an extended shorthand -#### Since + +#### @Since 0.5.0 #### Arguments diff --git a/docs/docdown/MethodChain.md b/docs/docdown/MethodChain.md index 8922ce9..e5c8c66 100644 --- a/docs/docdown/MethodChain.md +++ b/docs/docdown/MethodChain.md @@ -5,49 +5,43 @@ ## `MethodChain` -* `` - - - - - -## `MethodChain.prototype` -* `MethodChain.prototype.` -* `MethodChain.prototype._build` -* `MethodChain.prototype._defaults` -* `MethodChain.prototype.autoIncrement` -* `MethodChain.prototype.build` -* `MethodChain.prototype.decorate` -* `MethodChain.prototype.name` -* `MethodChain.prototype.schema` +* `` +* `MethodChain.` +* `MethodChain._build` +* `MethodChain._defaults` +* `MethodChain.autoIncrement` +* `MethodChain.build` +* `MethodChain.decorate` +* `MethodChain.name` +* `MethodChain.schema` ## `add` -* `add` +* `add` ## `alias` -* `alias` +* `alias` ## `if` -* `if` +* `if` ## `this.extend` -* `this.extend` +* `this.extend` @@ -61,13 +55,15 @@ -

# 

+

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/MethodChain.js#L2 "View in source") [Ⓣ][1] unknown -### @todos +#### @todos - [ ] clarify .set vs .call @@ -75,25 +71,21 @@ unknown - - - - -## `MethodChain.prototype` - 🌊 Types: MethodChain.d  🔬 Tests: MethodChain  -

# MethodChain.prototype.

+

MethodChain.

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/MethodChain.js#L112 "View in source") [Ⓣ][1] (Map): ❗ using `+` will call `.build()` in a shorthand fashion -### @todos +#### @todos - [ ] maybe abstract the most re-usable core as a protected class so the shorthands could be used, and more functionality made external @@ -102,11 +94,12 @@ unknown !!! .sponge - absorn properties into the store -### @extends +#### @extends ChainedMap -#### Since + +#### @Since 4.0.0 --- @@ -115,24 +108,27 @@ ChainedMap -

# MethodChain.prototype._build(name=undefined, parent=undefined)

+

MethodChain._build(name=undefined, parent=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/MethodChain.js#L441 "View in source") [Ⓣ][1] Function -### @notes +#### @notes * scoping here adding default functions have to rescope arguments -### @todos +#### @todos - [ ] allow config of method var in plugins since it is scoped... - [ ] add to .meta(shorthands) - [ ] reduce complexity if perf allows -#### Since + +#### @Since 4.0.0-alpha.1 #### Arguments @@ -148,20 +144,23 @@ Function -

# MethodChain.prototype._defaults(name=undefined, parent=undefined, built=undefined)

+

MethodChain._defaults(name=undefined, parent=undefined, built=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/MethodChain.js#L403 "View in source") [Ⓣ][1] Function -### @todos +#### @todos - [ ] optimize the size of this with some bitwise operators hashing the things that have been defaulted also could be plugin -#### Since + +#### @Since 4.0.0 #### Arguments @@ -210,12 +209,15 @@ let methodFactories -

# MethodChain.prototype.autoIncrement()

+

MethodChain.autoIncrement()

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/MethodChain.js#L743 "View in source") [Ⓣ][1] (Function): adds a plugin to increment the value on every call -#### Since + +#### @Since 0.4.0 #### Returns @@ -234,17 +236,20 @@ chain.get('index') -

# MethodChain.prototype.build([returnValue=undefined])

+

MethodChain.build([returnValue=undefined])

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/MethodChain.js#L331 "View in source") [Ⓣ][1] (Function): set the actual method, also need .context - use .parent -### @todos +#### @todos - [ ] if passing in a name that already exists, operations are decorations... (partially done) -#### Since + +#### @Since 4.0.0 #### Arguments @@ -269,7 +274,9 @@ typeof obj.getEh -

# MethodChain.prototype.decorate([parentToDecorate=undefined])

+

MethodChain.decorate([parentToDecorate=undefined])

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/MethodChain.js#L712 "View in source") [Ⓣ][1] (Function): add methods to the parent for easier chaining @@ -336,7 +343,9 @@ master.eh.get('advanced') -

# MethodChain.prototype.name(methods=undefined)

+

MethodChain.name(methods=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/MethodChain.js#L225 "View in source") [Ⓣ][1] (Function): setup methods to build @@ -361,7 +370,9 @@ typeof obj.eh -

# MethodChain.prototype.schema(obj=undefined)

+

MethodChain.schema(obj=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/MethodChain.js#L306 "View in source") [Ⓣ][1] (Function): an object that contains nestable `.type`s @@ -369,7 +380,7 @@ they are recursively *(using an optimized traversal cache)* mapped to validators ❗ this method auto-calls .build, all other method config calls should be done before it -### @todos +#### @todos - [ ] link to `deps/is` docs - [ ] move out into a plugin to show how easy it is to use a plugin @@ -381,7 +392,8 @@ they are recursively *(using an optimized traversal cache)* mapped to validators and then have some demo for how to validate on set using say mobx observables for all the way down... -#### Since + +#### @Since 4.0.0 #### Arguments @@ -437,12 +449,15 @@ chain.updated_at = false -

# add(methodFactory=undefined)

+

add(methodFactory=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/MethodChain.js#L778 "View in source") [Ⓣ][1] (Function): add methodFactories easily -#### Since + +#### @Since 4.0.0-beta.2 #### Arguments @@ -484,17 +499,20 @@ chain.eh() -

# alias(aliases=undefined)

+

alias(aliases=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/MethodChain.js#L177 "View in source") [Ⓣ][1] (Function): alias methods -### @notes +#### @notes * these would be .transform -#### Since + +#### @Since 2.0.0 #### Arguments @@ -524,7 +542,9 @@ chain.get('canada') -

# if()

+

if()

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/MethodChain.js#L233 "View in source") [Ⓣ][1] (Function): this is a plugin for building methods schema defaults value to `.type` this defaults values to `.onCall` @@ -541,7 +561,9 @@ chain.get('canada') -

# this.extend()

+

this.extend()

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/MethodChain.js#L136 "View in source") [Ⓣ][1] Function diff --git a/docs/docdown/README.md b/docs/docdown/README.md index 10f8e38..b2c919c 100644 --- a/docs/docdown/README.md +++ b/docs/docdown/README.md @@ -6,8 +6,7 @@ - `├` `─` [MergeChain](https://github.com/fluents/chain-able/blob/master/docs/docdown/MergeChain.js) - `├` `─` [MethodChain](https://github.com/fluents/chain-able/blob/master/docs/docdown/MethodChain.js) - `├` `─` [TraverseChain](https://github.com/fluents/chain-able/blob/master/docs/docdown/TraverseChain.js) -- `├` `─` [_Playground](https://github.com/fluents/chain-able/blob/master/docs/docdown/_Playground.js) -- `├` `─` [compose](https://github.com/fluents/chain-able/blob/master/docs/docdown/src/compose/) +- `├` `─` [compose](compose) - `│` `├` `─` [DotProp](https://github.com/fluents/chain-able/blob/master/docs/docdown/compose/DotProp.js) - `│` `├` `─` [Observe](https://github.com/fluents/chain-able/blob/master/docs/docdown/compose/Observe.js) - `│` `├` `─` [Shorthands](https://github.com/fluents/chain-able/blob/master/docs/docdown/compose/Shorthands.js) @@ -15,34 +14,42 @@ - `│` `├` `─` [compose](https://github.com/fluents/chain-able/blob/master/docs/docdown/compose/compose.js) - `│` `├` `─` [decorators](https://github.com/fluents/chain-able/blob/master/docs/docdown/compose/decorators.js) - `│` `└` `─` [index](https://github.com/fluents/chain-able/blob/master/docs/docdown/compose/index.js) -- `├` `─` [deps](https://github.com/fluents/chain-able/blob/master/docs/docdown/src/deps/) +- `├` `─` [deps](deps) - `│` `├` `─` [argumentor](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/argumentor.js) -- `│` `├` `─` [array](https://github.com/fluents/chain-able/blob/master/docs/docdown/src/deps/array/) -- `│` `│` `├` `─` [insert-at-index](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/array/insert-at-index.js) +- `│` `├` `─` [array](array) +- `│` `│` `├` `─` [concat](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/array/concat.js) +- `│` `│` `├` `─` [insertAtIndex](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/array/insertAtIndex.js) - `│` `│` `└` `─` [uniq](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/array/uniq.js) -- `│` `├` `─` [cache](https://github.com/fluents/chain-able/blob/master/docs/docdown/src/deps/cache/) +- `│` `├` `─` [cache](cache) - `│` `│` `├` `─` [index](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/cache/index.js) +- `│` `│` `├` `─` [pooler](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/cache/pooler.js) - `│` `│` `└` `─` [scoped](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/cache/scoped.js) -- `│` `├` `─` [camel-case](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/camel-case.js) -- `│` `├` `─` [concat](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/concat.js) -- `│` `├` `─` [conditional](https://github.com/fluents/chain-able/blob/master/docs/docdown/src/deps/conditional/) +- `│` `├` `─` [conditional](conditional) - `│` `│` `├` `─` [all](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/conditional/all.js) - `│` `│` `├` `─` [and](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/conditional/and.js) - `│` `│` `├` `─` [eq](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/conditional/eq.js) -- `│` `│` `├` `─` [includes](https://github.com/fluents/chain-able/blob/master/docs/docdown/src/deps/conditional/includes/) +- `│` `│` `├` `─` [eqeq](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/conditional/eqeq.js) +- `│` `│` `├` `─` [includes](includes) - `│` `│` `│` `├` `─` [all](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/conditional/includes/all.js) - `│` `│` `│` `├` `─` [any](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/conditional/includes/any.js) +- `│` `│` `│` `├` `─` [flipped](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/conditional/includes/flipped.js) - `│` `│` `│` `├` `─` [includes](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/conditional/includes/includes.js) - `│` `│` `│` `└` `─` [index](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/conditional/includes/index.js) +- `│` `│` `├` `─` [index](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/conditional/index.js) - `│` `│` `├` `─` [not](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/conditional/not.js) - `│` `│` `├` `─` [or](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/conditional/or.js) - `│` `│` `└` `─` [some](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/conditional/some.js) +- `│` `├` `─` [construct](construct) +- `│` `│` `├` `─` [map](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/construct/map.js) +- `│` `│` `├` `─` [regexp](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/construct/regexp.js) +- `│` `│` `└` `─` [set](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/construct/set.js) - `│` `├` `─` [define](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/define.js) -- `│` `├` `─` [dopemerge](https://github.com/fluents/chain-able/blob/master/docs/docdown/src/deps/dopemerge/) +- `│` `├` `─` [dopemerge](dopemerge) - `│` `│` `├` `─` [dopemerge](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/dopemerge/dopemerge.js) +- `│` `│` `├` `─` [emptyTarget](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/dopemerge/emptyTarget.js) - `│` `│` `├` `─` [index](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/dopemerge/index.js) - `│` `│` `└` `─` [map](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/dopemerge/map.js) -- `│` `├` `─` [dot](https://github.com/fluents/chain-able/blob/master/docs/docdown/src/deps/dot/) +- `│` `├` `─` [dot](dot) - `│` `│` `├` `─` [delete](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/dot/delete.js) - `│` `│` `├` `─` [dot-prop](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/dot/dot-prop.js) - `│` `│` `├` `─` [dottable](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/dot/dottable.js) @@ -53,27 +60,70 @@ - `│` `│` `├` `─` [paths](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/dot/paths.js) - `│` `│` `├` `─` [segments](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/dot/segments.js) - `│` `│` `└` `─` [set](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/dot/set.js) -- `│` `├` `─` [encase](https://github.com/fluents/chain-able/blob/master/docs/docdown/src/deps/encase/) +- `│` `├` `─` [encase](encase) - `│` `│` `├` `─` [encase](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/encase/encase.js) - `│` `│` `├` `─` [index](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/encase/index.js) - `│` `│` `├` `─` [tryCatch](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/encase/tryCatch.js) - `│` `│` `└` `─` [withSpecification](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/encase/withSpecification.js) -- `│` `├` `─` [env](https://github.com/fluents/chain-able/blob/master/docs/docdown/src/deps/env/) +- `│` `├` `─` [env](env) - `│` `│` `├` `─` [debug](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/env/debug.js) - `│` `│` `└` `─` [dev](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/env/dev.js) +- `│` `├` `─` [expressions](expressions) +- `│` `│` `├` `─` [above](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/expressions/above.js) +- `│` `│` `├` `─` [below](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/expressions/below.js) +- `│` `│` `├` `─` [between](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/expressions/between.js) +- `│` `│` `├` `─` [bitwiseMathOperator](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/expressions/bitwiseMathOperator.js) +- `│` `│` `├` `─` [even](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/expressions/even.js) +- `│` `│` `├` `─` [expressions](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/expressions/expressions.js) +- `│` `│` `├` `─` [increment](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/expressions/increment.js) +- `│` `│` `├` `─` [index](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/expressions/index.js) +- `│` `│` `└` `─` [odd](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/expressions/odd.js) +- `│` `├` `─` [fp](fp) +- `│` `│` `├` `─` [always](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/fp/always.js) +- `│` `│` `├` `─` [arity](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/fp/arity.js) +- `│` `│` `├` `─` [callDestructure](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/fp/callDestructure.js) +- `│` `│` `├` `─` [construct](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/fp/construct.js) +- `│` `│` `├` `─` [constructInit](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/fp/constructInit.js) +- `│` `│` `├` `─` [curry](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/fp/curry.js) +- `│` `│` `├` `─` [first](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/fp/first.js) +- `│` `│` `├` `─` [firstIndex](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/fp/firstIndex.js) +- `│` `│` `├` `─` [flip](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/fp/flip.js) +- `│` `│` `├` `─` [flip2](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/fp/flip2.js) +- `│` `│` `├` `─` [fp](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/fp/fp.js) +- `│` `│` `├` `─` [hasInMatching](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/fp/hasInMatching.js) +- `│` `│` `├` `─` [includesCount](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/fp/includesCount.js) +- `│` `│` `├` `─` [index](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/fp/index.js) +- `│` `│` `├` `─` [invoke](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/fp/invoke.js) +- `│` `│` `├` `─` [isPlaceholder](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/fp/isPlaceholder.js) +- `│` `│` `├` `─` [last](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/fp/last.js) +- `│` `│` `├` `─` [lastIndex](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/fp/lastIndex.js) +- `│` `│` `├` `─` [mapWhere](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/fp/mapWhere.js) +- `│` `│` `├` `─` [path](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/fp/path.js) +- `│` `│` `├` `─` [pipe](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/fp/pipe.js) +- `│` `│` `├` `─` [pipeTwo](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/fp/pipeTwo.js) +- `│` `│` `├` `─` [prop](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/fp/prop.js) +- `│` `│` `├` `─` [remove](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/fp/remove.js) +- `│` `│` `├` `─` [replace](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/fp/replace.js) +- `│` `│` `└` `─` [reverse](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/fp/reverse.js) - `│` `├` `─` [gc](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/gc.js) -- `│` `├` `─` [ignored](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/ignored.js) - `│` `├` `─` [index](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/index.js) -- `│` `├` `─` [is](https://github.com/fluents/chain-able/blob/master/docs/docdown/src/deps/is/) +- `│` `├` `─` [is](is) +- `│` `│` `├` `─` [JSON](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/JSON.js) +- `│` `│` `├` `─` [arguments](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/arguments.js) - `│` `│` `├` `─` [array](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/array.js) +- `│` `│` `├` `─` [arrayOf](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/arrayOf.js) - `│` `│` `├` `─` [async](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/async.js) - `│` `│` `├` `─` [asyncish](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/asyncish.js) - `│` `│` `├` `─` [boolean](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/boolean.js) +- `│` `│` `├` `─` [booleanPrimitive](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/booleanPrimitive.js) +- `│` `│` `├` `─` [browser](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/browser.js) +- `│` `│` `├` `─` [buffer](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/buffer.js) +- `│` `│` `├` `─` [circular](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/circular.js) - `│` `│` `├` `─` [class](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/class.js) - `│` `│` `├` `─` [date](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/date.js) - `│` `│` `├` `─` [dot](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/dot.js) +- `│` `│` `├` `─` [empty](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/empty.js) - `│` `│` `├` `─` [enumerable](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/enumerable.js) -- `│` `│` `├` `─` [eqeq](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/eqeq.js) - `│` `│` `├` `─` [error](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/error.js) - `│` `│` `├` `─` [false](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/false.js) - `│` `│` `├` `─` [function](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/function.js) @@ -81,21 +131,28 @@ - `│` `│` `├` `─` [hasIn](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/hasIn.js) - `│` `│` `├` `─` [in](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/in.js) - `│` `│` `├` `─` [index](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/index.js) +- `│` `│` `├` `─` [instanceOf](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/instanceOf.js) +- `│` `│` `├` `─` [iteratable](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/iteratable.js) - `│` `│` `├` `─` [iterator](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/iterator.js) - `│` `│` `├` `─` [map](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/map.js) - `│` `│` `├` `─` [mapish](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/mapish.js) +- `│` `│` `├` `─` [match](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/match.js) - `│` `│` `├` `─` [matcher](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/matcher.js) - `│` `│` `├` `─` [native](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/native.js) - `│` `│` `├` `─` [nodejs](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/nodejs.js) - `│` `│` `├` `─` [notEmptyArray](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/notEmptyArray.js) +- `│` `│` `├` `─` [notNested](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/notNested.js) +- `│` `│` `├` `─` [notRealOrIsEmpty](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/notRealOrIsEmpty.js) - `│` `│` `├` `─` [null](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/null.js) - `│` `│` `├` `─` [nullOrUndefined](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/nullOrUndefined.js) - `│` `│` `├` `─` [number](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/number.js) +- `│` `│` `├` `─` [numberPrimitive](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/numberPrimitive.js) - `│` `│` `├` `─` [obj](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/obj.js) -- `│` `│` `├` `─` [objLoose](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/objLoose.js) +- `│` `│` `├` `─` [objNotNull](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/objNotNull.js) - `│` `│` `├` `─` [objPure](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/objPure.js) -- `│` `│` `├` `─` [objStrict](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/objStrict.js) +- `│` `│` `├` `─` [objTypeof](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/objTypeof.js) - `│` `│` `├` `─` [objWithKeys](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/objWithKeys.js) +- `│` `│` `├` `─` [primitive](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/primitive.js) - `│` `│` `├` `─` [promise](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/promise.js) - `│` `│` `├` `─` [prototypeOf](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/prototypeOf.js) - `│` `│` `├` `─` [real](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/real.js) @@ -107,44 +164,74 @@ - `│` `│` `├` `─` [symbol](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/symbol.js) - `│` `│` `├` `─` [toS](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/toS.js) - `│` `│` `├` `─` [true](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/true.js) -- `│` `│` `└` `─` [undefined](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/undefined.js) -- `│` `├` `─` [matcher](https://github.com/fluents/chain-able/blob/master/docs/docdown/src/deps/matcher/) +- `│` `│` `├` `─` [undefined](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/undefined.js) +- `│` `│` `├` `─` [undefinedLike](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/undefinedLike.js) +- `│` `│` `├` `─` [weakMap](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/weakMap.js) +- `│` `│` `└` `─` [weakSet](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/is/weakSet.js) +- `│` `├` `─` [matcher](matcher) - `│` `│` `├` `─` [any-key-val](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/matcher/any-key-val.js) - `│` `│` `├` `─` [escape-string-regex](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/matcher/escape-string-regex.js) - `│` `│` `├` `─` [index](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/matcher/index.js) - `│` `│` `├` `─` [matcher](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/matcher/matcher.js) - `│` `│` `├` `─` [to-regexp](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/matcher/to-regexp.js) - `│` `│` `└` `─` [to-test](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/matcher/to-test.js) -- `│` `├` `─` [meta](https://github.com/fluents/chain-able/blob/master/docs/docdown/src/deps/meta/) +- `│` `├` `─` [meta](meta) - `│` `│` `├` `─` [decorated](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/meta/decorated.js) - `│` `│` `├` `─` [enums](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/meta/enums.js) +- `│` `│` `├` `─` [ignored](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/meta/ignored.js) - `│` `│` `├` `─` [index](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/meta/index.js) - `│` `│` `├` `─` [keymap](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/meta/keymap.js) - `│` `│` `├` `─` [meta](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/meta/meta.js) - `│` `│` `├` `─` [observers](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/meta/observers.js) - `│` `│` `├` `─` [shorthands](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/meta/shorthands.js) - `│` `│` `└` `─` [transformers](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/meta/transformers.js) -- `│` `├` `─` [reduce](https://github.com/fluents/chain-able/blob/master/docs/docdown/src/deps/reduce/) +- `│` `├` `─` [native](native) +- `│` `│` `├` `─` [arraySlice](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/native/arraySlice.js) +- `│` `│` `├` `─` [functionToString](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/native/functionToString.js) +- `│` `│` `├` `─` [hasOwnProperty](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/native/hasOwnProperty.js) +- `│` `│` `├` `─` [objectToString](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/native/objectToString.js) +- `│` `│` `└` `─` [propertyIsEnumerable](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/native/propertyIsEnumerable.js) +- `│` `├` `─` [reduce](reduce) - `│` `│` `├` `─` [clean](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/reduce/clean.js) - `│` `│` `├` `─` [entries](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/reduce/entries.js) - `│` `│` `├` `─` [index](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/reduce/index.js) -- `│` `│` `├` `─` [objects](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/reduce/objects.js) -- `│` `│` `└` `─` [reduce](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/reduce/reduce.js) -- `│` `├` `─` [string](https://github.com/fluents/chain-able/blob/master/docs/docdown/src/deps/string/) +- `│` `│` `├` `─` [reduce](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/reduce/reduce.js) +- `│` `│` `└` `─` [toObj](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/reduce/toObj.js) +- `│` `├` `─` [string](string) +- `│` `│` `├` `─` [camelCase](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/string/camelCase.js) - `│` `│` `├` `─` [class-names](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/string/class-names.js) +- `│` `│` `├` `─` [firstToUpperCase](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/string/firstToUpperCase.js) - `│` `│` `└` `─` [prefix](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/string/prefix.js) -- `│` `├` `─` [symbols](https://github.com/fluents/chain-able/blob/master/docs/docdown/src/deps/symbols/) +- `│` `├` `─` [symbols](symbols) - `│` `│` `├` `─` [index](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/symbols/index.js) - `│` `│` `├` `─` [instance](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/symbols/instance.js) - `│` `│` `├` `─` [iterator](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/symbols/iterator.js) - `│` `│` `├` `─` [primitive](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/symbols/primitive.js) - `│` `│` `├` `─` [species](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/symbols/species.js) - `│` `│` `└` `─` [spreadable](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/symbols/spreadable.js) +- `│` `├` `─` [to](to) +- `│` `│` `├` `─` [array](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/to/array.js) +- `│` `│` `├` `─` [boolean](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/to/boolean.js) +- `│` `│` `├` `─` [coerce](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/to/coerce.js) +- `│` `│` `├` `─` [index](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/to/index.js) +- `│` `│` `├` `─` [integer](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/to/integer.js) +- `│` `│` `├` `─` [map](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/to/map.js) +- `│` `│` `├` `─` [number](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/to/number.js) +- `│` `│` `├` `─` [object](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/to/object.js) +- `│` `│` `├` `─` [set](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/to/set.js) +- `│` `│` `├` `─` [setToArray](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/to/setToArray.js) +- `│` `│` `├` `─` [string](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/to/string.js) +- `│` `│` `└` `─` [to](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/to/to.js) - `│` `├` `─` [to-arr](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/to-arr.js) - `│` `├` `─` [traverse](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/traverse.js) -- `│` `├` `─` [traversers](https://github.com/fluents/chain-able/blob/master/docs/docdown/src/deps/traversers/) -- `│` `│` `└` `─` [eq](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/traversers/eq.js) -- `│` `├` `─` [util](https://github.com/fluents/chain-able/blob/master/docs/docdown/src/deps/util/) +- `│` `├` `─` [traversers](traversers) +- `│` `│` `├` `─` [_eq](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/traversers/_eq.js) +- `│` `│` `├` `─` [copy](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/traversers/copy.js) +- `│` `│` `├` `─` [eq](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/traversers/eq.js) +- `│` `│` `├` `─` [eqValue](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/traversers/eqValue.js) +- `│` `│` `├` `─` [stringify](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/traversers/stringify.js) +- `│` `│` `└` `─` [traverse-comments](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/traversers/traverse-comments.js) +- `│` `├` `─` [util](util) - `│` `│` `├` `─` [assign](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/util/assign.js) - `│` `│` `├` `─` [charCodeAtZero](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/util/charCodeAtZero.js) - `│` `│` `├` `─` [flatten](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/util/flatten.js) @@ -152,14 +239,21 @@ - `│` `│` `├` `─` [getDescriptor](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/util/getDescriptor.js) - `│` `│` `├` `─` [getPrototypeOf](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/util/getPrototypeOf.js) - `│` `│` `├` `─` [hasOwnProperty](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/util/hasOwnProperty.js) +- `│` `│` `├` `─` [index](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/util/index.js) - `│` `│` `├` `─` [keys](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/util/keys.js) +- `│` `│` `├` `─` [keysObjOrArray](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/util/keysObjOrArray.js) +- `│` `│` `├` `─` [keywords](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/util/keywords.js) - `│` `│` `├` `─` [length](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/util/length.js) +- `│` `│` `├` `─` [lengthFromZero](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/util/lengthFromZero.js) - `│` `│` `├` `─` [lengthMinusOne](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/util/lengthMinusOne.js) +- `│` `│` `├` `─` [localGlobal](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/util/localGlobal.js) - `│` `│` `├` `─` [nonEnumerableTypes](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/util/nonEnumerableTypes.js) +- `│` `│` `├` `─` [noop](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/util/noop.js) - `│` `│` `├` `─` [props](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/util/props.js) - `│` `│` `├` `─` [simpleKindOf](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/util/simpleKindOf.js) -- `│` `│` `└` `─` [typeof](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/util/typeof.js) -- `│` `└` `─` [validators](https://github.com/fluents/chain-able/blob/master/docs/docdown/src/deps/validators/) +- `│` `│` `├` `─` [typeof](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/util/typeof.js) +- `│` `│` `└` `─` [util](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/util/util.js) +- `│` `└` `─` [validators](validators) - `│` `├` `─` [error](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/validators/error.js) - `│` `├` `─` [index](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/validators/index.js) - `│` `├` `─` [schemaBuilder](https://github.com/fluents/chain-able/blob/master/docs/docdown/deps/validators/schemaBuilder.js) @@ -167,11 +261,12 @@ - `├` `─` [index](https://github.com/fluents/chain-able/blob/master/docs/docdown/index.js) - `├` `─` [index](index) - `│` `└` `─` [index.js](https://github.com/fluents/chain-able/blob/master/docs/docdown/index.web.js) -- `├` `─` [plugins](https://github.com/fluents/chain-able/blob/master/docs/docdown/src/plugins/) +- `├` `─` [plugins](plugins) - `│` `├` `─` [autoGetSet](https://github.com/fluents/chain-able/blob/master/docs/docdown/plugins/autoGetSet.js) - `│` `├` `─` [autoIncrement](https://github.com/fluents/chain-able/blob/master/docs/docdown/plugins/autoIncrement.js) - `│` `├` `─` [decorate](https://github.com/fluents/chain-able/blob/master/docs/docdown/plugins/decorate.js) - `│` `├` `─` [encase](https://github.com/fluents/chain-able/blob/master/docs/docdown/plugins/encase.js) +- `│` `├` `─` [getterOnSet](https://github.com/fluents/chain-able/blob/master/docs/docdown/plugins/getterOnSet.js) - `│` `├` `─` [index](https://github.com/fluents/chain-able/blob/master/docs/docdown/plugins/index.js) - `│` `├` `─` [merge](https://github.com/fluents/chain-able/blob/master/docs/docdown/plugins/merge.js) - `│` `├` `─` [obj](https://github.com/fluents/chain-able/blob/master/docs/docdown/plugins/obj.js) diff --git a/docs/docdown/TraverseChain.md b/docs/docdown/TraverseChain.md index 2d2d49a..88e8a64 100644 --- a/docs/docdown/TraverseChain.md +++ b/docs/docdown/TraverseChain.md @@ -4,22 +4,22 @@ -## `Traverse.prototype` -* `Traverse.prototype.exports` +## `Traverse` +* `Traverse.exports` -## `TraverseChain.prototype` -* `TraverseChain.prototype.traverse` +## `TraverseChain` +* `TraverseChain.traverse` ## `traversed` -* `traversed` +* `traversed` @@ -29,7 +29,7 @@ -## `Traverse.prototype` +## `Traverse` @@ -37,17 +37,19 @@ 🔬 Tests: TraverseChain  -

# Traverse.prototype.exports

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/TraverseChain.js#L29 "View in source") [Ⓣ][1] +

Traverse.exports

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/TraverseChain.js#L30 "View in source") [Ⓣ][1] Map -### @symb +#### @symb 👣 -### @classProps +#### @classProps * {obj} * {keys} @@ -57,11 +59,12 @@ Map * {clone} -### @extends +#### @extends ChainedMapBase -#### Since + +#### @Since 1.0.0 --- @@ -72,16 +75,19 @@ ChainedMapBase -## `TraverseChain.prototype` +## `TraverseChain` -

# TraverseChain.prototype.traverse([shouldReturn=false])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/TraverseChain.js#L90 "View in source") [Ⓣ][1] +

TraverseChain.traverse([shouldReturn=false])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/TraverseChain.js#L92 "View in source") [Ⓣ][1] (Function): runs traverser, checks the tests, calls the onMatch -#### Since + +#### @Since 1.0.0 #### Arguments @@ -131,12 +137,15 @@ traversed -

# traversed()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/TraverseChain.js#L172 "View in source") [Ⓣ][1] +

traversed()

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/TraverseChain.js#L192 "View in source") [Ⓣ][1] (Function): value traversed in traverse -#### Since + +#### @Since 1.0.0 #### Returns @@ -205,4 +214,4 @@ const eh = { - [1]: #traverse.prototype "Jump back to the TOC." + [1]: #traverse "Jump back to the TOC." diff --git a/docs/docdown/_Playground.md b/docs/docdown/_Playground.md deleted file mode 100644 index f8d5ff5..0000000 --- a/docs/docdown/_Playground.md +++ /dev/null @@ -1,62 +0,0 @@ -# _Playground.js API documentation - - - - - -## `ChainedMapBase.prototype` -* `ChainedMapBase.prototype.playground` - - - - - - - - - -## `ChainedMapBase.prototype` - - - -🌊 Types: ChainedMapBase.d  - -🔬 Tests: ChainedMap  - -

# ChainedMapBase.prototype.playground

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/_Playground.js#L31 "View in source") [Ⓣ][1] - -(Chainable): 3 steps 0. enhance error 1. encase function with a specification 2. build a function to call onInvalid or onInvalid depending - - -### @see - -* articles/es6 maps in depth -* Developer.mozilla.org/en/docs/web/java script/reference/global objects/map -* fluents/chain able/blob/master/src/chainable.js -* fluents/chain able/blob/master/src/merge chain.js -* fluents/chain able/blob/master/src/method chain.js -* fluents/chain able/blob/master/src/chained map.js - -### @classProps - -* {meta} meta fn -* {store} main store - - -### @extends -Chainable - - -#### Since -4.0.0-alpha.1 - ---- - - - - - - - - [1]: #chainedmapbase.prototype "Jump back to the TOC." diff --git a/docs/docdown/aio.md b/docs/docdown/aio.md index c371dfa..3f9e480 100644 --- a/docs/docdown/aio.md +++ b/docs/docdown/aio.md @@ -4,939 +4,859 @@ -## `CM` -* `CM` +## `Chainable` +* `Chainable.Chainable` +* `Chainable.clear` +* `Chainable.delete` +* `Chainable.end` +* `Chainable.has` +* `Chainable.length` +* `Chainable.prototype[iterator]` +* `Chainable.prototype[primitive]` +* `Chainable.values` +* `Chainable.when` -## `Chainable.prototype` -* `Chainable.prototype.Chainable` - - - - - -## `ChainedMapBase.prototype` -* `ChainedMapBase.prototype.CMC` -* `ChainedMapBase.prototype.compose` -* `ChainedMapBase.prototype.entries` -* `ChainedMapBase.prototype.extend` -* `ChainedMapBase.prototype.from` -* `ChainedMapBase.prototype.get` -* `ChainedMapBase.prototype.set` -* `ChainedMapBase.prototype.tap` +## `ChainedMapBase` +* `ChainedMapBase.ComposeChainedMap` +* `ChainedMapBase.ComposeChainedMapBase` +* `ChainedMapBase.compose` +* `ChainedMapBase.entries` +* `ChainedMapBase.extend` +* `ChainedMapBase.from` +* `ChainedMapBase.get` +* `ChainedMapBase.set` +* `ChainedMapBase.tap` ## `ChainedSet` -* `ChainedSet` +* `ChainedSet.ChainedSet` +* `ChainedSet.add` +* `ChainedSet.merge` +* `ChainedSet.prepend` -## `DotProp.prototype` -* `DotProp.prototype.get` -* `DotProp.prototype.set` +## `DotProp` +* `DotProp.get` +* `DotProp.set` -## `FactoryChain.prototype` -* `FactoryChain.prototype.FactoryChain` -* `FactoryChain.prototype.chainUpDowns` -* `FactoryChain.prototype.factory` -* `FactoryChain.prototype.getData` -* `FactoryChain.prototype.prop` -* `FactoryChain.prototype.props` +## `FactoryChain` +* `FactoryChain.FactoryChain` +* `FactoryChain.chainUpDowns` +* `FactoryChain.factory` +* `FactoryChain.getData` +* `FactoryChain.prop` +* `FactoryChain.props` -## `MergeChain.prototype` -* `MergeChain.prototype.MergeChain` -* `MergeChain.prototype.init` -* `MergeChain.prototype.onExisting` +## `MergeChain` +* `MergeChain.MergeChain` +* `MergeChain.init` +* `MergeChain.onExisting` -## `MethodChain.prototype` -* `MethodChain.prototype.MethodChain` -* `MethodChain.prototype._build` -* `MethodChain.prototype._defaults` -* `MethodChain.prototype.autoGetSet` -* `MethodChain.prototype.autoIncrement` -* `MethodChain.prototype.build` -* `MethodChain.prototype.decorate` -* `MethodChain.prototype.decorate` -* `MethodChain.prototype.name` -* `MethodChain.prototype.schema` +## `MethodChain` +* `MethodChain.MethodChain` +* `MethodChain._build` +* `MethodChain._defaults` +* `MethodChain.autoGetSet` +* `MethodChain.autoIncrement` +* `MethodChain.build` +* `MethodChain.decorate` +* `MethodChain.decorate` +* `MethodChain.name` +* `MethodChain.schema` -## `Observe.prototype` -* `Observe.prototype.` -* `Observe.prototype.DotProp` -* `Observe.prototype.Observe` +## `Observe` +* `Observe.` +* `Observe.DotProp` +* `Observe.Observe` -## `ShorthandChain.prototype` -* `ShorthandChain.prototype.return` -* `ShorthandChain.prototype.setIfEmpty` -* `ShorthandChain.prototype.wrap` +## `ShorthandChain` +* `ShorthandChain.return` +* `ShorthandChain.setIfEmpty` +* `ShorthandChain.wrap` ## `Transform` -* `Transform` +* `Transform` -## `TransformChain.prototype` -* `TransformChain.prototype.` -* `TransformChain.prototype.remap` -* `TransformChain.prototype.set` -* `TransformChain.prototype.transform` +## `TransformChain` +* `TransformChain.` +* `TransformChain.remap` +* `TransformChain.set` +* `TransformChain.transform` -## `Traverse.prototype` -* `Traverse.prototype.` -* `Traverse.prototype.` -* `Traverse.prototype.TraverseChain` -* `Traverse.prototype.clone` -* `Traverse.prototype.forEach` -* `Traverse.prototype.get` -* `Traverse.prototype.has` -* `Traverse.prototype.nodes` -* `Traverse.prototype.paths` -* `Traverse.prototype.reduce` -* `Traverse.prototype.set` +## `Traverse` +* `Traverse.TraverseChain` +* `Traverse.checkIteratable` +* `Traverse.clone` +* `Traverse.copy` +* `Traverse.eq` +* `Traverse.eqValue` +* `Traverse.forEach` +* `Traverse.iterate` +* `Traverse.remove` +* `Traverse.skip` +* `Traverse.stop` +* `Traverse.update` -## `TraverseChain.prototype` -* `TraverseChain.prototype.traverse` +## `TraverseChain` +* `TraverseChain.traverse` ## `add` -* `add` -* `add` +* `add` ## `addTypes` -* `addTypes` - - - - - -## `after` -* `after` +* `addTypes` ## `alias` -* `alias` - - - - - -## `allProperties` -* `allProperties` +* `alias` ## `anyKeyVal` -* `anyKeyVal` +* `anyKeyVal` ## `argumentor` -* `argumentor` +* `argumentor` ## `arithmeticTypeFactory` -* `arithmeticTypeFactory` +* `arithmeticTypeFactory` ## `autoIncrement` -* `autoIncrement` - - - - - -## `before` -* `before` +* `autoIncrement` -## `block` -* `block` +## `builder` +* `builder` -## `builder` -* `builder` +## `camelCase` +* `camelCase` -## `camelCase` -* `camelCase` +## `clone` +* `clone` -## `circular` -* `circular` +## `compose` +* `compose.compose` -## `clear` -* `clear` +## `concat` +* `concat` -## `compose.prototype` -* `compose.prototype.compose` +## `conditional` +* `conditional.all` +* `conditional.and` +* `conditional.not` +* `conditional.or` -## `conditional.prototype` -* `conditional.prototype.all` -* `conditional.prototype.and` -* `conditional.prototype.not` -* `conditional.prototype.or` +## `copy` +* `copy` ## `debug` -* `debug` +* `debug` ## `define` -* `define` +* `define` ## `delete` -* `delete` -* `delete` -* `delete` +* `delete` -## `dopemerge.prototype` -* `dopemerge.prototype.cloneIfNeeded` -* `dopemerge.prototype.defaultArrayMerge` -* `dopemerge.prototype.dopemerge` -* `dopemerge.prototype.emptyTarget` -* `dopemerge.prototype.isMergeableObj` +## `dopemerge` +* `dopemerge.cloneIfNeeded` +* `dopemerge.defaultArrayMerge` +* `dopemerge.dopemerge` +* `dopemerge.emptyTarget` +* `dopemerge.isMergeableObj` ## `dot` -* `dot` +* `dot` +* `dot.dot.delete` +* `dot.dot.get` +* `dot.dot.has` +* `dot.dotPropSegments` ## `encase` -* `encase` - - - - - -## `encase.prototype` -* `encase.prototype.error$3` - - - - - -## `end` -* `end` +* `encase.encase` +* `encase.error$3` +* `encase.tryCatch` +* `encase.withSpecification` ## `entries` -* `entries` +* `entries` -## `forEach` -* `forEach` +## `fp` +* `fp.` +* `fp.` +* `fp.` +* `fp.` +* `fp.` +* `fp.` +* `fp.` +* `fp.` +* `fp.arity` +* `fp.mapWhere` ## `from` -* `from` +* `from` ## `get` -* `get` +* `get` ## `getMeta` -* `getMeta` +* `getMeta` ## `has` -* `has` -* `has` -* `has` +* `has` +* `has` ## `if` -* `if` +* `if` + + + + + +## `includes` +* `includes.includes` ## `index` -* `` -* `` -* `` -* `` -* `` -* `` -* `` -* `` +* `` +* `` +* `` +* `` +* `` +* `` +* `` -## `is.prototype` -* `is.prototype.isBoolean` -* `is.prototype.isDate` -* `is.prototype.isError` -* `is.prototype.isFalse` -* `is.prototype.isFunction` -* `is.prototype.isIterator` -* `is.prototype.isMap` -* `is.prototype.isMapish` -* `is.prototype.isMatcher` -* `is.prototype.isNotEmptyArray` -* `is.prototype.isNull` -* `is.prototype.isNullOrUndefined` -* `is.prototype.isNumber` -* `is.prototype.isObj` -* `is.prototype.isObjLoose` -* `is.prototype.isObjStrict` -* `is.prototype.isObjWithKeys` -* `is.prototype.isReal` -* `is.prototype.isTrue` -* `is.prototype.isUndefined` -* `is.prototype.string` -* `is.prototype.stringOrNumber` -* `is.prototype.stringPrimitive` -* `is.prototype.symbol` -* `is.prototype.toS` +## `is` +* `is.` +* `is.arrayOf` +* `is.exports` +* `is.hasIn` +* `is.isArray` +* `is.isAsync` +* `is.isAsyncish` +* `is.isBoolean` +* `is.isBooleanPrimitive` +* `is.isDate` +* `is.isDot` +* `is.isEnumerable` +* `is.isError` +* `is.isFalse` +* `is.isFunction` +* `is.isIn` +* `is.isIterator` +* `is.isMap` +* `is.isMapish` +* `is.isMatcher` +* `is.isNull` +* `is.isNullOrUndefined` +* `is.isNumber` +* `is.isNumberPrimitive` +* `is.isObj` +* `is.isObjLoose` +* `is.isObjNotNull` +* `is.isObjPure` +* `is.isObjWithKeys` +* `is.isPromise` +* `is.isPrototypeOf` +* `is.isReal` +* `is.isTrue` +* `is.isUndefined` +* `is.primitive$2` +* `is.string` +* `is.stringOrNumber` +* `is.stringPrimitive` +* `is.symbol` -## `is.prototype.index$12` -* `is.prototype.index$12` +## `is.index$12` +* `is.index$12` -## `isArray` -* `isArray` +## `isNotRealOrIsEmpty` +* `isNotRealOrIsEmpty` -## `isRoot` -* `isRoot` +## `iteratable` +* `iteratable` -## `key` -* `key` +## `keysObjOrArray` +* `keysObjOrArray` -## `level` -* `level` +## `lengthFromZero` +* `lengthFromZero` ## `markForGarbageCollection` -* `markForGarbageCollection` +* `markForGarbageCollection` -## `matcher.prototype` -* `matcher.prototype.escapeStringRegExp` -* `matcher.prototype.make` -* `matcher.prototype.match` -* `matcher.prototype.matcher` -* `matcher.prototype.toRegExp` +## `matcher` +* `matcher.escapeStringRegExp` +* `matcher.make` +* `matcher.match` +* `matcher.matcher` +* `matcher.toRegExp` ## `merge` -* `merge` -* `merge` -* `merge` +* `merge` +* `merge` ## `meta` -* `meta` +* `meta` ## `method` -* `method` +* `method` ## `methodEncasingFactory` -* `methodEncasingFactory` - - - - - -## `node` -* `node` - - - - - -## `node_` -* `node_` +* `methodEncasingFactory` -## `parent` -* `parent` +## `noop` +* `noop` -## `path` -* `path` +## `notNested` +* `notNested` ## `paths` -* `paths` - - - - - -## `post` -* `post` - - - - - -## `pre` -* `pre` - - - - - -## `prepend` -* `prepend` +* `paths` -## `prototype[iterator]` -* `prototype[iterator]` +## `pooler` +* `pooler.addPoolingTo` +* `pooler.oneArgumentPooler` +* `pooler.standardReleaser` -## `prototype[primitive]` -* `prototype[primitive]` +## `pooler.// const pooler` +* `pooler.// const pooler` ## `reduce` -* `reduce` - - - - - -## `reduce.prototype` -* `reduce.prototype.clean` +* `reduce` +* `reduce.clean` ## `regexp` -* `regexp` - - - - - -## `remove` -* `remove` - - - - - -## `return` -* `return` +* `regexp` ## `schema` -* `schema` - - - - - -## `schema.prototype` -* `schema.prototype.typeListFactory` -* `schema.prototype.typeValidator` +* `schema` +* `schema.typeListFactory` +* `schema.typeValidator` ## `schemaFactory` -* `schemaFactory` +* `schemaFactory` ## `scopedEncase` -* `scopedEncase` +* `scopedEncase` ## `set` -* `set` +* `set` ## `set$$2` -* `set$$2` +* `set$$2` ## `setChosen` -* `setChosen` +* `setChosen` ## `simpleKindOf` -* `simpleKindOf` - - - - - -## `state` -* `state` - - - - - -## `stop` -* `stop` +* `simpleKindOf` ## `test` -* `test` +* `test` ## `this.extend` -* `this.extend` +* `this.extend` ## `toArr` -* `toArr` +* `toArr` ## `toTest` -* `toTest` +* `toTest` ## `traverse` -* `traverse` -* `traverse` - - - - - -## `traverse.prototype` -* `traverse.prototype.eq` +* `traverse` ## `traversed` -* `traversed` - - - - - -## `tryCatch` -* `tryCatch` +* `traversed` ## `typedOnCall` -* `typedOnCall` +* `typedOnCall` ## `types` -* `types` +* `types` -## `update` -* `update` - - - - - -## `updateState` -* `updateState` +## `util` +* `util.assign` ## `validators` -* `validators` +* `validators` -## `values` -* `values` +## `while` +* `while` - - -## `when` -* `when` - + + -## `while` -* `while` +## `Chainable` - + - +🌊 Types: Chainable.d  - +🔬 Tests: Chainable  - +

Chainable.Chainable

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L15 "View in source") [Ⓣ][1] -## `CM` +(Chainable): Trait class that can inherit any class passed into compose, extended by ChainedMap & ChainedSet - -* 🌊 Types: ChainedMap.d  -* 🌊 Types: ChainedMapBase.d  +#### @see -🔬 Tests: ChainedMap  +* fluents/chain able/blob/master/src/deps/reduce/clean.js -

# CM([SuperClass=ChainedMapBase])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5479 "View in source") [Ⓣ][1] +#### @classProps -(Function): ChainedMap composer +* {parent} +* {className} + +--- + -### @see + -* fluents/chain able/blob/master/src/deps/reduce/clean.js +

Chainable.clear([clearPropertiesThatAreChainLike=true])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L22 "View in source") [Ⓣ][1] -### @extends -ChainedMapBase +(Function): clears the map, goes through this properties, calls .clear if they are instanceof Chainable or Map -#### Since -0.0.1 +#### @see +* fluents/chain able/blob/master/src/deps/reduce/clean.js #### Arguments -1. `[SuperClass=ChainedMapBase]` *(Class|Composable|Object)*: class to extend +1. `[clearPropertiesThatAreChainLike=true]` *(|boolean)*: checks properties on the object, if they are `chain-like`, clears them as well #### Returns -*(Class)*: ChainedMap +*(Chainable)*: @chainable #### Example ```js -const heh = class {} -const composed = ChainedMap.compose(heh) -const hehchain = new Composed() -hehchain instanceof heh -//=> true +const chain = new Chain() +chain.set('eh', 1) +chain.entries() +//=> {eh: 1} +chain.clear() +chain.entries() +//=> {} ``` --- - - -## `Chainable.prototype` - - +

Chainable.delete(key=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1237 "View in source") [Ⓣ][1] -🌊 Types: Chainable.d  +(Function): calls .delete on this.store.map -🔬 Tests: Chainable  -

# Chainable.prototype.Chainable

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L16 "View in source") [Ⓣ][1] +#### @see -(Chainable): Trait class that can inherit any class passed into compose, extended by ChainedMap & ChainedSet +* fluents/chain able/blob/master/src/deps/reduce/clean.js +#### @Since +0.3.0 -### @see +#### Arguments +1. `key=undefined` *(Primitive)*: on a Map: key referencing the value. on a Set: the index -* fluents/chain able/blob/master/src/deps/reduce/clean.js +#### Returns +*(Chainable)*: -### @classProps +#### Example +```js +const chain = new Chain() +chain.set('eh', 1) +chain.get('eh') +// => 1 +chain.delete('eh', 1) +chain.get('eh') +// => undefined -* {parent} -* {className} - +``` --- - - -## `ChainedMapBase.prototype` - - - -🌊 Types: ChainedMapBase.d  +

Chainable.end()

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1119 "View in source") [Ⓣ][1] -🔬 Tests: ChainedMap  +(Function): for ending nested chains -

# ChainedMapBase.prototype.CMC

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L23 "View in source") [Ⓣ][1] -(Chainable): this is to avoid circular requires -because MergeChain & MethodChain extend this -yet .method & .merge use those chains +#### @see +* fluents/chain able/blob/master/src/deps/reduce/clean.js -### @see +#### @Since +0.4.0 -* fluents/chain able/blob/master/src/deps/reduce/clean.js +#### Returns +*(*)*: -### @classProps +#### Example +```js +const parent = 'eh' +const child = newChain(parent) +child.end() +//=> 'eh' -* {meta} meta fn -* {store} main store - +``` +--- -### @extends -Chainable + + -#### Since -4.0.0-alpha.1 +

Chainable.has(keyOrValue=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L15 "View in source") [Ⓣ][1] ---- +(Function): checks whether the store has a value for a given key - - +#### @see -

# ChainedMapBase.prototype.cmc([SuperClass=Chainable])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1972 "View in source") [Ⓣ][1] +* fluents/chain able/blob/master/src/deps/reduce/clean.js -(Composer): ChainedMapBase composer +#### @Since +0.3.0 #### Arguments -1. `[SuperClass=Chainable]` *(Class|Composable|Object)*: class to extend +1. `keyOrValue=undefined` *(any)*: key when Map, value when Set #### Returns -*(Class)*: ChainedMapBase +*(boolean)*: #### Example ```js -const heh = class {} -const composed = ChainedMapBase.compose(heh) -const hehchain = new Composed() -hehchain instanceof heh +const chain = new Chain() +chain.set('eh', 1).has('eh') //=> true +chain.has('canada') +//=> false ``` --- @@ -945,32 +865,27 @@ hehchain instanceof heh -

# ChainedMapBase.prototype.entries([chains=false])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L27 "View in source") [Ⓣ][1] +

Chainable.length()

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1370 "View in source") [Ⓣ][1] -(Function): spreads the entries from ChainedMapBase.store *(Map)* return store.entries, plus all chain properties if they exist +Function -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -0.4.0 +* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Arguments -1. `[chains=false]` *(boolean)*: if true, returns all properties that are chains +#### @Since +0.5.0 #### Returns -*(Object)*: reduced object containing all properties from the store, and when `chains` is true, all instance properties, and recursive chains -
-
-// +*(number)*: #### Example ```js -map.set('a', 'alpha').set('b', 'beta').entries() -//=> {a: 'alpha', b: 'beta'} - +for (var i = 0; i < chain.length; i++) ``` --- @@ -978,63 +893,60 @@ map.set('a', 'alpha').set('b', 'beta').entries() -

# ChainedMapBase.prototype.extend(methods=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1847 "View in source") [Ⓣ][1] +🔬 Tests: iteration  -(Function): shorthand methods, from strings to functions that call .set +

Chainable.prototype[iterator]()

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1074 "View in source") [Ⓣ][1] -#### Since -0.4.0 - -#### Arguments -1. `methods=undefined` *(string[])*: decorates/extends an object with new shorthand functions to get/set - -#### Returns -*(ChainedMapBase)*: @chainable - -#### Example -```js -const chain1 = new Chain() -chain1.extend(['eh']) +(generator): Iterator for looping values in the store -const chain2 = new Chain() -chain2.eh = val => this.set('eh', val) -eq(chain2.eh, chain1.eh) -//=> true +#### @see -``` ---- +* fluents/chain able/blob/master/src/deps/reduce/clean.js - +#### @notes - +* assigned to a variable so buble ignores it + -

# ChainedMapBase.prototype.from(obj=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1803 "View in source") [Ⓣ][1] +#### @Since +0.5.0 -(Function): checks each property of the object calls the chains accordingly +#### Returns +*(Object)*: {value: undefined | any, done: true | false} +#### Example +```js +const chain = new Chain().set('eh', 1) +for (var [key, val] of chain) console.log({ [key]: val }) +//=> {eh: 1} -### @todos +``` +#### Example +```js +*[Symbol.iterator](): void { for (const item of this.store) yield item } +``` +#### Example +```js +const { ChainedSet } = require('chain-able') +const set = new ChainedSet() +set.add('eh') -- [ ] could also add parsing stringified - -#### Since -0.5.0 +for (const arr of set) { + const [key, val] = arr -#### Arguments -1. `obj=undefined` *(Object)*: object with functions to hydrate from + key + //=> 0 -#### Returns -*(Chainable)*: @chainable + val + //=> 'eh' -#### Example -```js -const from = new Chain().from({ eh: true }) -const eh = new Chain().set('eh', true) -eq(from, eh) -// => true + arr.length + //=> 2 +} ``` --- @@ -1043,33 +955,42 @@ eq(from, eh) -

# ChainedMapBase.prototype.get(key=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L27 "View in source") [Ⓣ][1] +

Chainable.prototype[primitive](hint=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L19 "View in source") [Ⓣ][1] + +(Function): symbol method for toString, toJSON, toNumber -(Function): get value for key path in the Map store ❗ `debug` is a special key and is *not* included into .store it goes onto .meta +#### @see -### @see +* fluents/chain able/blob/master/src/deps/reduce/clean.js -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -0.4.0 +#### @Since +1.0.2 #### Arguments -1. `key=undefined` *(Primitive)*: Primitive data key used as map property to reference the value +1. `hint=undefined` *(string)*: enum[default, string, number] #### Returns -*(any)*: value in .store at key +*(Primitive)*: #### Example ```js const chain = new Chain() -chain.set('eh', true) -chain.get('eh') -//=> true +chain.toNumber = () => 1 + chain +//=> 1 +chain + 1 +//=> -chain.get('nope') -//=> undefined +``` +#### Example +```js +const chain = new Chain() +chain.toString = () => 'eh' +chain + '' +//=> 'eh' ``` --- @@ -1078,31 +999,37 @@ chain.get('nope') -

# ChainedMapBase.prototype.set(key=undefined, value=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L25 "View in source") [Ⓣ][1] +

Chainable.values()

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L21 "View in source") [Ⓣ][1] -(Function): sets the value using the key on store adds or updates an element with a specified key and value +(Function): spreads the entries from ChainedMap.store.values allocates a new array, adds the values from the iterator -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -0.4.0 +* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Arguments -1. `key=undefined` *(Primitive)*: Primitive to reference the value -2. `value=undefined` *(any)*: any data to store +#### @notes + +* look at Chainable.constructor to ensure not to use `new Array...` +* moved from ChainedMap and ChainedSet to Chainable @2.0.2 +* this was [...] & Array.from(this.store.values()) + + +#### @Since +0.4.0 #### Returns -*(ChainedMapBase)*: @chainable +*(*): toArr(this.store.values())* #### Example ```js const chain = new Chain() -chain.set('eh', true) -chain.get('eh') -//=> true +chain.set('eh', 1) +chain.values() +//=> [1] ``` --- @@ -1111,48 +1038,25 @@ chain.get('eh') -

# ChainedMapBase.prototype.tap(name=undefined, fn=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L44 "View in source") [Ⓣ][1] - -(Function): tap a value with a function - - -### @see +

Chainable.when(condition=undefined, [trueBrancher=Function], [falseBrancher=Function])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1145 "View in source") [Ⓣ][1] -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -4.0.0-alpha.1 <- moved from transform & shorthands +(Function): when the condition is true, trueBrancher is called, else, falseBrancher is called #### Arguments -1. `name=undefined` *(any|string)*: key to `.get` -2. `fn=undefined` *(Function)*: function to tap with +1. `condition=undefined` *(boolean|string)*: when string, checks this.get +2. `[trueBrancher=Function]` *(Function)*: called when true +3. `[falseBrancher=Function]` *(Function)*: called when false #### Returns -*(Chain)*: @chainable - -#### Example -```js -chain - .set('moose', { eh: true }) - .tap('moose', moose => { - moose.eh = false - return moose - }) - .get('moose') - -// => {eh: false} +*(Chainable)*: @chainable -``` #### Example ```js -const entries = new Chain() - .set('str', 'emptyish') - .tap('str', str => str + '+') - .set('arr', [1]) - .tap('arr', arr => arr.concat([2])) - .entries() - -//=> {str: 'emptyish+', arr: [1, 2]} +const prod = process.env.NODE_ENV === 'production' +chains.when(prod, c => c.set('prod', true), c => c.set('prod', false)) ``` --- @@ -1163,213 +1067,186 @@ const entries = new Chain() -## `ChainedSet` +## `ChainedMapBase` -🌊 Types: ChainedSet.d  - -🔬 Tests: ChainedSet  +* 🌊 Types: ChainedMap.d  +* 🌊 Types: ChainedMapBase.d  -

# ChainedSet

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5593 "View in source") [Ⓣ][1] +🔬 Tests: ChainedMap  -Set +

ChainedMapBase.ComposeChainedMap([SuperClass=ChainedMapBase])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L8393 "View in source") [Ⓣ][1] +(Function): ChainedMap composer -### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js +#### @see -### @notes +* fluents/chain able/blob/master/src/deps/reduce/clean.js -* had Symbol.isConcatSpreadable but it was not useful - +#### @extends +ChainedMapBase -### @todos -- [ ] could add .first .last ? - -### @classProps +#### @Since +0.0.1 -* {store} - +#### Arguments +1. `[SuperClass=ChainedMapBase]` *(Class|Composable|Object)*: class to extend -### @extends -Chainable +#### Returns +*(Class)*: ChainedMap +#### Example +```js +const heh = class {} +const composed = ChainedMap.compose(heh) +const hehchain = new Composed() +hehchain instanceof heh +//=> true +``` --- - - -## `DotProp.prototype` +🌊 Types: ChainedMapBase.d  - +🔬 Tests: ChainedMap  -

# DotProp.prototype.get(key=undefined, [fallback=undefined])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7478 "View in source") [Ⓣ][1] +

ChainedMapBase.ComposeChainedMapBase

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L21 "View in source") [Ⓣ][1] -(Function): dot-prop enabled get +(Chainable): this is to avoid circular requires +because MergeChain & MethodChain extend this +yet .method & .merge use those chains +...also, it serves as a non-references creator for extending new instances of Chainable, where it splits into *(Map | Set)* -> composed prototype decorators -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js +* fluents/chain able/blob/master/src/deps/reduce/clean.js -### @todos +#### @classProps -- [ ] dot-prop on non-store instance.property when using nested chains... +* {meta} meta fn +* {store} main store -#### Since -3.0.1 - -#### Arguments -1. `key=undefined` *(Primitive)*: dot prop key, or any primitive key -2. `[fallback=undefined]` *(any)*: fallback value, if it cannot find value with key path - -#### Returns -*(any)*: value for path, or fallback value if provided -#### Example -```js -chain.set('moose.simple', 1) -//=> Chain +#### @extends +Chainable -chain.get('moose.simple') -//=>1 -chain.get('moose') -//=> {simple: 1} -``` -#### Example -```js -//also works with an array (moose.simple) -chain.get(['moose', 'simple']) -//=> 1 +#### @Since +4.0.0-alpha.1 -``` --- -

# DotProp.prototype.set

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7420 "View in source") [Ⓣ][1] - -unknown +

ChainedMapBase.cmc([Target=Chainable])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2940 "View in source") [Ⓣ][1] +(Composer): ChainedMapBase composer -### @see +#### Arguments +1. `[Target=Chainable]` *(Class|Composable|Object)*: class to extend -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -3.0.1 +#### Returns +*(Class)*: ChainedMapBase #### Example ```js -const chain = new Target() - -chain.set('moose.simple', 1) -//=> Target store:Map: { moose: { simple: 1 } } +const heh = class {} +const composed = ChainedMapBase.compose(heh) +const hehchain = new Composed() +hehchain instanceof heh +//=> true ``` --- - - -## `FactoryChain.prototype` - - +

ChainedMapBase.entries([chains=false])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L21 "View in source") [Ⓣ][1] -🌊 Types: FactoryChain.d  +(Function): spreads the entries from ChainedMapBase.store *(Map)* return store.entries, plus all chain properties if they exist -🔬 Tests: FactoryChain  -

# FactoryChain.prototype.FactoryChain

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7 "View in source") [Ⓣ][1] +#### @see -Map +* fluents/chain able/blob/master/src/deps/reduce/clean.js +#### @Since +0.4.0 -### @classProps +#### Arguments +1. `[chains=false]` *(boolean)*: if true, returns all properties that are chains -* {data} -* {_calls} - - -### @extends -ChainedMapBase +#### Returns +*(Object)*: reduced object containing all properties from the store, and when `chains` is true, all instance properties, and recursive chains +
+
+// +#### Example +```js +map.set('a', 'alpha').set('b', 'beta').entries() +//=> {a: 'alpha', b: 'beta'} +``` --- -

# FactoryChain.prototype.chainUpDowns(methods=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5758 "View in source") [Ⓣ][1] - -(Function): chain back up to parent for any of these +

ChainedMapBase.extend(methods=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2815 "View in source") [Ⓣ][1] +(Function): shorthand methods, from strings to functions that call .set -### @todos -- [ ] should have a debug log for this - -#### Since -2.0.0 +#### @Since +0.4.0 #### Arguments -1. `methods=undefined` *(string[])*: methods to trigger `onChainUpDown` on +1. `methods=undefined` *(string[])*: decorates/extends an object with new shorthand functions to get/set #### Returns -*(FactoryChain)*: @chainable +*(ChainedMapBase)*: @chainable #### Example ```js -const { Chain, FactoryChain, ChainedSet } = require('chain-able') - -class Things extends Chain { - constructor(parent) { - super(parent) - this.people = new ChainedSet(this) - } - person() { - const person = new FactoryChain(this) - person - .props(['name', 'age', 'email']) - .onChainUpDown(this.person) - .chainUpDowns(['person']) - .onDone(personChain => { - this.people.add(personChain) - return this - }) +const chain1 = new Chain() +chain1.extend(['eh']) - return person - } -} +const chain2 = new Chain() +chain2.eh = val => this.set('eh', val) -const things = new Things() -const returned = things - .person() - .name('sue') - .person() - .age(100) - .name('john') - .email('@') +eq(chain2.eh, chain1.eh) +//=> true ``` --- @@ -1378,53 +1255,72 @@ const returned = things -

# FactoryChain.prototype.factory([obj={}])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5908 "View in source") [Ⓣ][1] +

ChainedMapBase.from(obj=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2771 "View in source") [Ⓣ][1] -(Function): creates/add the `.end` method, which checks how many methods have been called, and decides whether to return parent or not +(Function): checks each property of the object calls the chains accordingly -#### Since -2.0.0 + +#### @todos + +- [ ] could also add parsing stringified + + +#### @Since +0.5.0 #### Arguments -1. `[obj={}]` *(Object)*: optional object to use for creating .end +1. `obj=undefined` *(Object)*: object with functions to hydrate from #### Returns -*(FactoryChain)*: @chainable +*(Chainable)*: @chainable + +#### Example +```js +const from = new Chain().from({ eh: true }) +const eh = new Chain().set('eh', true) +eq(from, eh) +// => true +``` --- -

# FactoryChain.prototype.getData([prop=undefined])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5889 "View in source") [Ⓣ][1] +

ChainedMapBase.get(key=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L20 "View in source") [Ⓣ][1] -(Function): access data being built when stepping through a factory +(Function): get value for key path in the Map store ❗ `debug` is a special key and is *not* included into .store it goes onto .meta -#### Since -2.0.0 + +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @Since +0.4.0 #### Arguments -1. `[prop=undefined]` *(Primitive)*: key of the data, or returns all data +1. `key=undefined` *(Primitive)*: Primitive data key used as map property to reference the value #### Returns -*(any)*: this.data +*(any)*: value in .store at key #### Example ```js -.data['prop'] = 'eh' - .getData('prop') - //=> 'eh' - .getData() - //=> {prop: 'eh'} -``` -#### Example -```js -const person = new FactoryChain(this) -const age = person.props(['name', 'age']).age(10).getData('age') -expect(age).toBe(10) +const chain = new Chain() +chain.set('eh', true) +chain.get('eh') +//=> true + +chain.get('nope') +//=> undefined ``` --- @@ -1433,29 +1329,34 @@ expect(age).toBe(10) -

# FactoryChain.prototype.prop(name=undefined, [onCall=undefined])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5829 "View in source") [Ⓣ][1] +

ChainedMapBase.set(key=undefined, value=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L19 "View in source") [Ⓣ][1] -(Function): add property that are counted towards the call count for easy auto-ending chaining +(Function): sets the value using the key on store adds or updates an element with a specified key and value -#### Since -2.0.0 + +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @Since +0.4.0 #### Arguments -1. `name=undefined` *(Primitive)*: property name -2. `[onCall=undefined]` *(||Function)*: callback for the property +1. `key=undefined` *(Primitive)*: Primitive to reference the value +2. `value=undefined` *(any)*: any data to store #### Returns -*(FactoryChain)*: @chainable +*(ChainedMapBase)*: @chainable #### Example ```js -person - //.prop also accepts an optional callback, - //for nestable nestable chains - .prop('name') - .prop('age') - .prop('email') +const chain = new Chain() +chain.set('eh', true) +chain.get('eh') +//=> true ``` --- @@ -1464,41 +1365,51 @@ person -

# FactoryChain.prototype.props(names=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5801 "View in source") [Ⓣ][1] +

ChainedMapBase.tap(name=undefined, fn=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L23 "View in source") [Ⓣ][1] -(Function): adds an *array* of properties, using FactoryChain.prop +(Function): tap a value with a function -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -2.0.0 +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @Since +4.0.0-alpha.1 <- moved from transform & shorthands #### Arguments -1. `names=undefined` *(string[])*: property names +1. `name=undefined` *(any|string)*: key to `.get` +2. `fn=undefined` *(Function)*: function to tap with #### Returns -*(FactoryChain)*: @chainable +*(Chain)*: @chainable #### Example ```js -person.props(['name', 'age', 'email']) - -typeof person.name -//=> 'function' +chain + .set('moose', { eh: true }) + .tap('moose', moose => { + moose.eh = false + return moose + }) + .get('moose') -person.name().age() -//=> FactoryChain +// => {eh: false} -person.name().age().email() -//=> ParentChain +``` +#### Example +```js +const entries = new Chain() + .set('str', 'emptyish') + .tap('str', str => str + '+') + .set('arr', [1]) + .tap('arr', arr => arr.concat([2])) + .entries() -// person.name().age().person() -//=> FactoryChain -//^ because .person is `chainUpDowns` -//^ so it finishes the old chain, and begins a new one +//=> {str: 'emptyish+', arr: [1, 2]} ``` --- @@ -1509,35 +1420,44 @@ person.name().age().email() -## `MergeChain.prototype` +## `ChainedSet` -🔬 Tests: MergeChain  +🌊 Types: ChainedSet.d  -

# MergeChain.prototype.MergeChain

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L12 "View in source") [Ⓣ][1] +🔬 Tests: ChainedSet  -Map +

ChainedSet.ChainedSet

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L8516 "View in source") [Ⓣ][1] +Set -### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js +#### @see -### @todos +* fluents/chain able/blob/master/src/deps/reduce/clean.js -- [ ] consider just making this a function, - because 80/20 onValue merger & onExisting - are rarely used & are easily overridable with .merge +#### @notes + +* had Symbol.isConcatSpreadable but it was not useful -### @extends -ChainedMapBase +#### @todos + +- [ ] could add .first .last ? + +#### @classProps + +* {store} + + +#### @extends +Chainable -#### Since -1.0.0 --- @@ -1545,37 +1465,35 @@ ChainedMapBase -

# MergeChain.prototype.init(opts=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5199 "View in source") [Ⓣ][1] +

ChainedSet.add(value=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L19 "View in source") [Ⓣ][1] -(Function): options for merging with dopemerge +(Function): appends a new element with a specified value to the end of the .store -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -1.0.2 +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @Since +0.4.0 #### Arguments -1. `opts=undefined` *(Function|Object)*: when object: options for the merger. when function: is the merger +1. `value=undefined` *(any)*: any value to add to **end** of the store #### Returns -*(MergeChain)*: @chainable +*(ChainedSet)*: @chainable #### Example ```js -{ - stringToArray: true, - boolToArray: false, - boolAsRight: true, - ignoreTypes: ['null', 'undefined', 'NaN'], - debug: false, - } -``` -#### Example -```js -.merger(require('lodash.mergewith')()) +const people = new ChainedSet() +people.add('sam').add('sue') + +for (let name of people) console.log(name) +//=> sam, sue + ``` --- @@ -1583,96 +1501,1425 @@ ChainedMapBase -

# MergeChain.prototype.MergeChain_1

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5447 "View in source") [Ⓣ][1] +

ChainedSet.merge(arr=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L8600 "View in source") [Ⓣ][1] -unknown +(Function): merge any Array/Set/Iteratable/Concatables into the array, at the end -#### Since -0.9.0 + +#### @Since +0.4.0 + +#### Arguments +1. `arr=undefined` *(Array|Concatable|Set)*: values to merge in and append + +#### Returns +*(ChainedSet)*: @chainable #### Example ```js -const { Chain, MergeChain } = require('chain-able') +const people = new ChainedSet() +people.add('sam').add('sue').prepend('first').merge(['merged']) -const chain = new Chain().set('str', 'stringy') +for (let name of people) console.log(name) +//=> first, sam, sue, merged -MergeChain.init(chain).onExisting((a, b) => a + b).merge({ str: '+' }) +``` +--- + + + + + +

ChainedSet.prepend(value=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L8574 "View in source") [Ⓣ][1] + +(Function): inserts the value at the **beginning** of the Set + + +#### @Since +0.4.0 + +#### Arguments +1. `value=undefined` *(any)*: any value to add to **beginning** the store + +#### Returns +*(ChainedSet)*: @chainable + +#### Example +```js +const people = new ChainedSet() +people.add('sue').prepend('first') + +for (let name of people) console.log(name) +//=> first, sue + +``` +--- + + + + + + + +## `DotProp` + + + +

DotProp.get(key=undefined, [fallback=undefined])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L10478 "View in source") [Ⓣ][1] + +(Function): dot-prop enabled get + + +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @todos + +- [ ] dot-prop on non-store instance.property when using nested chains... + + +#### @Since +3.0.1 + +#### Arguments +1. `key=undefined` *(Primitive)*: dot prop key, or any primitive key +2. `[fallback=undefined]` *(any)*: fallback value, if it cannot find value with key path + +#### Returns +*(any)*: value for path, or fallback value if provided + +#### Example +```js +chain.set('moose.simple', 1) +//=> Chain + +chain.get('moose.simple') +//=>1 + +chain.get('moose') +//=> {simple: 1} + +``` +#### Example +```js +//also works with an array (moose.simple) +chain.get(['moose', 'simple']) +//=> 1 + +``` +--- + + + + + +

DotProp.set

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L10420 "View in source") [Ⓣ][1] + +unknown + + +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @Since +3.0.1 + +#### Example +```js +const chain = new Target() + +chain.set('moose.simple', 1) +//=> Target store:Map: { moose: { simple: 1 } } + +``` +--- + + + + + + + +## `FactoryChain` + + + +🌊 Types: FactoryChain.d  + +🔬 Tests: FactoryChain  + +

FactoryChain.FactoryChain

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7 "View in source") [Ⓣ][1] + +Map + + +#### @classProps + +* {data} +* {_calls} + + +#### @extends +ChainedMapBase + + +--- + + + + + +

FactoryChain.chainUpDowns(methods=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L8701 "View in source") [Ⓣ][1] + +(Function): chain back up to parent for any of these + + +#### @todos + +- [ ] should have a debug log for this + + +#### @Since +2.0.0 + +#### Arguments +1. `methods=undefined` *(string[])*: methods to trigger `onChainUpDown` on + +#### Returns +*(FactoryChain)*: @chainable + +#### Example +```js +const { Chain, FactoryChain, ChainedSet } = require('chain-able') + +class Things extends Chain { + constructor(parent) { + super(parent) + this.people = new ChainedSet(this) + } + person() { + const person = new FactoryChain(this) + person + .props(['name', 'age', 'email']) + .onChainUpDown(this.person) + .chainUpDowns(['person']) + .onDone(personChain => { + this.people.add(personChain) + return this + }) + + return person + } +} + +const things = new Things() +const returned = things + .person() + .name('sue') + .person() + .age(100) + .name('john') + .email('@') + +``` +--- + + + + + +

FactoryChain.factory([obj={}])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L8851 "View in source") [Ⓣ][1] + +(Function): creates/add the `.end` method, which checks how many methods have been called, and decides whether to return parent or not + + +#### @Since +2.0.0 + +#### Arguments +1. `[obj={}]` *(Object)*: optional object to use for creating .end + +#### Returns +*(FactoryChain)*: @chainable + +--- + + + + + +

FactoryChain.getData([prop=undefined])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L8832 "View in source") [Ⓣ][1] + +(Function): access data being built when stepping through a factory + + +#### @Since +2.0.0 + +#### Arguments +1. `[prop=undefined]` *(Primitive)*: key of the data, or returns all data + +#### Returns +*(any)*: this.data + +#### Example +```js +.data['prop'] = 'eh' + .getData('prop') + //=> 'eh' + .getData() + //=> {prop: 'eh'} +``` +#### Example +```js +const person = new FactoryChain(this) +const age = person.props(['name', 'age']).age(10).getData('age') +expect(age).toBe(10) + +``` +--- + + + + + +

FactoryChain.prop(name=undefined, [onCall=undefined])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L8772 "View in source") [Ⓣ][1] + +(Function): add property that are counted towards the call count for easy auto-ending chaining + + +#### @Since +2.0.0 + +#### Arguments +1. `name=undefined` *(Primitive)*: property name +2. `[onCall=undefined]` *(||Function)*: callback for the property + +#### Returns +*(FactoryChain)*: @chainable + +#### Example +```js +person + //.prop also accepts an optional callback, + //for nestable nestable chains + .prop('name') + .prop('age') + .prop('email') + +``` +--- + + + + + +

FactoryChain.props(names=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L8744 "View in source") [Ⓣ][1] + +(Function): adds an *array* of properties, using FactoryChain.prop + + +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @Since +2.0.0 + +#### Arguments +1. `names=undefined` *(string[])*: property names + +#### Returns +*(FactoryChain)*: @chainable + +#### Example +```js +person.props(['name', 'age', 'email']) + +typeof person.name +//=> 'function' + +person.name().age() +//=> FactoryChain + +person.name().age().email() +//=> ParentChain + +// person.name().age().person() +//=> FactoryChain +//^ because .person is `chainUpDowns` +//^ so it finishes the old chain, and begins a new one + +``` +--- + + + + + + + +## `MergeChain` + + + +🔬 Tests: MergeChain  + +

MergeChain.MergeChain

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L12 "View in source") [Ⓣ][1] + +Map + + +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @todos + +- [ ] consider just making this a function, + because 80/20 onValue merger & onExisting + are rarely used & are easily overridable with .merge + + +#### @extends +ChainedMapBase + + + +#### @Since +1.0.0 + +--- + + + + + +

MergeChain.init(opts=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L8102 "View in source") [Ⓣ][1] + +(Function): options for merging with dopemerge + + +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @Since +1.0.2 + +#### Arguments +1. `opts=undefined` *(Function|Object)*: when object: options for the merger. when function: is the merger + +#### Returns +*(MergeChain)*: @chainable + +#### Example +```js +{ + stringToArray: true, + boolToArray: false, + boolAsRight: true, + ignoreTypes: ['null', 'undefined', 'NaN'], + debug: false, + } +``` +#### Example +```js +.merger(require('lodash.mergewith')()) +``` +--- + + + + + +

MergeChain.MergeChain_1

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L8351 "View in source") [Ⓣ][1] + +unknown + + +#### @Since +0.9.0 + +#### Example +```js +const { Chain, MergeChain } = require('chain-able') + +const chain = new Chain().set('str', 'stringy') + +MergeChain.init(chain).onExisting((a, b) => a + b).merge({ str: '+' }) + +chain.get('str') +//=> 'stringy+' + +``` +--- + + + + + + + +## `MethodChain` + + + +🌊 Types: MethodChain.d  + +🔬 Tests: MethodChain  + +

MethodChain.MethodChain

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7304 "View in source") [Ⓣ][1] + +(Map): ❗ using `+` will call `.build()` in a shorthand fashion + + +#### @todos + +- [ ] maybe abstract the most re-usable core as a protected class + so the shorthands could be used, and more functionality made external +- [ ] need to separate schema from here as external functionality & add .add +- [ ] .prop - for things on the instance, not in the store? + !!! .sponge - absorn properties into the store + + +#### @extends +ChainedMap + + + +#### @Since +4.0.0 + +--- + + + + + +

MethodChain._build(name=undefined, parent=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7642 "View in source") [Ⓣ][1] + +Function + + +#### @notes + +* scoping here adding default functions have to rescope arguments + + +#### @todos + +- [ ] allow config of method var in plugins since it is scoped... +- [ ] add to .meta(shorthands) +- [ ] reduce complexity if perf allows + + +#### @Since +4.0.0-alpha.1 + +#### Arguments +1. `name=undefined` *(Primitive)*: +2. `parent=undefined` *(Object)*: + +#### Returns +*(void)*: + +--- + + + + + +

MethodChain._defaults(name=undefined, parent=undefined, built=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7602 "View in source") [Ⓣ][1] + +Function + + +#### @todos + +- [ ] optimize the size of this + with some bitwise operators + hashing the things that have been defaulted + also could be plugin + + +#### @Since +4.0.0 + +#### Arguments +1. `name=undefined` *(Primitive)*: method name +2. `parent=undefined` *(Object)*: being decorated +3. `built=undefined` *(Object)*: method being built + +#### Returns +*(void)*: + +#### Example +```js +._defaults('', {}, {}) +``` +#### Example +```js +let methodFactories + + ### `onSet` + + > defaults to `this.set(key, value)` + + ```ts + public onSet(fn: Fn): MethodChain + ``` + + ### `onCall` + + > defaults to .onSet ^ + + ```ts + public onCall(fn: Fn): MethodChain + ``` + + ### `onGet` + + > defaults to `this.get(key)` + + ```ts + public onGet(fn: Fn): MethodChain + ``` +``` +--- + + + + + +

MethodChain.autoGetSet(name=undefined, parent=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7039 "View in source") [Ⓣ][1] + +Function + + +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js +#### Arguments +1. `name=undefined` *(Primitive)*: method name being built +2. `parent=undefined` *(Object)*: parent containing the method + +#### Returns +*(MethodChain)*: @chainable + +#### Example +```js +const chain = new Chain() +chain.methods('eh').plugin(autoGetSet).build() + +chain.eh(1) +//=> Chain +chain.eh() +//=> 1 + +``` +--- + + + + + +

MethodChain.autoIncrement()

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7948 "View in source") [Ⓣ][1] + +(Function): adds a plugin to increment the value on every call + + +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @Since +0.4.0 + +#### Returns +*(MethodChain)*: @chainable + +#### Example +```js +chain.methods(['index']).autoIncrement().build().index().index(+1).index() +chain.get('index') +//=> 3 + +``` +--- + + + + + +

MethodChain.build([returnValue=undefined])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7528 "View in source") [Ⓣ][1] + +(Function): set the actual method, also need .context - use .parent + + +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @todos + +- [ ] if passing in a name that already exists, operations are decorations... (partially done) + + +#### @Since +4.0.0 + +#### Arguments +1. `[returnValue=undefined]` *(any)*: returned at the end of the function for ease of use + +#### Returns +*(MethodChain)*: @chainable + +#### Example +```js +var obj = {} +const one = new MethodChain(obj).methods('eh').getSet().build(1) +//=> 1 + +typeof obj.getEh +//=> 'function' + +``` +--- + + + + + +

MethodChain.decorate(parentToDecorate=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6980 "View in source") [Ⓣ][1] + +(Function): decorates a parent when the argument is provided +BUT THE FUNCTIONS WILL STILL BE SCOPED TO CURRENT PARENT +for easy factory chaining + + +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @todos + +- [ ] this is more like a preset since it *adds* plugins? + more of methodFactory now + + +#### @Since +4.0.0-alpha.1 + +#### Arguments +1. `parentToDecorate=undefined` *(Object)*: object to put the method on instead + +#### Returns +*(MethodChain)*: @chainable + +#### Example +```js +const chain = new Chain() +const obj = {} +chain.method('ehOh').decorate(obj).build() +typeof obj.ehOh +//=> 'function' + +``` +--- + + + + + +

MethodChain.decorate([parentToDecorate=undefined])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7917 "View in source") [Ⓣ][1] + +(Function): add methods to the parent for easier chaining + + +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js +#### Arguments +1. `[parentToDecorate=undefined]` *(Object)*: decorate a specific parent shorthand + +#### Returns +*(ChainedMap)*: @chainable + +#### Example +```js +var obj = {} +new MethodChain({}).name('eh').decorate(obj).build() +typeof obj.eh +//=> 'function' + +``` +#### Example +```js +class Decorator extends Chain { + constructor(parent) { + super(parent) + this.methods(['easy']).decorate(parent).build() + this.methods('advanced') + .onCall(this.advanced.bind(this)) + .decorate(parent) + .build() + } + advanced(arg) { + this.set('advanced', arg) + return this.parent + } + easy(arg) { + this.parent.set('easy-peasy', arg) + } +} + +class Master extends Chain { + constructor(parent) { + super(parent) + this.eh = new Decorator(this) + } +} + +const master = new Master() + +master.get('easy-peasy') +//=> true + +master.eh.get('advanced') +//=> 'a+' + +``` +#### Example +```js +;+chain.method('ehOh').decorate(null) +//=> @throws Error('must provide parent argument') + +``` +--- + + + + + +

MethodChain.name(methods=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7420 "View in source") [Ⓣ][1] + +(Function): setup methods to build + +#### Arguments +1. `methods=undefined` *(Object|string|string[])*: method names to build + +#### Returns +*(MethodChain)*: @chainable + +#### Example +```js +var obj = {} +new MethodChain(obj).name('eh').build() +typeof obj.eh +//=> 'function' + +``` +--- + + + + + +

MethodChain.schema(obj=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7503 "View in source") [Ⓣ][1] + +(Function): an object that contains nestable `.type`s +they are recursively *(using an optimized traversal cache)* mapped to validators +❗ this method auto-calls .build, all other method config calls should be done before it + + +#### @todos + +- [ ] link to `deps/is` docs +- [ ] move out into a plugin to show how easy it is to use a plugin + and make it able to be split out for size when needed +- [ ] inherit properties (in plugin, for each key) + from this for say, dotProp, getSet +- [ ] very @important + that we setup schema validation at the highest root for validation + and then have some demo for how to validate on set using say mobx + observables for all the way down... + + +#### @Since +4.0.0 + +#### Arguments +1. `obj=undefined` *(Object)*: schema + +#### Returns +*(MethodChain)*: @chainable + +#### Example +```js +chain + .methods() + .define() + .getSet() + .onInvalid((error, arg, instance) => console.log(error)) + .schema({ + id: '?number', + users: '?object|array', + topic: '?string[]', + roles: '?array', + creator: { + name: 'string', + email: 'email', + id: 'uuid', + }, + created_at: 'date', + updated_at: 'date|date[]', + summary: 'string', + }) + +//--- valid +chain.created_at = new Date() +chain.setCreatedAt(new Date()) + +isDate(chain.created_at) === true + +//--- nestable validation 👍 +chain.merge({ creator: { name: 'string' } }) + +//--- invalid +chain.updated_at = false + +``` +--- + + + + + + + +## `Observe` + + + +

Observe.observe(properties=undefined, fn=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L37 "View in source") [Ⓣ][1] + +(Function): observe properties when they change + + +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @todos + +- [ ] gotta update `data` if `deleting` too... +- [ ] un-observe +- [ ] should hash these callback properties +- [ ] just throttle the `.set` to allow easier version of .commit + +#### Arguments +1. `properties=undefined` *(Matchable)*: Matchable properties to observe +2. `fn=undefined` *(Function)*: onChanged + +#### Returns +*(Target)*: @chainable + +#### Example +```js +const Target = require('chain-able') + +const chain = new Target() +const log = arg => console.log(arg) + +chain.extend(['eh']).observe('eh', data => log(data)).eh(true) +//=> {eh: true} + +``` +#### Example +```js +chain + .extend(['canada', 'timbuck']) + .observe(['canad*'], data => console.log(data.canada)) + .canada(true) + .canada(true) + .timbuck(false) + +//=> true +//=> false + +// only called when changed, +// otherwise it would be 2 `true` & 1 `false` + +``` +--- + + + + + +🔬 Tests: DotProp  + +

Observe.DotProp(Target=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L10367 "View in source") [Ⓣ][1] + +Function + + +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @extends +ChainedMap + + +#### Arguments +1. `Target=undefined` *(Class|Composable)*: composable class + +#### Returns +*(DotProp)*: class + +#### Example +```js +const { compose } = require('chain-able') +const { DotProp } = compose +new DotProp() +//=> DotProp + +``` +#### Example +```js +const chain = new Chain() + +chain.set('moose.simple', 1) +//=> Chain + +chain.get('moose.simple') +//=>1 + +chain.get('moose') +//=> {simple: 1} + +chain.set('moose.canada.eh', true).set('moose.canada.igloo', true) +//=> Chain + +//set, has, get, delete :-) +chain.delete('moose.canada.eh') +//=> Chain + +//also works with an array (moose.canada.igloo) +chain.get(['moose', 'canada', 'igloo']) +//=> true + +``` +--- + + + + + +🔬 Tests: observe  + +

Observe.Observe(Target=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L21 "View in source") [Ⓣ][1] + +(Function): > subscribe to changes ❗ called only on **change** observers are only called when data they subscribe to changes + + +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @extends + +* ChainedMap +* DotProp + + + +#### @Since +3.0.1 + +#### Arguments +1. `Target=undefined` *(Class|Composable)*: composable class + +#### Returns +*(Observe)*: class + +#### Example +```js +const { compose } = require('chain-able') +const { DotProp } = compose +new DotProp() +//=> DotProp + +``` +--- + + + + + + + +## `ShorthandChain` + + + +

ShorthandChain.return(value=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L9494 "View in source") [Ⓣ][1] + +(Function): returns any value passed in return a value at the end of a chain regardless + + +#### @Since +3.0.0 + +#### Arguments +1. `value=undefined` *(any)*: value to return at the end of a chain + +#### Returns +*(any)*: value + +#### Example +```js +const chain = new Chain() + +const saveAndDebug = env => + chain.from({ env: env.NODE_ENV }).return(JSON.stringify(env)) + +console.log(saveAndDebug(process.env)) +//=> value of process.env + +``` +--- + + + + + +

ShorthandChain.setIfEmpty(name=undefined, value=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L9468 "View in source") [Ⓣ][1] + +(Function): sets a value **only** when .has is false aka set if the value has not been set + + +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @Since +1.0.2 + +#### Arguments +1. `name=undefined` *(Primitive)*: key to set if it has not been done so already +2. `value=undefined` *(any)*: value to set when key has not been already set + +#### Returns +*(ShorthandChain)*: @chainable + +#### Example +```js +const chain = new Chain() + +chain.set('eh', true) + +// eh is already set ^, ignored +chain.setIfEmpty('eh', false) + +chain.get('eh') +//=> true + +``` +#### Example +```js +new Chain().setIfEmpty('canada', true).entries() +//=> {canada: true} + +``` +#### Example +```js +// longhand way to do the same thing +if (chain.has('eh') === false) { + chain.set('eh', false) +} + +// or using .when +chain.when(!chain.has('eh'), instance => instance.set('eh', false)) + +``` +--- + + + + + +

ShorthandChain.wrap(fn=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L9527 "View in source") [Ⓣ][1] + +(Function): wrap a value, if it's a Function call it, return this aka execute something and return this + + +#### @Since +2.0.0 + +#### Arguments +1. `fn=undefined` *(Function|any)*: function to call, or just any value + +#### Returns +*(ShorthandChain)*: @chainable + +#### Example +```js +const { eh } = chain.wrap(chain => (chain.eh = true)) +//=> true + +``` +#### Example +```js +new Chain() + .wrap( + encased => + (encased.fn = arg => { + throw new Error('encased yo') + }) + ) + .method('fn') + .encase() + .catch(error => { + //=> Error('encasedYo') + }) + .build() + .fn(true) + +``` +--- + + + + + + + +## `Transform` + + + +

Transform(Target=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L9916 "View in source") [Ⓣ][1] + +Function + +#### Arguments +1. `Target=undefined` *(Class|Composable)*: composable class + +#### Returns +*(TransformChain)*: class + +#### Example +```js +compose(class {}) +//=> TransformChain + +``` +--- + + + + + + + +## `TransformChain` + + + +🔬 Tests: TransformChain  + +

TransformChain.

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L11 "View in source") [Ⓣ][1] -chain.get('str') -//=> 'stringy+' +Map -``` ---- - +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @symb + +🤖 + +#### @extends +ChainedMap + + +--- -## `MethodChain.prototype` +

TransformChain.remap(from=undefined, [to=undefined])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L10112 "View in source") [Ⓣ][1] - +(Function): remap properties from `1` to another, for example, apis with inconsistent naming -🌊 Types: MethodChain.d  -🔬 Tests: MethodChain  +#### @see -

# MethodChain.prototype.MethodChain

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4410 "View in source") [Ⓣ][1] +* fluents/chain able/blob/master/src/deps/reduce/clean.js -(Map): ❗ using `+` will call `.build()` in a shorthand fashion +#### @symb +🗺 -### @todos +#### @Since +1.0.0 -- [ ] maybe abstract the most re-usable core as a protected class - so the shorthands could be used, and more functionality made external -- [ ] need to separate schema from here as external functionality & add .add -- [ ] .prop - for things on the instance, not in the store? - !!! .sponge - absorn properties into the store - +#### Arguments +1. `from=undefined` *(Object|string)*: property name string, or {[from]: to} +2. `[to=undefined]` *(string)*: property name to change key to -### @extends -ChainedMap +#### Returns +*(Chain)*: @chainable + +#### Example +```js +chain.remap('dis', 'dat').from({ dis: true }) +chain.entries() +//=> {dat: true} -#### Since -4.0.0 +``` +#### Example +```js +chain + .remap({dis: 'dat'}) + .from({dis: 1, other: true}} + chain.entries() + //=> {dist: 1, other: true} +``` --- -

# MethodChain.prototype._build(name=undefined, parent=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4748 "View in source") [Ⓣ][1] +

TransformChain.set(key=undefined, val=undefined, dotPropKey=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L10024 "View in source") [Ⓣ][1] Function -### @notes - -* scoping here adding default functions have to rescope arguments - +#### @see -### @todos +* fluents/chain able/blob/master/src/deps/reduce/clean.js -- [ ] allow config of method var in plugins since it is scoped... -- [ ] add to .meta(shorthands) -- [ ] reduce complexity if perf allows - -#### Since -4.0.0-alpha.1 +#### @Since +1.0.0 #### Arguments -1. `name=undefined` *(Primitive)*: -2. `parent=undefined` *(Object)*: +1. `key=undefined` *(Primitive)*: key to set with +2. `val=undefined` *(any)*: value to set for key +3. `dotPropKey=undefined` *(|string|string[])*: special key used for initializing dot prop values in an optimized way to keep reference #### Returns -*(void)*: +*(Chainable)*: @chainable --- @@ -1680,61 +2927,149 @@ Function -

# MethodChain.prototype._defaults(name=undefined, parent=undefined, built=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4708 "View in source") [Ⓣ][1] +

TransformChain.transform(key=undefined, value=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L10006 "View in source") [Ⓣ][1] Function -### @todos +#### @todos -- [ ] optimize the size of this - with some bitwise operators - hashing the things that have been defaulted - also could be plugin +- [ ] dot-prop here -#### Since -4.0.0 + +#### @Since +1.0.2 #### Arguments -1. `name=undefined` *(Primitive)*: method name -2. `parent=undefined` *(Object)*: being decorated -3. `built=undefined` *(Object)*: method being built +1. `key=undefined` *(Function|string)*: currently just string +2. `value=undefined` *(Function)*: callback accepting the value as only arg to transform with #### Returns -*(void)*: +*(TransformChain)*: @chainable #### Example ```js -._defaults('', {}, {}) +// coerce values with .id into the value they hold +chain.transform('dis', val => (typeof val === 'string' ? val : val.id)) + +chain.set('dis', 'eh') +chain.get('dis') +//=> 'eh' + +chain.set('dis', { id: 'eh' }) +chain.get('dis') +//=> 'eh' + ``` #### Example ```js -let methodFactories +import { format } from 'date-fns/esm' +import { Chain } from 'chain-able' - ### `onSet` +const chain = new Chain() +chain.transform('created_at', date => format(date, 'MM/DD/YYYY')) +chain.set('created_at', new Date()) - > defaults to `this.set(key, value)` +// is formatted human-readable pretty! +const { created_at } = chain.entries() +//=> '02/11/2014' - ```ts - public onSet(fn: Fn): MethodChain - ``` +``` +--- - ### `onCall` + - > defaults to .onSet ^ + - ```ts - public onCall(fn: Fn): MethodChain - ``` + - ### `onGet` +## `Traverse` - > defaults to `this.get(key)` + - ```ts - public onGet(fn: Fn): MethodChain - ``` +🌊 Types: TraverseChain.d  + +🔬 Tests: TraverseChain  + +

Traverse.TraverseChain

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L9726 "View in source") [Ⓣ][1] + +Map + + +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @symb + +👣 + +#### @classProps + +* {obj} +* {keys} +* {vals} +* {onMatch} +* {onNonMatch} +* {clone} + + +#### @extends +ChainedMapBase + + + +#### @Since +1.0.0 + +--- + + + + + +

Traverse.checkIteratable(node=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4720 "View in source") [Ⓣ][1] + +(Function): checks whether a node is iteratable + + +#### @todos + +- [ ] move into the wrapper? if perf allows? + +#### Arguments +1. `node=undefined` *(*)*: value to check + +#### Returns +*(void)*: + +#### Example +```js +.checkIteratable({eh: true}) + //=> this.isLeaf = false + //=> this.isCircular = false + //=> this.isIteratable = true + + .checkIteratable({} || []) + //=> this.isLeaf = true + //=> this.isCircular = false + //=> this.isIteratable = false + + var circular = {} + circular.circular = circular + .checkIteratable(circular) + //=> this.isLeaf = false + //=> this.isCircular = true + //=> this.isIteratable = true ``` --- @@ -1742,31 +3077,43 @@ let methodFactories -

# MethodChain.prototype.autoGetSet(name=undefined, parent=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4183 "View in source") [Ⓣ][1] +

Traverse.clone(arg=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5218 "View in source") [Ⓣ][1] -Function +(Function): clone any value + + +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @extends + +* undefined +* undefined -### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js +#### @Since +4.0.0 + #### Arguments -1. `name=undefined` *(Primitive)*: method name being built -2. `parent=undefined` *(Object)*: parent containing the method +1. `arg=undefined` *(*)*: argument to clone #### Returns -*(MethodChain)*: @chainable +*(*)*: cloned value #### Example ```js -const chain = new Chain() -chain.methods('eh').plugin(autoGetSet).build() +var obj = { eh: true } +clone(obj) === obj //=> false -chain.eh(1) -//=> Chain -chain.eh() -//=> 1 +var obj = { eh: true } +var obj2 = clone(obj) +obj.eh = false +console.log(obj2.eh) //=> true ``` --- @@ -1775,26 +3122,33 @@ chain.eh() -

# MethodChain.prototype.autoIncrement()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5054 "View in source") [Ⓣ][1] +

Traverse.copy(src=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3729 "View in source") [Ⓣ][1] + +(Function): copy any primitive value, part of clone -(Function): adds a plugin to increment the value on every call +#### @see -### @see +* fluents/chain able/blob/master/src/deps/reduce/clean.js -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -0.4.0 +#### @Since +3.0.0 + +#### Arguments +1. `src=undefined` *(*)*: value to copy #### Returns -*(MethodChain)*: @chainable +*(*)*: copied #### Example ```js -chain.methods(['index']).autoIncrement().build().index().index(+1).index() -chain.get('index') -//=> 3 +copy(/eh/gim) //=> new RegExp('eh', 'gmi') +copy(new Error('eh')) // => new Error with copied stack + msg +copy([1]) // => [1] +copy({}) // => {} ``` --- @@ -1803,37 +3157,79 @@ chain.get('index') -

# MethodChain.prototype.build([returnValue=undefined])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4634 "View in source") [Ⓣ][1] +

Traverse.eq(traverse=undefined, a=undefined, b=undefined, [loose=undefined])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L21 "View in source") [Ⓣ][1] -(Function): set the actual method, also need .context - use .parent +Function -### @see +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @extends -* fluents/chain able/blob/master/src/deps/reduce/clean.js -### @todos -- [ ] if passing in a name that already exists, operations are decorations... (partially done) - -#### Since -4.0.0 + +#### @Since +3.0.0 #### Arguments -1. `[returnValue=undefined]` *(any)*: returned at the end of the function for ease of use +1. `traverse=undefined` *(Traverse): traversejs *(scoped, @FIXME @HACK)** +2. `a=undefined` *(*)*: compare to b +3. `b=undefined` *(*)*: compare to a +4. `[loose=undefined]` *(boolean)*: compare loosely #### Returns -*(MethodChain)*: @chainable +*(boolean)*: isEqual: a === b #### Example ```js -var obj = {} -const one = new MethodChain(obj).methods('eh').getSet().build(1) -//=> 1 +eq(1, 1) //=> true +eq(1, '1') //=> false +eq(1, '1', true) //=> true +eq([1], [1]) //=> true + +``` +--- + + + + + +

Traverse.eqValue(x=undefined, y=undefined, [loose=false])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3876 "View in source") [Ⓣ][1] + +(Function): checks value equality, used by eq which compares all types + + +#### @todos + +- [ ] !!!!!! USE ENUM FLAGS ON LOOSE TO ALLOW MORE CONFIG FOR ==, COMPARATOR, VALUEOF, walk proto (check ownProps...)... + + +#### @Since +4.1.0 + +#### Arguments +1. `x=undefined` *(*)*: compare to y +2. `y=undefined` *(*)*: compare to x +3. `[loose=false]` *(boolean|number)*: use == checks when typof != + +#### Returns +*(boolean)*: -typeof obj.getEh -//=> 'function' +#### Example +```js +eqValue(1, 1) //=> true +eqValue('1', 1) //=> false +eqValue('1', 1, true) //=> true +eqValue({}, {}) //=> true ``` --- @@ -1842,39 +3238,29 @@ typeof obj.getEh -

# MethodChain.prototype.decorate(parentToDecorate=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4128 "View in source") [Ⓣ][1] - -(Function): decorates a parent when the argument is provided -BUT THE FUNCTIONS WILL STILL BE SCOPED TO CURRENT PARENT -for easy factory chaining - - -### @see +

Traverse.forEach(cb=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4633 "View in source") [Ⓣ][1] -* fluents/chain able/blob/master/src/deps/reduce/clean.js +(Function): this is the main usage of Traverse -### @todos -- [ ] this is more like a preset since it *adds* plugins? - more of methodFactory now - -#### Since -4.0.0-alpha.1 +#### @Since +3.0.0 #### Arguments -1. `parentToDecorate=undefined` *(Object)*: object to put the method on instead +1. `cb=undefined` *(Function)*: callback for each iteration #### Returns -*(MethodChain)*: @chainable +*(*)*: mapped result or original value, depends how it is used #### Example ```js -const chain = new Chain() -const obj = {} -chain.method('ehOh').decorate(obj).build() -typeof obj.ehOh -//=> 'function' +traverse([1, 2, 3]).forEach((key, value) => console.log({ [key]: value })) +//=> {'0': 1} +//=> {'1': 2} +//=> {'2': 3} ``` --- @@ -1883,69 +3269,67 @@ typeof obj.ehOh -

# MethodChain.prototype.decorate([parentToDecorate=undefined])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5023 "View in source") [Ⓣ][1] +

Traverse.iterate(on=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4901 "View in source") [Ⓣ][1] -(Function): add methods to the parent for easier chaining +Function -### @see +#### @todos -* fluents/chain able/blob/master/src/deps/reduce/clean.js +- [ ] handler for Set & Map so they can be skipped or traversed, for example when cloning... +- [ ] add hook to add custom checking if isIteratable +- [ ] deal with .isRoot if needed +- [ ] examples with clone and stop + + +#### @sig + +on(key: null | Primitive, val: any, instance: Traverse): any #### Arguments -1. `[parentToDecorate=undefined]` *(Object)*: decorate a specific parent shorthand +1. `on=undefined` *(Function)*: callback fn for each iteration #### Returns -*(ChainedMap)*: @chainable +*(*)*: this.node #### Example ```js -var obj = {} -new MethodChain({}).name('eh').decorate(obj).build() -typeof obj.eh -//=> 'function' +iterate([]) +//=> [] +//=> on(null, []) ``` #### Example ```js -class Decorator extends Chain { - constructor(parent) { - super(parent) - this.methods(['easy']).decorate(parent).build() - this.methods('advanced') - .onCall(this.advanced.bind(this)) - .decorate(parent) - .build() - } - advanced(arg) { - this.set('advanced', arg) - return this.parent - } - easy(arg) { - this.parent.set('easy-peasy', arg) - } -} - -class Master extends Chain { - constructor(parent) { - super(parent) - this.eh = new Decorator(this) - } -} - -const master = new Master() - -master.get('easy-peasy') -//=> true +iterate([1]) +//=> [1] +//=> on(null, [1]) +//=> on('1', 1) -master.eh.get('advanced') -//=> 'a+' +``` +#### Example +```js +//primitive - same for any number, string, symbol, null, undefined +iterate(Symbol('eh')) +//=> Symbol('eh') +//=> on(Symbol('eh')) ``` #### Example ```js -;+chain.method('ehOh').decorate(null) -//=> @throws Error('must provide parent argument') +var deeper = { eh: 'canada', arr: [{ moose: true }, 0] } +iterate(deeper) +//=> deeper // returns +//=> on(null, deeper, this) // root + +//=> on('eh', 'canada', this) // 1st branch + +//=> on('arr', [{moose: true}, 0], this) +//=> on('arr.0', [{moose: true}], this) +//=> on('arr.0.moose', true, this) +//=> on('arr.1', [0], this) ``` --- @@ -1954,23 +3338,37 @@ master.eh.get('advanced') -

# MethodChain.prototype.name(methods=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4526 "View in source") [Ⓣ][1] +

Traverse.remove([arg=undefined])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4780 "View in source") [Ⓣ][1] -(Function): setup methods to build +(Function): Remove the current element from the output. +If the node is in an Array it will be spliced off. +Otherwise it will be deleted from its parent. + + +#### @Since +2.0.0 #### Arguments -1. `methods=undefined` *(Object|string|string[])*: method names to build +1. `[arg=undefined]` *(|Object)*: optional obj to use, defaults to this.node #### Returns -*(MethodChain)*: @chainable +*(void)*: #### Example ```js -var obj = {} -new MethodChain(obj).name('eh').build() -typeof obj.eh -//=> 'function' +traverse([0]).forEach((key, val, it) => it.remove()) +//=> [] + +traverse({ eh: true }).forEach((key, val, it) => it.remove()) +//=> {} + +traverse({ eh: true, str: 'stringy' }).forEach((key, val, it) => { + if (!isString(val)) it.remove() +}) +//=> {str: 'stringy'} ``` --- @@ -1979,131 +3377,53 @@ typeof obj.eh -

# MethodChain.prototype.schema(obj=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4609 "View in source") [Ⓣ][1] +

Traverse.skip()

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4681 "View in source") [Ⓣ][1] -(Function): an object that contains nestable `.type`s -they are recursively *(using an optimized traversal cache)* mapped to validators -❗ this method auto-calls .build, all other method config calls should be done before it +Function -### @todos +#### @todos -- [ ] link to `deps/is` docs -- [ ] move out into a plugin to show how easy it is to use a plugin - and make it able to be split out for size when needed -- [ ] inherit properties (in plugin, for each key) - from this for say, dotProp, getSet -- [ ] very @important - that we setup schema validation at the highest root for validation - and then have some demo for how to validate on set using say mobx - observables for all the way down... +- [ ] skip 1 branch -#### Since -4.0.0 -#### Arguments -1. `obj=undefined` *(Object)*: schema +#### @Since +3.0.0 #### Returns -*(MethodChain)*: @chainable +*(void)*: #### Example ```js -chain - .methods() - .define() - .getSet() - .onInvalid((error, arg, instance) => console.log(error)) - .schema({ - id: '?number', - users: '?object|array', - topic: '?string[]', - roles: '?array', - creator: { - name: 'string', - email: 'email', - id: 'uuid', - }, - created_at: 'date', - updated_at: 'date|date[]', - summary: 'string', - }) - -//--- valid -chain.created_at = new Date() -chain.setCreatedAt(new Date()) - -isDate(chain.created_at) === true - -//--- nestable validation 👍 -chain.merge({ creator: { name: 'string' } }) - -//--- invalid -chain.updated_at = false +traverse([1, 2, 3, [4]]).forEach((key, val, t) => { + if (isArray(val)) t.skip() +}) ``` --- - - - - -## `Observe.prototype` - -

# Observe.prototype.observe(properties=undefined, fn=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L62 "View in source") [Ⓣ][1] - -(Function): observe properties when they change - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @todos +

Traverse.stop()

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4661 "View in source") [Ⓣ][1] -- [ ] gotta update `data` if `deleting` too... -- [ ] un-observe -- [ ] should hash these callback properties -- [ ] just throttle the `.set` to allow easier version of .commit - -#### Arguments -1. `properties=undefined` *(Matchable)*: Matchable properties to observe -2. `fn=undefined` *(Function)*: onChanged +(Function): stop the iteration #### Returns -*(Target)*: @chainable - -#### Example -```js -const Target = require('chain-able') - -const chain = new Target() -const log = arg => console.log(arg) - -chain.extend(['eh']).observe('eh', data => log(data)).eh(true) -//=> {eh: true} +*(void)*: -``` #### Example ```js -chain - .extend(['canada', 'timbuck']) - .observe(['canad*'], data => console.log(data.canada)) - .canada(true) - .canada(true) - .timbuck(false) - -//=> true -//=> false - -// only called when changed, -// otherwise it would be 2 `true` & 1 `false` +traverse({ eh: true, arr: [] }).forEach((key, val, t) => { + if (isArray(val)) this.stop() +}) ``` --- @@ -2112,100 +3432,88 @@ chain -🔬 Tests: DotProp  - -

# Observe.prototype.DotProp(Chain=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7367 "View in source") [Ⓣ][1] - -Function - - -### @see +

Traverse.update(value=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4823 "View in source") [Ⓣ][1] -* fluents/chain able/blob/master/src/deps/reduce/clean.js +(Function): update the value for the current key -### @extends -ChainedMap +#### @Since +2.0.0 #### Arguments -1. `Chain=undefined` *(Class|Composable)*: composable class +1. `value=undefined` *(*)*: this.node[this.key] = value #### Returns -*(DotProp)*: class - -#### Example -```js -const { compose } = require('chain-able') -const { DotProp } = compose -new DotProp() -//=> DotProp +*(void)*: -``` #### Example ```js -const chain = new Chain() - -chain.set('moose.simple', 1) -//=> Chain - -chain.get('moose.simple') -//=>1 - -chain.get('moose') -//=> {simple: 1} - -chain.set('moose.canada.eh', true).set('moose.canada.igloo', true) -//=> Chain - -//set, has, get, delete :-) -chain.delete('moose.canada.eh') -//=> Chain - -//also works with an array (moose.canada.igloo) -chain.get(['moose', 'canada', 'igloo']) -//=> true +traverse({ eh: true }).forEach((key, val, traverser) => { + if (this.isRoot) return + traverser.update(false) +}) +//=> {eh: false} ``` --- + + -🔬 Tests: observe  +## `TraverseChain` -

# Observe.prototype.Observe(Chain=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L34 "View in source") [Ⓣ][1] + -(Function): > subscribe to changes ❗ called only on **change** observers are only called when data they subscribe to changes +

TraverseChain.traverse([shouldReturn=false])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L9783 "View in source") [Ⓣ][1] +(Function): runs traverser, checks the tests, calls the onMatch -### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js +#### @Since +1.0.0 -### @extends +#### Arguments +1. `[shouldReturn=false]` *(boolean)*: returns traversed object -* ChainedMap -* DotProp +#### Returns +*(any)*: this.obj/data cleaned +#### Example +```js +const traversed = new Chain() + .merge({ flat: 0, one: { two: true } }) + .traverse(false) + .vals([/true/]) + .onMatch((current, traverser) => { + traverser.path.join('.') + //=> 'one.two' -#### Since -3.0.1 + current + //=> true -#### Arguments -1. `Chain=undefined` *(Class|Composable)*: composable class + typeof traverser.update === typeof traverser.remove + typeof traverser.update === 'function' + //=> true -#### Returns -*(Observe)*: class + traverser.remove() + //=> void + }) + .onNonMatch(val => { + // ignore + }) + .call(true) -#### Example -```js -const { compose } = require('chain-able') -const { DotProp } = compose -new DotProp() -//=> DotProp +traversed +//=> {flat: 0} ``` --- @@ -2216,132 +3524,142 @@ new DotProp() -## `ShorthandChain.prototype` +## `add` -

# ShorthandChain.prototype.return(value=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6790 "View in source") [Ⓣ][1] +

add(methodFactory=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7985 "View in source") [Ⓣ][1] + +(Function): add methodFactories easily -(Function): returns any value passed in return a value at the end of a chain regardless -#### Since -3.0.0 +#### @Since +4.0.0-beta.2 #### Arguments -1. `value=undefined` *(any)*: value to return at the end of a chain +1. `methodFactory=undefined` *(Object)*: factories to add #### Returns -*(any)*: value +*(void)*: #### Example ```js -const chain = new Chain() +function autoGetSet(name, parent) { + const auto = arg => + isUndefined(arg) ? parent.get(name) : parent.set(name, arg) -const saveAndDebug = env => - chain.from({ env: env.NODE_ENV }).return(JSON.stringify(env)) + //so we know if we defaulted them + auto.autoGetSet = true + return this.onSet(auto).onGet(auto).onCall(auto) +} +MethodChain.addPlugin({ autoGetSet }) -console.log(saveAndDebug(process.env)) -//=> value of process.env +const chain = new Chain() +chain.methods('eh').autoGetSet().build() + +chain.eh(1) +//=> chain +chain.eh() +//=> 1 * ``` --- + + + + +## `addTypes` + -

# ShorthandChain.prototype.setIfEmpty(name=undefined, value=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6764 "View in source") [Ⓣ][1] +🌊 Types: schema.d  -(Function): sets a value **only** when .has is false aka set if the value has not been set +

addTypes(types=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6096 "View in source") [Ⓣ][1] +(Function): add custom types for validation -### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -1.0.2 +#### @see +* fluents/chain able/blob/master/src/deps/reduce/clean.js #### Arguments -1. `name=undefined` *(Primitive)*: key to set if it has not been done so already -2. `value=undefined` *(any)*: value to set when key has not been already set - -#### Returns -*(ShorthandChain)*: @chainable +1. `types=undefined` *(Object)*: custom Types #### Example ```js -const chain = new Chain() - -chain.set('eh', true) +addTypes({ yaya: x => typeof x === 'string' }) -// eh is already set ^, ignored -chain.setIfEmpty('eh', false) +const chain = new Chain().methods('eh').type('yaya').build() -chain.get('eh') -//=> true +chain.eh('good') +//=> chain -``` -#### Example -```js -new Chain().setIfEmpty('canada', true).entries() -//=> {canada: true} +chain.eh(!!'throws') +//=> TypeError(false != {yaya: x => typeof x === 'string'}) ``` #### Example ```js -// longhand way to do the same thing -if (chain.has('eh') === false) { - chain.set('eh', false) -} +const custom = {} +custom.enums = enums => x => enums.includes(x) +custom['*'] = x => true +addTypes(custom) +//-> void -// or using .when -chain.when(!chain.has('eh'), instance => instance.set('eh', false)) +new Chain().methods('eh').type('*').build().eh +//=> validateType(custom['*']) ``` --- + + -

# ShorthandChain.prototype.wrap(fn=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6823 "View in source") [Ⓣ][1] +## `alias` -(Function): wrap a value, if it's a Function call it, return this aka execute something and return this + + +

alias(aliases=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7370 "View in source") [Ⓣ][1] + +(Function): alias methods -#### Since + +#### @notes + +* these would be .transform + + +#### @Since 2.0.0 #### Arguments -1. `fn=undefined` *(Function|any)*: function to call, or just any value +1. `aliases=undefined` *(string|string[])*: aliases to remap to the current method being built #### Returns -*(ShorthandChain)*: @chainable - -#### Example -```js -const { eh } = chain.wrap(chain => (chain.eh = true)) -//=> true +*(MethodChain)*: @chainable -``` #### Example ```js -new Chain() - .wrap( - encased => - (encased.fn = arg => { - throw new Error('encased yo') - }) - ) - .method('fn') - .encase() - .catch(error => { - //=> Error('encasedYo') - }) - .build() - .fn(true) +const chain = new Chain() +chain.methods(['canada']).alias(['eh']).build() +chain.eh('actually...canada o.o') +chain.get('canada') +//=> 'actually...canada o.o') ``` --- @@ -2352,25 +3670,44 @@ new Chain() -## `Transform` +## `anyKeyVal` -

# Transform(SuperClass=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7089 "View in source") [Ⓣ][1] +🌊 Types: matcher.d  -Function +

anyKeyVal(keys=undefined, vals=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L9684 "View in source") [Ⓣ][1] + +(Function): the original simple to-test matcher for traversable, +will be merged into, or simplified as simplified into matcher + + +#### @todos + +- [ ] should use matcher, +- [ ] should inprove the callback data... + + +#### @Since +2.0.0 #### Arguments -1. `SuperClass=undefined` *(Class|Composable)*: composable class +1. `keys=undefined` *(Matchable[])*: matchable keys +2. `vals=undefined` *(Matchable[])*: matchable values #### Returns -*(TransformChain)*: class +*(boolean)*: matched or not #### Example ```js -compose(class {}) -//=> TransformChain +anyKeyVal([], [])(0, 0) +//=> false + +anyKeyVal([() => true], [])(0, 0) +//=> true ``` --- @@ -2381,154 +3718,198 @@ compose(class {}) -## `TransformChain.prototype` +## `argumentor` -🔬 Tests: TransformChain  - -

# TransformChain.prototype.

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L11 "View in source") [Ⓣ][1] +

argumentor()

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7077 "View in source") [Ⓣ][1] -Map +(Function): turns arguments into an array, used as a util, for opt -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js +* fluents/chain able/blob/master/src/deps/reduce/clean.js -### @symb +#### @Since +3.0.0 -🤖 +#### Returns +*(*)*: -### @extends -ChainedMap +#### Example +```js +function eh() { + const args = argumentor.apply(null, arguments).slice(1) + console.log(args) + //=> [1, 10, 100] +} +eh(0, 1, 10, 100) +``` --- + + -

# TransformChain.prototype.remap(from=undefined, [to=undefined])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7258 "View in source") [Ⓣ][1] +## `arithmeticTypeFactory` -(Function): remap properties from `1` to another, for example, apis with inconsistent naming + + +🌊 Types: schema.d  +

arithmeticTypeFactory(fullKey=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6193 "View in source") [Ⓣ][1] -### @see +(Function): transform arithmetic strings into types -* fluents/chain able/blob/master/src/deps/reduce/clean.js -### @symb +#### @see -🗺 -#### Since -1.0.0 +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @todos + +- [ ] coercing values to certain types: arithmeticTypeFactory('') + + +#### @Since +4.0.0-alpha.1 #### Arguments -1. `from=undefined` *(Object|string)*: property name string, or {[from]: to} -2. `[to=undefined]` *(string)*: property name to change key to +1. `fullKey=undefined` *(Matchable)*: arithmetic type key #### Returns -*(Chain)*: @chainable +*(Matchable)*: function to match with, with .inspect for easy debugging #### Example ```js -chain.remap('dis', 'dat').from({ dis: true }) +arithmeticTypeFactory('?string') +//=> x => !isReal(x) || isString(x) -chain.entries() -//=> {dat: true} +``` +#### Example +```js +arithmeticTypeFactory('?string|string[]') +//=> x => isString(x) || isArrayOf(isString)(x) ``` #### Example ```js -chain - .remap({dis: 'dat'}) - .from({dis: 1, other: true}} +arithmeticTypeFactory('!string') +//=> x => not(isString)(x) + +``` +#### Example +```js +types.addTypes({ star: x => true }) +arithmeticTypeFactory('object|function|star') +//=> x => isObj(x) || isFunction(x) || isStar(x) + +``` +#### Example +```js +arithmeticTypeFactory('===') +//=> x => (['===']).includes(x) - chain.entries() - //=> {dist: 1, other: true} ``` --- - + -

# TransformChain.prototype.set(key=undefined, val=undefined, dotPropKey=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7197 "View in source") [Ⓣ][1] + -Function +## `autoIncrement` + -### @see +

autoIncrement(name=undefined, parent=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7011 "View in source") [Ⓣ][1] -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -1.0.0 +Function #### Arguments -1. `key=undefined` *(Primitive)*: key to set with -2. `val=undefined` *(any)*: value to set for key -3. `dotPropKey=undefined` *(|string|string[])*: special key used for initializing dot prop values in an optimized way to keep reference +1. `name=undefined` *(Primitive)*: method name +2. `parent=undefined` *(Object)*: Parent #### Returns -*(Chainable)*: @chainable +*(MethodChain)*: @chainable --- + + -

# TransformChain.prototype.transform(key=undefined, value=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7179 "View in source") [Ⓣ][1] +## `builder` -Function + + +

builder(fullKey=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6258 "View in source") [Ⓣ][1] +(Function): @pattern @builder -> builds using multiple factories depending on conditons or abstractFactory whatever opinionated: if it's a function, it's a validator... -### @todos -- [ ] dot-prop here +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @notes + +* if/else is for uglifying ternaries, even though else if is not needed +* if key is number, iterating the array -#### Since -1.0.2 + +#### @Since +4.0.0 #### Arguments -1. `key=undefined` *(Function|string)*: currently just string -2. `value=undefined` *(Function)*: callback accepting the value as only arg to transform with +1. `fullKey=undefined` *(Function|Primitive|string)*: arithmetic key to the validator #### Returns -*(TransformChain)*: @chainable +*(Function)*: validator #### Example ```js -// coerce values with .id into the value they hold -chain.transform('dis', val => (typeof val === 'string' ? val : val.id)) - -chain.set('dis', 'eh') -chain.get('dis') -//=> 'eh' - -chain.set('dis', { id: 'eh' }) -chain.get('dis') -//=> 'eh' +// functionType +const isString = x => typeof x === 'string' +builder(isString) +// => isString ``` #### Example ```js -import { format } from 'date-fns/esm' -import { Chain } from 'chain-able' +// stringType (built in, or custom-keyed validator, or eqeqeq) +builder('string') +// => isString -const chain = new Chain() -chain.transform('created_at', date => format(date, 'MM/DD/YYYY')) -chain.set('created_at', new Date()) +const enummy = builder('enum') +// => x => ['enum'].includes(x) -// is formatted human-readable pretty! -const { created_at } = chain.entries() -//=> '02/11/2014' +``` +#### Example +```js +// arithmeticType +builder('string|string[]') +// => isString || isArrayOf(isString) ``` --- @@ -2539,258 +3920,303 @@ const { created_at } = chain.entries() -## `Traverse.prototype` +## `camelCase` -* 🌊 Types: TraverseChain.d  -* 🌊 Types: traverse.d  +* 🌊 Types: deps.d  +* 🌊 Types: deps.encase.d  +* 🌊 Types: deps.reduce.d  -* 🔬 Tests: circular  -* 🔬 Tests: date  -* 🔬 Tests: equal  -* 🔬 Tests: error  -* 🔬 Tests: has  -* 🔬 Tests: index  -* 🔬 Tests: instance  -* 🔬 Tests: interface  -* 🔬 Tests: json  -* 🔬 Tests: keys  -* 🔬 Tests: leaves  -* 🔬 Tests: negative  -* 🔬 Tests: obj  -* 🔬 Tests: set-map  -* 🔬 Tests: siblings  -* 🔬 Tests: stop  -* 🔬 Tests: stringify  -* 🔬 Tests: subexpr  -* 🔬 Tests: superDeep  +🔬 Tests: camelCase  -

# Traverse.prototype.Traverse(obj=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2211 "View in source") [Ⓣ][1] +

camelCase(str=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5801 "View in source") [Ⓣ][1] -Function +(Function): camelCase -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js +* fluents/chain able/blob/master/src/deps/reduce/clean.js -### @todos +#### @todos -- [ ] : symbol, map, set +- [ ] s.charAt(0).toLowerCase() + string.slice(1) -### @classProps +#### @symb + +🐫 + +#### @Since +0.2.0 -* {value} the data passed in as an argument to traverse on - #### Arguments -1. `obj=undefined` *(Traversable)*: any traversable value +1. `str=undefined` *(string)*: string to turn into camelCase + +#### Returns +*(string)*: camelCased string #### Example ```js -traverse({}) -//=> Traverser +camelCase('snake_case') +//=> 'snakeCase' ``` --- + + + + +## `clone` + -

# Traverse.prototype.map(cb=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2319 "View in source") [Ⓣ][1] +

clone(arg=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5186 "View in source") [Ⓣ][1] -(Function): Execute fn for each node in the object and return a new object with the results of the walk. To update nodes in the result use this.update(value). +Function -### @see +#### @todos -* fluents/chain able/blob/master/src/deps/reduce/clean.js +- [ ] merge with dopemerge? +- [ ] needs tests converted back for this (observe tests do cover somewhat) + #### Arguments -1. `cb=undefined` *(Function)*: fn for each node in the object +1. `arg=undefined` *(*)*: defaults to this.node #### Returns -*(any)*: +*(*)*: cloned #### Example ```js -var { traverse } = require('chain-able') - -var obj = { a: 1, b: 2, c: [3, 4] } -obj.c.push(obj) - -var scrubbed = traverse(obj).map(function(x) { - if (this.circular) this.remove() -}) -console.dir(scrubbed) -//=> { a: 1, b: 2, c: [ 3, 4 ] } +var obj = {} +var cloned = traverse().clone(obj) +obj.eh = true +eq(obj, cloned) +//=> false ``` --- - - -🌊 Types: TraverseChain.d  - -🔬 Tests: TraverseChain  - -

# Traverse.prototype.TraverseChain

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6931 "View in source") [Ⓣ][1] + -Map + +## `compose` -### @see + -* fluents/chain able/blob/master/src/deps/reduce/clean.js +🌊 Types: compose.d  -### @symb +🔬 Tests: compose  -👣 +

compose.compose([target=ChainedMap], [extensions=[Observe,Shorthands,Transform,DotProp]])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L10621 "View in source") [Ⓣ][1] -### @classProps +(Function): compose chains all the way up from Chainable -* {obj} -* {keys} -* {vals} -* {onMatch} -* {onNonMatch} -* {clone} - -### @extends -ChainedMapBase +#### @see +* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -1.0.0 +#### @symb ---- +🎼 - +#### @Since +3.0.0 - +#### Arguments +1. `[target=ChainedMap]` *(|Class|Function)*: class or function to extend +2. `[extensions=[Observe,Shorthands,Transform,DotProp]]` *(|Array)*: Array of extensions to compose together left to right -

# Traverse.prototype.clone()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2439 "View in source") [Ⓣ][1] +#### Returns +*(*)*: composed -(Function): Create a deep clone of the object. +#### Example +```js +class Eh extends compose() {} +new Eh() instanceof Chainable +//=> true -#### Returns -*(any)*: +``` +#### Example +```js +class Target {} +class Eh extends compose(Target) {} +new Eh() instanceof Target +//=> true +``` #### Example ```js -const { traverse, eq } = require('chain-able') +class Target {} +const mixin = SuperClass => class extends SuperClass {} +class Eh extends compose(Target) {} +new Eh() instanceof Chainable +//=> true -const obj = { eh: true, canada: [1] } -const cloned = traverse(obj).clone() -cloned.eh = false -eq(cloned, obj) -//=> false +``` +#### Example +```js +class Winning {} +class Yes extends compose(Winning) { + get winning() { + return true + } +} +const yes = new Yes() +yes instanceof Winning && yes.winning +//=> true ``` --- + + + + +## `concat` + -

# Traverse.prototype.forEach(callback=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2346 "View in source") [Ⓣ][1] +

concat(one=undefined, two=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2406 "View in source") [Ⓣ][1] -(Function): Execute fn for each node in the object but unlike .map(), when this.update() is called it updates the object in-place. executes a provided function once for each traversed element. +(Function): concat two values, coerce to arrays -### @see +#### @Since +4.0.0 -* fluents/chain able/blob/master/src/deps/reduce/clean.js #### Arguments -1. `callback=undefined` *(Function)*: provided callback function +1. `one=undefined` *(*|Array)*: toArr1 +2. `two=undefined` *(*|Array)*: toArr2 #### Returns -*(any)*: this.value +*(Array)*: [one, two] #### Example ```js -var { traverse } = require('chain-able') - -var obj = [5, 6, -3, [7, 8, -2, 1], { f: 10, g: -13 }] -traverse(obj).forEach(function(x) { - if (x < 0) this.update(x + 128) -}) +concat([1], [2]) //=> [1, 2] +concat([1], 2) //=> [1, 2] +concat(1, 2) //=> [1, 2] +concat(new Set([1]), 2) //=> [1, 2] -console.dir(obj) -//=> [ 5, 6, 125, [ 7, 8, 126, 1 ], { f: 10, g: 115 } ] +// kind of weird... +concat(null, 2) //=> [2] +concat(undefined, 2) //=> [2] +concat(1, null) //=> [1, null] ``` --- + + + + +## `conditional` + -

# Traverse.prototype.get(ps=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2225 "View in source") [Ⓣ][1] +

conditional.all(predicate=undefined, array=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L20 "View in source") [Ⓣ][1] -(Function): Get the element at the array path. +(Function): map all values in an array to see if all match +Returns `true` if all elements of the list match the predicate, `false` if there are any that don't. -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js +* fluents/chain able/blob/master/src/deps/reduce/clean.js -### @todos +#### @todos -- [ ] hasOwnProperty +- [ ] `not(some)` ? + +#### @sig + +(a -> Boolean) -> [a] -> Boolean + +#### @Since +4.0.1 + #### Arguments -1. `ps=undefined` *(string[])*: paths +1. `predicate=undefined` *(Function)*: match the value +2. `array=undefined` *(Array)*: to match against predicate #### Returns -*(any)*: value at dot-prop +*(boolean)*: all match predicate + +#### Example +```js +const allBoolean = all(x => typeof x === 'boolean'q) + + allBoolean([true]) + //=> true + allBoolean([1]) + //=> false +``` --- -

# Traverse.prototype.has(pathsArray=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2264 "View in source") [Ⓣ][1] +

conditional.and(left=undefined, right=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5878 "View in source") [Ⓣ][1] -(Function): Return whether the element at the array path exists. +(Function): first fn & second fn -### @see +#### @Since +4.0.1 -* fluents/chain able/blob/master/src/deps/reduce/clean.js #### Arguments -1. `pathsArray=undefined` *(string[])*: paths +1. `left=undefined` *(Function)*: first fn +2. `right=undefined` *(Function)*: second fn #### Returns -*(boolean)*: has element at path +*(boolean)*: both functions return truthy #### Example ```js -traverse({ eh: true }).has(['eh']) +const both = and(x => typeof x === 'boolean', x => x === true) + +both([true]) //=> true -``` -#### Example -```js -traverse({ eh: true }).has(['canada']) +both([false]) //=> false -``` -#### Example -```js -traverse([0]).has([2]) +both([1]) //=> false ``` @@ -2800,93 +4226,115 @@ traverse([0]).has([2]) -

# Traverse.prototype.nodes()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2414 "View in source") [Ⓣ][1] - -(Function): Return an Array of every node in the object. +

conditional.not(fn=undefined, x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5839 "View in source") [Ⓣ][1] -#### Returns -*(*)*: +(Function): return a negated function +A function wrapping a call to the given function in a `!` operation. +It will:
+
+* return `true` when the underlying function would return a false-y value, +
+* and `false` when it would return a truth-y one. ---- - +#### @Since +4.0.1 - +#### Arguments +1. `fn=undefined` *(Function)*: any function +2. `x=undefined` *(*)*: value to pass to function -🔬 Tests: keys  +#### Returns +*(Function): !Function(x)* -

# Traverse.prototype.paths()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2401 "View in source") [Ⓣ][1] +#### Example +```js +const falsed = not(x => true) +const trued = not(x => false) -(Function): Return an Array of every possible non-cyclic path in the object. Paths are Arrays of string keys. +trued() +//=> true -#### Returns -*(*)*: +falsed() +//=> false +``` --- -

# Traverse.prototype.reduce(cb=undefined, init=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2384 "View in source") [Ⓣ][1] +

conditional.or(left=undefined, right=undefined, x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3178 "View in source") [Ⓣ][1] -(Function): applies a function against an accumulator and each element in the array *(from left to right)* to reduce it to a single value. calls cb for each loop that is .notRoot defaults initial value to `this.value` +(Function): first fn || second fn, curried -### @see +#### @Since +4.0.1 -* fluents/chain able/blob/master/src/deps/reduce/clean.js #### Arguments -1. `cb=undefined` *(Function)*: callback forEach -2. `init=undefined` *(Array|Object|any)*: initial value +1. `left=undefined` *(Function)*: first fn +2. `right=undefined` *(Function)*: second fn +3. `x=undefined` *(*)*: value to pass into left & right, curried #### Returns -*(*)*: +*(boolean)*: one of the functions return truthy #### Example ```js -var { traverse } = require('chain-able') +const { isTrue, isFalse } = require('chain-able') -var obj = { - a: [1, 2, 3], - b: 4, - c: [5, 6], - d: { e: [7, 8], f: 9 }, -} +const either = or(isFalse, isTrue) + +either([true]) +//=> true -var leaves = traverse(obj).reduce(function(acc, x) { - if (this.isLeaf) acc.push(x) - return acc -}, []) +either([new Boolean(true)]) +//=> false + +either([1]) +//=> false -console.dir(leaves) -//=> [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ] +// because curried +or(isTrue, isFalse, true) //=> true ``` --- + + + + +## `copy` + -

# Traverse.prototype.set(arrayPath=undefined, value=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2286 "View in source") [Ⓣ][1] +

copy(src=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5193 "View in source") [Ⓣ][1] -(Function): Set the element at the array path to value. +Function -### @see +#### @todos -* fluents/chain able/blob/master/src/deps/reduce/clean.js +- [ ] ugh, how to clone better with *recursive* objects? + #### Arguments -1. `arrayPath=undefined` *(string[])*: paths -2. `value=undefined` *(any)*: any value to assign to the element @ the path +1. `src=undefined` *(any)*: wip #### Returns -*(any)*: value passed in +*(any)*: wip --- @@ -2896,51 +4344,40 @@ console.dir(leaves) -## `TraverseChain.prototype` +## `debug` -

# TraverseChain.prototype.traverse([shouldReturn=false])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6987 "View in source") [Ⓣ][1] +

debug([should=true])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L9422 "View in source") [Ⓣ][1] + +(Function): sets on store not this.set for easier extension -(Function): runs traverser, checks the tests, calls the onMatch -#### Since -1.0.0 +#### @notes +* is inherited by any chain with a parent with .meta.debug + #### Arguments -1. `[shouldReturn=false]` *(boolean)*: returns traversed object +1. `[should=true]` *(boolean)*: shouldDebug #### Returns -*(any)*: this.obj/data cleaned +*(Chainable)*: @chainable #### Example ```js -const traversed = new Chain() - .merge({ flat: 0, one: { two: true } }) - .traverse(false) - .vals([/true/]) - .onMatch((current, traverser) => { - traverser.path.join('.') - //=> 'one.two' - - current - //=> true - - typeof traverser.update === typeof traverser.remove - typeof traverser.update === 'function' - //=> true +const Chain = require('chain-able') +const chain = new Chain() +chain.debug() - traverser.remove() - //=> void - }) - .onNonMatch(val => { - // ignore - }) - .call(true) +chain.get('debug') +//=> true -traversed -//=> {flat: 0} +// not in entries +chain.entries() +//=> {} ``` --- @@ -2951,76 +4388,78 @@ traversed -## `add` +## `define` -

# add(methodFactory=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5091 "View in source") [Ⓣ][1] +

define(obj=undefined, name=undefined, descriptor=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L911 "View in source") [Ⓣ][1] -(Function): add methodFactories easily +(Function): default to configurable and enumerable, unless configured otherwise -#### Since -4.0.0-beta.2 + +#### @Since +4.0.0 #### Arguments -1. `methodFactory=undefined` *(Object)*: factories to add +1. `obj=undefined` *(Object)*: object to define on +2. `name=undefined` *(Primitive)*: property name to define +3. `descriptor=undefined` *(Object)*: object descriptor #### Returns *(void)*: #### Example ```js -function autoGetSet(name, parent) { - const auto = arg => - isUndefined(arg) ? parent.get(name) : parent.set(name, arg) - - //so we know if we defaulted them - auto.autoGetSet = true - return this.onSet(auto).onGet(auto).onCall(auto) -} -MethodChain.addPlugin({ autoGetSet }) - -const chain = new Chain() -chain.methods('eh').autoGetSet().build() - -chain.eh(1) -//=> chain -chain.eh() -//=> 1 * +var desc = Object.getOwnPropertyDescriptor(obj, 'eh', { + get: () => console.log('eh'), +}) ``` --- + + -

# add(value=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5620 "View in source") [Ⓣ][1] +## `delete` -(Function): appends a new element with a specified value to the end of the .store + +

delete

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L10534 "View in source") [Ⓣ][1] -### @see +unknown -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -0.4.0 -#### Arguments -1. `value=undefined` *(any)*: any value to add to **end** of the store +#### @see -#### Returns -*(ChainedSet)*: @chainable +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @Since +3.0.1 #### Example ```js -const people = new ChainedSet() -people.add('sam').add('sue') +chain.set('moose.canada.eh', true) +chain.set('moose.canada.igloo', true) +//=> Chain -for (let name of people) console.log(name) -//=> sam, sue +chain.delete('moose.canada.eh') +//=> Chain + +chain.has('moose.canada.eh') +//=> true + +//still has moose.canada.igloo +chain.has('moose.canada') +//=> true ``` --- @@ -3031,152 +4470,233 @@ for (let name of people) console.log(name) -## `addTypes` +## `dopemerge` -🌊 Types: schema.d  +

dopemerge.cloneIfNeeded(value=undefined, optsArg=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1856 "View in source") [Ⓣ][1] + +(Function): Defaults to `false`. +If `clone` is `true` then both `x` and `y` are recursively cloned as part of the merge. -

# addTypes(types=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3323 "View in source") [Ⓣ][1] -(Function): add custom types for validation +#### @see +* fluents/chain able/blob/master/src/deps/reduce/clean.js -### @see +#### @Since +2.0.0 -* fluents/chain able/blob/master/src/deps/reduce/clean.js #### Arguments -1. `types=undefined` *(Object)*: custom Types +1. `value=undefined` *(*)*: value to clone if needed +2. `optsArg=undefined` *(DopeMergeOptions)*: dopemerge options, could contain .clone + +#### Returns +*(*)*: cloned or original value #### Example ```js -addTypes({ yaya: x => typeof x === 'string' }) - -const chain = new Chain().methods('eh').type('yaya').build() +var obj = { eh: true } -chain.eh('good') -//=> chain +cloneIfNeeded(obj, { clone: true }) === obj +//=> false -chain.eh(!!'throws') -//=> TypeError(false != {yaya: x => typeof x === 'string'}) +cloneIfNeeded(obj, { clone: false }) === obj +//=> true ``` +--- + + + + + +

dopemerge.defaultArrayMerge(target=undefined, source=undefined, optsArg=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1895 "View in source") [Ⓣ][1] + +(Function): The merge will also merge arrays and array values by default. +However, there are nigh-infinite valid ways to merge arrays, +and you may want to supply your own. +You can do this by passing an `arrayMerge` function as an option. + + +#### @Since +2.0.0 + +#### Arguments +1. `target=undefined` *(*)*: array merged onto, could be emptyTarget if cloning +2. `source=undefined` *(*)*: original source array +3. `optsArg=undefined` *(*)*: dopemerge options + +#### Returns +*(*)*: merged array + #### Example ```js -const custom = {} -custom.enums = enums => x => enums.includes(x) -custom['*'] = x => true -addTypes(custom) -//-> void +function concatMerge(destinationArray, sourceArray, options) { + destinationArray + //=> [1, 2, 3] -new Chain().methods('eh').type('*').build().eh -//=> validateType(custom['*']) + sourceArray + //=> [3, 2, 1] + + options + //=> { arrayMerge: concatMerge } + + return destinationArray.concat(sourceArray) +} +merge([1, 2, 3], [3, 2, 1], { arrayMerge: concatMerge }) +//=> [1, 2, 3, 3, 2, 1] ``` --- - - -## `after` +🌊 Types: _dopemergelater.d  - +

dopemerge.dopemerge(obj1=undefined, obj2=undefined, opts=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L43 "View in source") [Ⓣ][1] -

# after(fn=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2605 "View in source") [Ⓣ][1] +(Function): Merge the enumerable attributes of two objects deeply. Merge two objects `x` and `y` deeply, returning a new merged object with the elements from both `x` and `y`. If an element at the same key is present for both `x` and `y`, the value from +`y` will appear in the result. Merging creates a new object, so that neither `x` or `y` are be modified. However, child objects on `x` or `y` are copied over - if you want to copy all values, you must pass `true` to the clone option. -(Function): Call this function after any of the children are traversed. +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js #### Arguments -1. `fn=undefined` *(Function)*: +1. `obj1=undefined` *(*)*: left +2. `obj2=undefined` *(*)*: right +3. `opts=undefined` *(*)*: dopemerge options + +#### Returns +*(*)*: merged + +#### Example +```js +var x = { + foo: { bar: 3 }, + array: [ + { + does: 'work', + too: [1, 2, 3], + }, + ], +} + +var y = { + foo: { baz: 4 }, + quux: 5, + array: [ + { + does: 'work', + too: [4, 5, 6], + }, + { + really: 'yes', + }, + ], +} + +var expected = { + foo: { + bar: 3, + baz: 4, + }, + array: [ + { + does: 'work', + too: [1, 2, 3, 4, 5, 6], + }, + { + really: 'yes', + }, + ], + quux: 5, +} -#### Returns -*(any)*: +merge(x, y) +//=> expected +``` --- - - - - -## `alias` - -

# alias(aliases=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4476 "View in source") [Ⓣ][1] - -(Function): alias methods +

dopemerge.emptyTarget(val=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1769 "View in source") [Ⓣ][1] +(Function): make a new empty Array or Object for cloning -### @notes -* these would be .transform - -#### Since +#### @Since 2.0.0 #### Arguments -1. `aliases=undefined` *(string|string[])*: aliases to remap to the current method being built +1. `val=undefined` *(*)*: array or object to return an empty one of #### Returns -*(MethodChain)*: @chainable +*(*)*: depending on the data type of val #### Example ```js -const chain = new Chain() -chain.methods(['canada']).alias(['eh']).build() -chain.eh('actually...canada o.o') -chain.get('canada') -//=> 'actually...canada o.o') +emptyTarget({ eh: true }) +//=> {} + +emptyTarget([1]) +//=> [] ``` --- - - -## `allProperties` +

dopemerge.isMergeableObj(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1827 "View in source") [Ⓣ][1] - +(Function): 1: not null object `2`: object toString is not a date or regex -

# allProperties(obj=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4221 "View in source") [Ⓣ][1] -(Function): properties, property symbols, object keys ^ all again for prototype +#### @Since +2.0.0 #### Arguments -1. `obj=undefined` *(Object)*: object to get properties & symbols from +1. `x=undefined` *(*)*: value to check #### Returns -*(*)*: properties +*(boolean)*: #### Example ```js -var obj = { key: true } -allProperties(obj) -//=> ['key'] +isMergeableObj({}) +//=> true -``` -#### Example -```js -class One { - method() {} -} -class Two extends One { - eh() {} -} -allProperties(new Two()) -//=> ['eh', 'method'] +isMergeableObj(Object.create(null)) +// => true + +isMergeableObj(new Date()) +//=> false + +isMergeableObj(/eh/) +//=> false ``` --- @@ -3187,217 +4707,180 @@ allProperties(new Two()) -## `anyKeyVal` +## `dot` -🌊 Types: matcher.d  +

dot([useDot=undefined])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L10395 "View in source") [Ⓣ][1] -

# anyKeyVal(keys=undefined, vals=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6898 "View in source") [Ⓣ][1] +Function -(Function): the original simple to-test matcher for traversable, -will be merged into, or simplified as simplified into matcher +#### @see -### @todos +* fluents/chain able/blob/master/src/deps/reduce/clean.js -- [ ] should use matcher, -- [ ] should inprove the callback data... - -#### Since -2.0.0 +#### @Since +3.0.1 #### Arguments -1. `keys=undefined` *(Matchable[])*: matchable keys -2. `vals=undefined` *(Matchable[])*: matchable values +1. `[useDot=undefined]` *(boolean)*: use dot prop or not #### Returns -*(boolean)*: matched or not +*(DotProp)*: @chainable #### Example ```js -anyKeyVal([], [])(0, 0) -//=> false +const chain = new Target() +chain.dot(false) +chain.set('moose.simple', 1) -anyKeyVal([() => true], [])(0, 0) -//=> true +toArr(chain.store.keys()) +//=> ['moose.simple'] ``` --- - - -## `argumentor` +

dot.dot.delete(obj=undefined, path=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L10201 "View in source") [Ⓣ][1] - +(Function): delete a path on an object -

# argumentor()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2108 "View in source") [Ⓣ][1] -(Function): turns arguments into an array, used as a util, for opt +#### @extends -### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since + +#### @Since 3.0.0 +#### Arguments +1. `obj=undefined` *(Object)*: the object to DELETE the nested property from. +2. `path=undefined` *(Array|Dottable|string)*: dot-prop-path to use + #### Returns -*(*)*: +*(void)*: #### Example ```js -function eh() { - const args = argumentor.apply(null, arguments).slice(1) - - console.log(args) - //=> [1, 10, 100] -} -eh(0, 1, 10, 100) +dot.get({ a: { b: 2 } }, 'a.b') //=> 2 +dot.get({ a: { b: 2 } }, ['a', 'b']) //=> 2 +dot.get({ c: { b: 2 } }, ['a', 'b']) //=> undefined ``` --- - - - - -## `arithmeticTypeFactory` - -🌊 Types: schema.d  +

dot.dot.get(obj=undefined, path=undefined, fallback=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5407 "View in source") [Ⓣ][1] -

# arithmeticTypeFactory(fullKey=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3429 "View in source") [Ⓣ][1] +Function -(Function): transform arithmetic strings into types +#### @extends -### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js -### @todos -- [ ] coercing values to certain types: arithmeticTypeFactory('') - -#### Since -4.0.0-alpha.1 +#### @Since +3.0.0 #### Arguments -1. `fullKey=undefined` *(Matchable)*: arithmetic type key +1. `obj=undefined` *(Object)*: the object to retrieve the nested property from. +2. `path=undefined` *(Array|Dottable|string)*: dot-prop-path to use +3. `fallback=undefined` *(*)*: use when there is no value at specified path #### Returns -*(Matchable)*: function to match with, with .inspect for easy debugging - -#### Example -```js -arithmeticTypeFactory('?string') -//=> x => !isReal(x) || isString(x) +*(*)*: value at path or fallback -``` -#### Example -```js -arithmeticTypeFactory('?string|string[]') -//=> x => isString(x) || isArrayOf(isString)(x) - -``` -#### Example -```js -arithmeticTypeFactory('!string') -//=> x => not(isString)(x) - -``` -#### Example -```js -types.addTypes({ star: x => true }) -arithmeticTypeFactory('object|function|star') -//=> x => isObj(x) || isFunction(x) || isStar(x) - -``` #### Example ```js -arithmeticTypeFactory('===') -//=> x => (['===']).includes(x) +dot.get({ a: { b: 2 } }, 'a.b') //=> 2 +dot.get({ a: { b: 2 } }, ['a', 'b']) //=> 2 +dot.get({ c: { b: 2 } }, ['a', 'b']) //=> undefined ``` --- - - -## `autoIncrement` - - - -

# autoIncrement(name=undefined, parent=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4158 "View in source") [Ⓣ][1] +

dot.dot.has(obj=undefined, path=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L10152 "View in source") [Ⓣ][1] Function -#### Arguments -1. `name=undefined` *(Primitive)*: method name -2. `parent=undefined` *(Object)*: Parent - -#### Returns -*(MethodChain)*: @chainable - ---- - - - - - +#### @extends -## `before` - -

# before(fn=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2597 "View in source") [Ⓣ][1] -(Function): Call this function before any of the children are traversed. -You can assign into this.keys here to traverse in a custom order. +#### @Since +3.0.0 #### Arguments -1. `fn=undefined` *(Function)*: +1. `obj=undefined` *(Object)*: the object to retrieve the nested property from. +2. `path=undefined` *(Array|Dottable|string)*: dot-prop-path to use #### Returns -*(any)*: +*(boolean)*: has at path ---- +#### Example +```js +dot.has({ a: { b: 2 } }, 'a.b') //=> true +dot.has({ a: { b: 2 } }, ['a', 'b']) //=> true +dot.has({ c: { b: 2 } }, ['a', 'b']) //=> undefined - +``` +--- -## `block` +

dot.dotPropSegments(path=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3526 "View in source") [Ⓣ][1] - +Function -

# block()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2637 "View in source") [Ⓣ][1] -Function +#### @Since +4.0.0 + +#### Arguments +1. `path=undefined` *(string|string[])*: dot-prop-path #### Returns -*(void)*: +*(*)*: array path + +#### Example +```js +dotPropSegments('eh.oh') //=> ['eh', 'oh'] +dotPropSegments(['eh', 'oh']) //=> ['eh', 'oh'] +dotPropSegments('ehoh') //=> ['ehoh'] +``` --- @@ -3406,153 +4889,180 @@ Function -## `builder` +## `encase` -

# builder(fullKey=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3494 "View in source") [Ⓣ][1] +

encase.encase(call=undefined, [encaser=tryCatch])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L21 "View in source") [Ⓣ][1] -(Function): @pattern @builder -> builds using multiple factories depending on conditons or abstractFactory whatever opinionated: if it's a function, it's a validator... +Function -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js +* fluents/chain able/blob/master/src/deps/reduce/clean.js -### @notes +#### @symb -* if/else is for uglifying ternaries, even though else if is not needed -* if key is number, iterating the array - -#### Since +🛡 + +#### @Since 4.0.0 #### Arguments -1. `fullKey=undefined` *(Function|Primitive|string)*: arithmetic key to the validator +1. `call=undefined` *(Function)*: function to _encase_ +2. `[encaser=tryCatch]` *(|Function)*: function to encase _with_ #### Returns -*(Function)*: validator +*(Function)*: -> FunctionObject{onInvalid, onValid, rethrow, call} #### Example ```js -// functionType -const isString = x => typeof x === 'string' -builder(isString) -// => isString +const throws = x => { + if (x === false) { + throw new Error('invalid - cannot be false') + } + return true +} +const api = encase(throws) -``` -#### Example -```js -// stringType (built in, or custom-keyed validator, or eqeqeq) -builder('string') -// => isString +api.onValid(console.log) +api.onInvalid(console.error) -const enummy = builder('enum') -// => x => ['enum'].includes(x) +//--- invalid +api.call(false) +//=> 'invalid - cannot be false' -``` -#### Example -```js -// arithmeticType -builder('string|string[]') -// => isString || isArrayOf(isString) +//--- valid +api.call(true) +//=> 'true' ``` --- - - - - -## `camelCase` - -

# camelCase(str=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3147 "View in source") [Ⓣ][1] +

encase.error$3(method=undefined, type=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6609 "View in source") [Ⓣ][1] -(Function): camelCase +(Function): enhance an Error, enable rethrowing & better inspection -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js +* fluents/chain able/blob/master/src/deps/reduce/clean.js -### @todos +#### @todos -- [ ] s.charAt(0).toLowerCase() + string.slice(1) +- [ ] js stringify if development -#### Since -0.2.0 + +#### @Since +4.0.0-alpha.1 #### Arguments -1. `str=undefined` *(string)*: string to turn into camelCase +1. `method=undefined` *(Primitive)*: method being decorated +2. `type=undefined` *(Type)*: type to validate with #### Returns -*(string)*: camelCased string +*(Function): function that returns a decorated TypeError with .inspect & metadata (arg, thrown, meta)* #### Example ```js -camelCase('snake_case') -//=> 'snakeCase' +const badValidator = x => { + if (x === 'bad') { + throw new Error('bad!') + } +} +const enhancer = enhanceError('eh', badValidator) + +// called by plugins/encase when throws or invalid +let error +let arg = 'bad' +try { + error = badValidator(arg) +} catch (e) { + error = enhancer(arg, e, { metadata: true }) +} + +console.log(error) +//=> {[eh]: { type: badValidator, arg: 'bad', json, str, rethrow }} +//=> console.log on DEVELOPMENT ``` --- - - -## `circular` +

encase.tryCatch(call=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6673 "View in source") [Ⓣ][1] - +Function -

# circular

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2547 "View in source") [Ⓣ][1] -unknown +#### @see ---- +* fluents/chain able/blob/master/src/deps/reduce/clean.js - +#### @todos + +- [ ] could curry + +#### Arguments +1. `call=undefined` *(Function)*: + +#### Returns +*(*)*: validation/encased function call result + +--- -## `clear` +

encase.withSpecification(specification=undefined, call=undefined, onInvalid=undefined, onInvalid=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6549 "View in source") [Ⓣ][1] - +(Function): a special encased wrapper with no try catch but same api -

# clear([clearPropertiesThatAreChainLike=true])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L505 "View in source") [Ⓣ][1] -(Function): clears the map, goes through this properties, calls .clear if they are instanceof Chainable or Map +#### @see +* fluents/chain able/blob/master/src/deps/reduce/clean.js -### @see +#### @Since +4.0.0 -* fluents/chain able/blob/master/src/deps/reduce/clean.js #### Arguments -1. `[clearPropertiesThatAreChainLike=true]` *(|boolean)*: checks properties on the object, if they are `chain-like`, clears them as well +1. `specification=undefined` *(Function)*: match +2. `call=undefined` *(Function)*: cb to determine valid or invalid +3. `onInvalid=undefined` *(Function)*: cb when invalid +4. `onInvalid=undefined` *(Function)*: cb when valid #### Returns -*(Chainable)*: @chainable +*(Function)*: a lot of functions... #### Example ```js -const chain = new Chain() -chain.set('eh', 1) -chain.entries() -//=> {eh: 1} -chain.clear() -chain.entries() -//=> {} +const onInvalid = console.error +const onValid = console.debug +const onCall = console.log +const encased = withSpecification(x => true)(onCall)(onValid, onInvalid) + +encased(1, 2, 3) //=> onCall (did not throw) ``` --- @@ -3563,73 +5073,84 @@ chain.entries() -## `compose.prototype` +## `entries` -🌊 Types: compose.d  +

entries(reduced=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2246 "View in source") [Ⓣ][1] -🔬 Tests: compose  +(Function): recursively reduce maps and objects that include reducable data -

# compose.prototype.compose([target=ChainedMap], [extensions=[Observe,Shorthands,Transform,DotProp]])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7603 "View in source") [Ⓣ][1] -(Function): compose chains all the way up from Chainable +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js +#### @notes -### @see +* could curry, but this is super hot function + -* fluents/chain able/blob/master/src/deps/reduce/clean.js +#### @sig -### @symb +reduced => object => isMap(object) -> reduced; merge(object, reduced) -🎼 -#### Since -3.0.0 +#### @Since +4.0.0 #### Arguments -1. `[target=ChainedMap]` *(|Class|Function)*: class or function to extend -2. `[extensions=[Observe,Shorthands,Transform,DotProp]]` *(|Array)*: Array of extensions to compose together left ro right +1. `reduced=undefined` *(Object|any)*: merged object and reduced #### Returns -*(*)*: composed - -#### Example -```js -class Eh extends compose() {} -new Eh() instanceof Chainable -//=> true - -``` -#### Example -```js -class Target {} -class Eh extends compose(Target) {} -new Eh() instanceof Target -//=> true +*(Function): Function(values: Object)* -``` #### Example ```js -class Target {} -const mixin = SuperClass => class extends SuperClass {} -class Eh extends compose(Target) {} -new Eh() instanceof Chainable -//=> true +const map = new Map() + map.set('eh', true) + const nested = new Map() + nested.set('reduced', true) + const chain = { + entries() { + return { + nested: reduce(nested), + key: true, + } + }, + } + const reduced = reduce(map) + reduceEntries(reduced)({chain}) + // => { + eh: true, + chain: { + nested: { + reduced: true, + key: true, + }, + }, + } ``` #### Example ```js -class Winning {} -class Yes extends compose(Winning) { - get winning() { - return true +const reducedIgnored = { + canada: { + store: chain, + }, + } + const ignored = reduceEntries(reduced)(reducedIgnored) + //=> { + eh: true, + chain: { + nested: { + reduced: true, + }, + key: true, + }, } -} -const yes = new Yes() -yes instanceof Winning && yes.winning -//=> true - ``` --- @@ -3639,67 +5160,73 @@ yes instanceof Winning && yes.winning -## `conditional.prototype` +## `fp` -

# conditional.prototype.all(predicate=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3241 "View in source") [Ⓣ][1] - -(Function): map all values in an array to see if all match - -#### Since -4.0.1 - -#### Arguments -1. `predicate=undefined` *(Function)*: match the value +🌊 Types: fp.d  -#### Returns -*(boolean)*: all match predicate +🔬 Tests: curry  -#### Example -```js -const allBoolean = all(x => typeof x === 'boolean'q) +

fp._curryN(length=undefined, received=undefined, fn=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L43 "View in source") [Ⓣ][1] - allBoolean([true]) - //=> true +(Function): Returns a curried equivalent of the provided function, with the specified +arity. The curried function has two unusual capabilities. First, its +arguments needn't be provided one at a time. If `g` is `R.curryN(3, f)`, the +following are equivalent: +
+
+
* `g(1)(2)(3)` +
* `g(1)(2, 3)` +
* `g(1, 2)(3)` +
* `g(1, 2, 3)` +
+
+Secondly, the special placeholder value [`R.__`](#__) may be used to specify +"gaps", allowing partial application of any combination of arguments, +regardless of their positions. If `g` is as above and `_` is [`R.__`](#__), +the following are equivalent: +
+
+
* `g(1, 2, 3)` +
* `g(_, 2, 3)(1)` +
* `g(_, _, 3)(1)(2)` +
* `g(_, _, 3)(1, 2)` +
* `g(_, 2)(1)(3)` +
* `g(_, 2)(1, 3)` +
* `g(_, 2)(_, 3)(1)` - allBoolean([1]) - //=> false -``` ---- - +#### @see - +* fluents/chain able/blob/master/src/deps/reduce/clean.js -

# conditional.prototype.and(left=undefined, right=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3197 "View in source") [Ⓣ][1] +#### @sig -(Function): first fn & second fn +Number -> (* -> a) -> (* -> a) -#### Since -4.0.1 +#### @Since +5.0.0-beta.1 #### Arguments -1. `left=undefined` *(Function)*: first fn -2. `right=undefined` *(Function)*: second fn +1. `length=undefined` *(Number)*: The arity of the curried function. +2. `received=undefined` *(Array)*: An array of arguments received thus far. +3. `fn=undefined` *(Function)*: The function to curry. #### Returns -*(boolean)*: both functions return truthy +*(Function)*: A new, curried function. #### Example ```js -const both = and(x => typeof x === 'boolean', x => x === true) - -both([true]) -//=> true +var sumArgs = (...args) => R.sum(args) -both([false]) -//=> false - -both([1]) -//=> false +var curriedAddFourNumbers = R.curryN(4, sumArgs) +var f = curriedAddFourNumbers(1, 2) +var g = f(3) +g(4) //=> 10 ``` --- @@ -3708,183 +5235,218 @@ both([1]) -

# conditional.prototype.not(fn=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3173 "View in source") [Ⓣ][1] - -(Function): return a negated function - -#### Since -4.0.1 - -#### Arguments -1. `fn=undefined` *(Function)*: any function - -#### Returns -*(Function)*: !Function - -#### Example -```js -const falsed = not(x => true) -const trued = not(x => false) - -trued() -//=> true +

fp.curry(length=undefined, fn=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L470 "View in source") [Ⓣ][1] -falsed() -//=> false +(Function): Returns a curried equivalent of the provided function, with the specified +arity. The curried function has two unusual capabilities. First, its +arguments needn't be provided one at a time. If `g` is `R.curryN(3, f)`, the +following are equivalent: +
+
+
* `g(1)(2)(3)` +
* `g(1)(2, 3)` +
* `g(1, 2)(3)` +
* `g(1, 2, 3)` +
+
+Secondly, the special placeholder value [`R.__`](#__) may be used to specify +"gaps", allowing partial application of any combination of arguments, +regardless of their positions. If `g` is as above and `_` is [`R.__`](#__), +the following are equivalent: +
+
+
* `g(1, 2, 3)` +
* `g(_, 2, 3)(1)` +
* `g(_, _, 3)(1)(2)` +
* `g(_, _, 3)(1, 2)` +
* `g(_, 2)(1)(3)` +
* `g(_, 2)(1, 3)` +
* `g(_, 2)(_, 3)(1)` -``` ---- - +#### @see - +* fluents/chain able/blob/master/src/deps/reduce/clean.js -

# conditional.prototype.or(left=undefined, right=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3221 "View in source") [Ⓣ][1] +#### @sig -(Function): first fn || second fn +Number -> (* -> a) -> (* -> a) -#### Since -4.0.1 +#### @Since +v0.5.0 #### Arguments -1. `left=undefined` *(Function)*: first fn -2. `right=undefined` *(Function)*: second fn +1. `length=undefined` *(Number)*: The arity for the returned function. +2. `fn=undefined` *(Function)*: The function to curry. #### Returns -*(boolean)*: one of the functions return truthy +*(Function)*: A new, curried function. #### Example ```js -const either = or(x => x === false, x => x === true) - -either([true]) -//=> true - -either([new Boolean(true)]) -//=> false +var sumArgs = (...args) => R.sum(args) -either([1]) -//=> false +var curriedAddFourNumbers = R.curryN(4, sumArgs) +var f = curriedAddFourNumbers(1, 2) +var g = f(3) +g(4) //=> 10 ``` --- - - -## `debug` +🌊 Types: fp.d  - +🔬 Tests: always  -

# debug([should=true])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6718 "View in source") [Ⓣ][1] +

fp./* ___filename___(value=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L21 "View in source") [Ⓣ][1] -(Function): sets on store not this.set for easier extension +(Function): Returns a function that always returns the given value. Note that for +non-primitives the value returned is a reference to the original value. +
+
+This function is known as `const`, `constant`, or `K` *(for K combinator)* in +other languages and libraries. -### @notes +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @sig + +a -> (* -> a) + +#### @Since +v5.0.0 -* is inherited by any chain with a parent with .meta.debug - #### Arguments -1. `[should=true]` *(boolean)*: shouldDebug +1. `value=undefined` *(*)*: The value to wrap in a function #### Returns -*(Chainable)*: @chainable +*(Function)*: A Function :: * -> val. #### Example -```js -const Chain = require('chain-able') -const chain = new Chain() -chain.debug() - -chain.get('debug') -//=> true - -// not in entries -chain.entries() -//=> {} +```js +var t = always('Tee') +t() //=> 'Tee' ``` --- - - -## `define` +🌊 Types: fp.d  - +

fp.prop(p=undefined, obj=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3484 "View in source") [Ⓣ][1] -

# define(obj=undefined, name=undefined, descriptor=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L281 "View in source") [Ⓣ][1] +(Function): Returns a function that when supplied an object returns the indicated +property of that object, if it exists. -(Function): default to configurable and enumerable, unless configured otherwise -#### Since -4.0.0 +#### @sig + +s -> {s: a} -> a | Undefined + +#### @Since +v5.0.0 #### Arguments -1. `obj=undefined` *(Object)*: object to define on -2. `name=undefined` *(Primitive)*: property name to define -3. `descriptor=undefined` *(Object)*: object descriptor +1. `p=undefined` *(String)*: The property name +2. `obj=undefined` *(Object)*: The object to query #### Returns -*(void)*: +*(*)*: The value at `obj.p`. #### Example ```js -var desc = Object.getOwnPropertyDescriptor(obj, 'eh', { - get: () => console.log('eh'), -}) +R.prop('x', { x: 100 }) //=> 100 +R.prop('x', {}) //=> undefined ``` --- - - -## `delete` +

fp.constructN(n=undefined, Klass=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L45 "View in source") [Ⓣ][1] - +(Function): Wraps a constructor function inside a curried function that can be called +with the same arguments and returns the same type. The arity of the function +returned is specified to allow using variadic constructor functions. -

# delete(key=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L545 "View in source") [Ⓣ][1] -(Function): calls .delete on this.store.map +#### @see +* fluents/chain able/blob/master/src/deps/reduce/clean.js -### @see +#### @sig -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -0.3.0 +Number -> (* -> {*}) -> (* -> {*}) + +#### @symb + +👷 + +#### @extends + +* undefined +* undefined + + + +#### @Since +5.0.0-beta.4 #### Arguments -1. `key=undefined` *(Primitive)*: on a Map: key referencing the value. on a Set: the index +1. `n=undefined` *(number): The arity of the constructor function. *(aka, number of args)** +2. `Klass=undefined` *(Function): The constructor function to wrap. *(class to do `new Klass` on)** #### Returns -*(Chainable)*: +*(Function)*: A wrapped, curried constructor function. #### Example ```js -const chain = new Chain() -chain.set('eh', 1) -chain.get('eh') -// => 1 -chain.delete('eh', 1) -chain.get('eh') -// => undefined +// Variadic Constructor function +function Salad() { + this.ingredients = arguments +} + +Salad.prototype.recipe = function() { + var instructions = R.map( + ingredient => 'Add a dollop of ' + ingredient, + this.ingredients + ) + return R.join('\n', instructions) +} + +var ThreeLayerSalad = R.constructN(3, Salad) + +// Notice we no longer need the 'new' keyword, and the constructor is curried for 3 arguments. +var salad = ThreeLayerSalad('Mayonnaise')('Potato Chips')('Ketchup') + +console.log(salad.recipe()) +// Add a dollop of Mayonnaise +// Add a dollop of Potato Chips +// Add a dollop of Ketchup ``` --- @@ -3893,93 +5455,88 @@ chain.get('eh') -

# delete(stopHere=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2568 "View in source") [Ⓣ][1] +🌊 Types: fp.d  -(Function): Delete the current element from its parent in the output. Calls delete even on Arrays. +🔬 Tests: replace  -#### Arguments -1. `stopHere=undefined` *(boolean)*: +

fp.replace(pattern=undefined, replacement=undefined, str=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L21 "View in source") [Ⓣ][1] -#### Returns -*(void)*: +(Function): Replace a substring or regex match in a string with a replacement. ---- - +#### @see - +* fluents/chain able/blob/master/src/deps/reduce/clean.js -

# delete

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7534 "View in source") [Ⓣ][1] +#### @sig -unknown +RegExp|String -> String -> String -> String +#### @Since +v5.0.0 -### @see +#### Arguments +1. `pattern=undefined` *(RegExp|String)*: A regular expression or a substring to match. +2. `replacement=undefined` *(String)*: The string to replace the matches with. +3. `str=undefined` *(String)*: The String to do the search and replacement in. -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -3.0.1 +#### Returns +*(String)*: The result. #### Example ```js -chain.set('moose.canada.eh', true) -chain.set('moose.canada.igloo', true) -//=> Chain - -chain.delete('moose.canada.eh') -//=> Chain - -chain.has('moose.canada.eh') -//=> true +replace('foo', 'bar', 'foo foo foo') //=> 'bar foo foo' +replace(/foo/, 'bar', 'foo foo foo') //=> 'bar foo foo' -//still has moose.canada.igloo -chain.has('moose.canada') -//=> true +// Use the "g" (global) flag to replace all occurrences: +replace(/foo/g, 'bar', 'foo foo foo') //=> 'bar bar bar' ``` --- - - -## `dopemerge.prototype` +🌊 Types: fp.d  - +🔬 Tests: pipe  + +

fp.pipeTwo(f=undefined, g=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L8903 "View in source") [Ⓣ][1] -

# dopemerge.prototype.cloneIfNeeded(value=undefined, optsArg=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1085 "View in source") [Ⓣ][1] +(Function): Performs left-to-right function composition. ONLY CAN PIPE `2` ARGUMENTS -(Function): Defaults to `false`. -If `clone` is `true` then both `x` and `y` are recursively cloned as part of the merge. +#### @see -### @see +* fluents/chain able/blob/master/src/deps/reduce/clean.js -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -2.0.0 +#### @notes + +* The result of pipe is not automatically curried. +* This is a variation, is the internal version with only 2 functions, for now + + +#### @Since +v5.0.0 #### Arguments -1. `value=undefined` *(*)*: value to clone if needed -2. `optsArg=undefined` *(DopeMergeOptions)*: dopemerge options, could contain .clone +1. `f=undefined` *(...Function)*: function first +2. `g=undefined` *(...Function)*: function next #### Returns -*(*)*: cloned or original value +*(Function)*: #### Example ```js -var obj = { eh: true } - -cloneIfNeeded(obj, { clone: true }) === obj -//=> false - -cloneIfNeeded(obj, { clone: false }) === obj -//=> true +var f = R.pipe(Math.pow, R.negate) +f(3, 4) // -(3^4) + 1 ``` --- @@ -3988,41 +5545,63 @@ cloneIfNeeded(obj, { clone: false }) === obj -

# dopemerge.prototype.defaultArrayMerge(target=undefined, source=undefined, optsArg=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1124 "View in source") [Ⓣ][1] +🌊 Types: fp.d  -(Function): The merge will also merge arrays and array values by default. -However, there are nigh-infinite valid ways to merge arrays, -and you may want to supply your own. -You can do this by passing an `arrayMerge` function as an option. +🔬 Tests: pipe  -#### Since -2.0.0 +

fp.pipe(first=undefined, rest=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L9586 "View in source") [Ⓣ][1] + +(Function): Performs left-to-right function composition. The leftmost function may have +any arity; the remaining functions must be unary. +In some libraries this function is named `sequence`. + + +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @sig + +(((a, b, ..., n) -> o), (o -> p), ..., (x -> y), (y -> z)) -> ((a, b, ..., n) -> z) + +#### @symb + +R.pipe(f, g, h)(a, b) = h(g(f(a, b))) + +#### @extends + + + + +#### @Since +v5.0.0 #### Arguments -1. `target=undefined` *(*)*: array merged onto, could be emptyTarget if cloning -2. `source=undefined` *(*)*: original source array -3. `optsArg=undefined` *(*)*: dopemerge options +1. `first=undefined` *(Function)*: function first +2. `rest=undefined` *(...Function)*: function next #### Returns -*(*)*: merged array +*(Function)*: #### Example ```js -function concatMerge(destinationArray, sourceArray, options) { - destinationArray - //=> [1, 2, 3] +var f = R.pipe(Math.pow, R.negate, R.inc) +f(3, 4) // -(3^4) + 1 - sourceArray - //=> [3, 2, 1] - - options - //=> { arrayMerge: concatMerge } +``` +#### Example +```js +var x = v => v + 'x' +var y = v => v + 'y' +var z = v => v + 'z' - return destinationArray.concat(sourceArray) -} -merge([1, 2, 3], [3, 2, 1], { arrayMerge: concatMerge }) -//=> [1, 2, 3, 3, 2, 1] +const xyz = pipe(x, y, z) +/// starts with w, adds x, then y, then z +const wxyz = xyz('w') +//=> 'wxyz' ``` --- @@ -4031,72 +5610,38 @@ merge([1, 2, 3], [3, 2, 1], { arrayMerge: concatMerge }) -🌊 Types: _dopemergelater.d  +

fp.arity(n=undefined, fn=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L14 "View in source") [Ⓣ][1] -

# dopemerge.prototype.dopemerge(obj1=undefined, obj2=undefined, opts=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L67 "View in source") [Ⓣ][1] +(Function): just for `.length` of a function? -(Function): Merge the enumerable attributes of two objects deeply. Merge two objects `x` and `y` deeply, returning a new merged object with the elements from both `x` and `y`. If an element at the same key is present for both `x` and `y`, the value from -`y` will appear in the result. Merging creates a new object, so that neither `x` or `y` are be modified. However, child objects on `x` or `y` are copied over - if you want to copy all values, you must pass `true` to the clone option. +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @todos + +- [ ] keeping this means change uglify... + -### @see +#### @Since +5.0.0 -* fluents/chain able/blob/master/src/deps/reduce/clean.js #### Arguments -1. `obj1=undefined` *(*)*: left -2. `obj2=undefined` *(*)*: right -3. `opts=undefined` *(*)*: dopemerge options +1. `n=undefined` *(number)*: number of arguments +2. `fn=undefined` *(Function)*: function to wrap #### Returns -*(*)*: merged +*(Function)*: function with params #### Example ```js -var x = { - foo: { bar: 3 }, - array: [ - { - does: 'work', - too: [1, 2, 3], - }, - ], -} - -var y = { - foo: { baz: 4 }, - quux: 5, - array: [ - { - does: 'work', - too: [4, 5, 6], - }, - { - really: 'yes', - }, - ], -} - -var expected = { - foo: { - bar: 3, - baz: 4, - }, - array: [ - { - does: 'work', - too: [1, 2, 3, 4, 5, 6], - }, - { - really: 'yes', - }, - ], - quux: 5, -} - -merge(x, y) -//=> expected - +const wan = one => console.log(one) + arity(1, wan) + => function(one => wan(one)) ``` --- @@ -4104,64 +5649,89 @@ merge(x, y) -

# dopemerge.prototype.emptyTarget(val=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1056 "View in source") [Ⓣ][1] +

fp.mapWhere(obj=undefined, predicate=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L10676 "View in source") [Ⓣ][1] -(Function): make a new empty Array or Object for cloning +(Function): Creates an array of values by running each property of `object` thru +`iteratee`. The iteratee is invoked with three arguments: *(value, key, object)*. -#### Since -2.0.0 + +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @Since +5.0.0 #### Arguments -1. `val=undefined` *(*)*: array or object to return an empty one of +1. `obj=undefined` *(Object)*: The object to iterate over. +2. `predicate=undefined` *(Function)*: The function invoked per iteration. #### Returns -*(*)*: depending on the data type of val +*(Array)*: Returns the new mapped array. #### Example ```js -emptyTarget({ eh: true }) -//=> {} - -emptyTarget([1]) -//=> [] +const square = n => n * n +map({ a: 4, b: 8 }, square) +// => [16, 64] (iteration order is not guaranteed) ``` --- + + -

# dopemerge.prototype.isMergeableObj(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1036 "View in source") [Ⓣ][1] +## `from` -(Function): 1: not null object `2`: object toString is not a date or regex + -#### Since -2.0.0 +

from

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2087 "View in source") [Ⓣ][1] -#### Arguments -1. `x=undefined` *(*)*: value to check +unknown -#### Returns -*(boolean)*: -#### Example -```js -isMergeableObj({}) -//=> true +#### @see -isMergeableObj(Object.create(null)) -// => true +* fluents/chain able/blob/master/src/deps/reduce/clean.js +--- -isMergeableObj(new Date()) -//=> false + -isMergeableObj(/eh/) -//=> false + + + + +## `get` + + + +

get(key=undefined, [prop=undefined])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2557 "View in source") [Ⓣ][1] + +Function + + +#### @Since +4.0.0 + +#### Arguments +1. `key=undefined` *(Primitive)*: +2. `[prop=undefined]` *(|Primitive)*: + +#### Returns +*(any)*: -``` --- @@ -4170,38 +5740,27 @@ isMergeableObj(/eh/) -## `dot` +## `getMeta` -

# dot([useDot=undefined])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7395 "View in source") [Ⓣ][1] +

getMeta(_this=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2510 "View in source") [Ⓣ][1] Function -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -3.0.1 +#### @Since +4.0.0 #### Arguments -1. `[useDot=undefined]` *(boolean)*: use dot prop or not +1. `_this=undefined` *(Chain)*: #### Returns -*(DotProp)*: @chainable - -#### Example -```js -const chain = new Target() -chain.dot(false) -chain.set('moose.simple', 1) - -toArr(chain.store.keys()) -//=> ['moose.simple'] +*(Chain)*: -``` --- @@ -4210,106 +5769,75 @@ toArr(chain.store.keys()) -## `encase` +## `has` -

# encase(call=undefined, [encaser=tryCatch])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3907 "View in source") [Ⓣ][1] +

has(key=undefined, [prop=undefined])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2547 "View in source") [Ⓣ][1] Function -#### Since + +#### @Since 4.0.0 #### Arguments -1. `call=undefined` *(Function)*: function to _encase_ -2. `[encaser=tryCatch]` *(|Function)*: function to encase _with_ +1. `key=undefined` *(Primitive)*: +2. `[prop=undefined]` *(|Primitive)*: #### Returns -*(Function)*: -> FunctionObject{onInvalid, onValid, rethrow, call} - -#### Example -```js -const throws = x => { - if (x === false) { - throw new Error('invalid - cannot be false') - } - return true -} -const api = encase(throws) - -api.onValid(console.log) -api.onInvalid(console.error) - -//--- invalid -api.call(false) -//=> 'invalid - cannot be false' - -//--- valid -api.call(true) -//=> 'true' +*(boolean)*: -``` --- - - -## `encase.prototype` +

has

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L10501 "View in source") [Ⓣ][1] - +unknown -

# encase.prototype.error$3(method=undefined, type=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3805 "View in source") [Ⓣ][1] -(Function): enhance an Error, enable rethrowing & better inspection +#### @see +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @Since +3.0.1 -### @see +#### Example +```js +chain.set('one.two', 3) +chain.has('one.two') +//=> true -* fluents/chain able/blob/master/src/deps/reduce/clean.js +``` +--- -### @todos + -- [ ] js stringify if development - -#### Since -4.0.0-alpha.1 + -#### Arguments -1. `method=undefined` *(Primitive)*: method being decorated -2. `type=undefined` *(Type)*: type to validate with + -#### Returns -*(Function): function that returns a decorated TypeError with .inspect & metadata (arg, thrown, meta)* +## `if` -#### Example -```js -const badValidator = x => { - if (x === 'bad') { - throw new Error('bad!') - } -} -const enhancer = enhanceError('eh', badValidator) + -// called by plugins/encase when throws or invalid -let error -let arg = 'bad' -try { - error = badValidator(arg) -} catch (e) { - error = enhancer(arg, e, { metadata: true }) -} +

if()

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7430 "View in source") [Ⓣ][1] -console.log(error) -//=> {[eh]: { type: badValidator, arg: 'bad', json, str, rethrow }} -//=> console.log on DEVELOPMENT +(Function): this is a plugin for building methods schema defaults value to `.type` this defaults values to `.onCall` -``` --- @@ -4318,31 +5846,39 @@ console.log(error) -## `end` +## `includes` -

# end()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L433 "View in source") [Ⓣ][1] +

includes.includes(haystack=undefined, needle=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L19 "View in source") [Ⓣ][1] -(Function): for ending nested chains +Function -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -0.4.0 +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @todos + +- [ ] `~haystack.indexOf(needle)` + +#### Arguments +1. `haystack=undefined` *(Array|string)*: haystack includes needle +2. `needle=undefined` *(*|string)*: needle in haystack #### Returns -*(*)*: +*(boolean)*: needle in haystack #### Example ```js -const parent = 'eh' -const child = newChain(parent) -child.end() -//=> 'eh' +includes('eh', 'e') //=> true +includes('eh', 'nope') //=> false +includes(['eh'], 'eh') //=> true +includes(['eh'], 'nope') //=> false ``` --- @@ -4353,167 +5889,120 @@ child.end() -## `entries` +## `index` -

# entries(reduced=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1413 "View in source") [Ⓣ][1] - -(Function): recursively reduce maps and objects that include reducable data - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @sig +

compose

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1399 "View in source") [Ⓣ][1] -reduced => object => isMap(object) -> reduced; merge(object, reduced) -#### Since -4.0.0 +unknown -#### Arguments -1. `reduced=undefined` *(Object|any)*: merged object and reduced -#### Returns -*(Function): Function(values: Object)* +#### @Since +3.0.0 #### Example ```js -const map = new Map() - map.set('eh', true) - const nested = new Map() - nested.set('reduced', true) +class Target {} +const TargetChain = Chainable.compose(Target) +const chain = new TargetChain() +chain instanceof Target +//=> true - const chain = { - entries() { - return { - nested: reduce(nested), - key: true, - } - }, - } - const reduced = reduce(map) - reduceEntries(reduced)({chain}) - // => { - eh: true, - chain: { - nested: { - reduced: true, - key: true, - }, - }, - } -``` -#### Example -```js -const reducedIgnored = { - canada: { - store: chain, - }, - } - const ignored = reduceEntries(reduced)(reducedIgnored) - //=> { - eh: true, - chain: { - nested: { - reduced: true, - }, - key: true, - }, - } ``` --- - - -## `forEach` +

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2371 "View in source") [Ⓣ][1] + +unknown + +--- + + -

# forEach()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2793 "View in source") [Ⓣ][1] +

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2521 "View in source") [Ⓣ][1] -(Function): adds methods to Traverser +unknown --- - - -## `from` +

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L19 "View in source") [Ⓣ][1] + +unknown + +--- + + -

# from

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1312 "View in source") [Ⓣ][1] +

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2 "View in source") [Ⓣ][1] unknown -### @see +#### @todos -* fluents/chain able/blob/master/src/deps/reduce/clean.js +- [ ] clarify .set vs .call + --- - - - - -## `get` - -

# get(key=undefined, [prop=undefined])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1611 "View in source") [Ⓣ][1] - -Function +

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L9323 "View in source") [Ⓣ][1] -#### Since -4.0.0 +unknown -#### Arguments -1. `key=undefined` *(Primitive)*: -2. `[prop=undefined]` *(|Primitive)*: -#### Returns -*(any)*: +#### @Since +2.0.0 --- - - - - -## `getMeta` - -

# getMeta(_this=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1564 "View in source") [Ⓣ][1] - -Function +

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L10286 "View in source") [Ⓣ][1] -#### Since -4.0.0 +unknown -#### Arguments -1. `_this=undefined` *(Chain)*: -#### Returns -*(Chain)*: +#### @Since +2.0.0 --- @@ -4523,35 +6012,44 @@ Function -## `has` +## `is` + + + +

is.empty(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3064 "View in source") [Ⓣ][1] + +(Function): Returns `true` if the given value is its type's empty value; +`false` otherwise. - -

# has(keyOrValue=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L565 "View in source") [Ⓣ][1] +#### @see -Function +* fluents/chain able/blob/master/src/deps/reduce/clean.js +#### @sig -### @see +a -> Boolean -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -0.3.0 +#### @Since +v0.1.0 #### Arguments -1. `keyOrValue=undefined` *(any)*: key when Map, value when Set +1. `x=undefined` *(*)*: value to check if empty #### Returns *(boolean)*: #### Example ```js -const chain = new Chain() -chain.set('eh', 1).has('eh') -//=> true -chain.has('canada') -//=> false +isEmpty([1, 2, 3]) //=> false +isEmpty([]) //=> true +isEmpty('') //=> true +isEmpty(null) //=> false +isEmpty({}) //=> true +isEmpty({ length: 0 }) //=> false ``` --- @@ -4560,90 +6058,113 @@ chain.has('canada') -

# has(key=undefined, [prop=undefined])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1601 "View in source") [Ⓣ][1] +

is.arrayOf(predicate=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5950 "View in source") [Ⓣ][1] + +(Function): every item in an array matches predicate -Function -#### Since -4.0.0 +#### @Since +4.0.0 was in validatorBuilder #### Arguments -1. `key=undefined` *(Primitive)*: -2. `[prop=undefined]` *(|Primitive)*: +1. `predicate=undefined` *(Function)*: test to pass on every item in an array #### Returns -*(boolean)*: +*(boolean)*: all match predicate + +#### Example +```js +isArrayOf(isTrue)([true, true]) //=> true +isArrayOf(isEmpty)(['']) //=> true +isArrayOf(isBoolean)([true, false, 1, 2, 0]) //=> false +isArrayOf(isString)(['string', Number]) //=> false + +``` --- -

# has

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7501 "View in source") [Ⓣ][1] +

is.exports(obj=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L646 "View in source") [Ⓣ][1] -unknown +(Function): The base implementation of `getTag` without fallbacks for buggy environments. -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -3.0.1 +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @todos + +- [ ] obj[Symbol.toStringTag] +- [ ] run deopt check on this invoking see how many invocations... are needed to inline + + +#### @Since +3.0.0 + +#### Arguments +1. `obj=undefined` *(*)*: The value to `Object.prototype.toString.call(obj)`. + +#### Returns +*(string)*: Returns the `toStringTag`. #### Example ```js -chain.set('one.two', 3) -chain.has('one.two') -//=> true +toS({}) +//=> '[object Object]' + +toS(function() {}) +//=> '[Object Function]' + +getTag([]) +//=> '[object Array]' ``` --- - - -## `if` - - - -

# if()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4536 "View in source") [Ⓣ][1] - -(Function): this is a plugin for building methods schema defaults value to `.type` this defaults values to `.onCall` +

is.hasIn(obj=undefined, prop=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L521 "View in source") [Ⓣ][1] ---- +(Function): isIn, but first checks it is not null - - +#### @extends - +* undefined +* undefined -## `index` - -

# compose

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L711 "View in source") [Ⓣ][1] +#### @Since +5.0.0 -unknown +#### Arguments +1. `obj=undefined` *(Object)*: object to check +2. `prop=undefined` *(any)*: property to check in object -#### Since -3.0.0 +#### Returns +*(boolean)*: #### Example ```js -class Target {} -const TargetChain = Chainable.compose(Target) -const chain = new TargetChain() -chain instanceof Target -//=> true +hasIn({}, 'eh') //=> false +hasIn(null, 'eh') //=> false +hasIn({ eh: true }, 'eh') //=> true ``` --- @@ -4652,21 +6173,31 @@ chain instanceof Target -

# 

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1524 "View in source") [Ⓣ][1] +

is.isArray(arg=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L8 "View in source") [Ⓣ][1] -unknown +Function ---- - +#### @see - +* fluents/chain able/blob/master/src/deps/reduce/clean.js -

# 

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1575 "View in source") [Ⓣ][1] +#### @todos -unknown +- [ ] is-arraylike https://github.com/facebook/immutable-js/blob/master/src/utils/isArrayLike.js + + +#### @Since +3.0.0 + +#### Arguments +1. `arg=undefined` *(*)*: + +#### Returns +*(boolean): isArray(arg)* --- @@ -4674,145 +6205,173 @@ unknown -

# walk(root=undefined, cb=undefined, immutable=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2480 "View in source") [Ⓣ][1] +

is.async(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3204 "View in source") [Ⓣ][1] Function -### @see +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @Since +4.0.0-beta.2 -* fluents/chain able/blob/master/src/deps/reduce/clean.js #### Arguments -1. `root=undefined` *(any)*: root node -2. `cb=undefined` *(Function)*: callback for each -3. `immutable=undefined` *(boolean)*: should mutate or not +1. `x=undefined` *(*)*: value #### Returns -*(any)*: +*(boolean)*: isAsync +#### Example +```js +isAsync(async function() {}) +//=> true +isAsync(new Promise(r => r())) +//=> false +isAsync({}) +//=> false +isAsync(function() {}) + +``` --- -

# copy(src=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2730 "View in source") [Ⓣ][1] +

is.isAsyncish(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3283 "View in source") [Ⓣ][1] + +(Function): async function or promise -Function +#### @extends -### @notes +* undefined +* undefined -* wicked ternary - -### @todos -- [ ] does not respect ObjectDescriptors - +#### @Since +4.0.0-beta.2 + #### Arguments -1. `src=undefined` *(any)*: +1. `x=undefined` *(*)*: value #### Returns -*(any)*: +*(boolean)*: x isAsyncish + +#### Example +```js +isAsyncish(async function() {}) //=> true +isAsyncish(new Promise(r => r())) //=> true +isAsyncish({}) //=> false +isAsyncish(function() {}) //=> false + +``` --- -

# 

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2 "View in source") [Ⓣ][1] - -unknown - - -### @todos +

is.boolean_1(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1675 "View in source") [Ⓣ][1] -- [ ] clarify .set vs .call - ---- +(Function): Checks if `value` is classified as a boolean primitive OR object. - - +#### @see -

# 

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6620 "View in source") [Ⓣ][1] +* fluents/chain able/blob/master/src/deps/reduce/clean.js -unknown +#### @extends -#### Since -2.0.0 +* undefined +* undefined +* undefined ---- - - +#### @Since +3.0.0 -

# 

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7286 "View in source") [Ⓣ][1] +#### Arguments +1. `x=undefined` *(*)*: value -unknown +#### Returns +*(boolean)*: isBoolean -#### Since -2.0.0 +#### Example +```js +isBoolean(false) +//=> true +isBoolean(new Boolean(1)) +//=> true +isBoolean(1) +//=> false +isBoolean('') +//=> false +``` --- - - -## `is.prototype` - - - -

# is.prototype.boolean_1(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L972 "View in source") [Ⓣ][1] +

is.booleanPrimitive(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1637 "View in source") [Ⓣ][1] -(Function): Checks if `value` is classified as a boolean primitive or object. +(Function): Checks if `value` is classified as a boolean primitive NOT object. -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js +* fluents/chain able/blob/master/src/deps/reduce/clean.js -### @notes +#### @notes * could also have typeof x === 'boolean' || (/true|false/).test(x) -### @extends +#### @extends * undefined * undefined -#### Since -3.0.0 + +#### @Since +5.0.0-beta.4 #### Arguments 1. `x=undefined` *(*)*: value #### Returns -*(boolean)*: isBoolean +*(boolean)*: isBooleanPrimitive #### Example ```js -isBoolean(false) -//=> true -isBoolean(new Boolean(1)) +isBooleanPrimitive(false) //=> true -isBoolean(1) +isBooleanPrimitive(new Boolean(1)) //=> false -isBoolean('') + +isBooleanPrimitive(1) +//=> false +isBooleanPrimitive('') //=> false ``` @@ -4822,12 +6381,20 @@ isBoolean('') -

# is.prototype.date(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L940 "View in source") [Ⓣ][1] +

is.date(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1597 "View in source") [Ⓣ][1] Function -#### Since + +#### @extends + + + + +#### @Since 3.0.0 #### Arguments @@ -4868,11 +6435,107 @@ class Eh extends Date() -

# is.prototype.error$1(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2043 "View in source") [Ⓣ][1] +

is.isDot(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L10273 "View in source") [Ⓣ][1] + +Function + + +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @todos + +- [ ] update with conditional + + +#### @Since +3.0.0 + +#### Arguments +1. `x=undefined` *(*)*: value to check + +#### Returns +*(boolean)*: x isDot + +#### Example +```js +isDot('eh.oh') //=> true +isDot('eh') //=> false +isDot(['eh', 'oh']) //=> true + +``` +--- + + + + + +

is.isEnumerable(obj=undefined, prop=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L21 "View in source") [Ⓣ][1] + +(Function): object at property is enumerable + + +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @todos + +- [ ] use fp/call + + +#### @Since +3.0.0 + +#### Arguments +1. `obj=undefined` *(*|Object)*: +2. `prop=undefined` *(*|string)*: + +#### Returns +*(boolean)*: obj[prop] is enumerable + +#### Example +```js +const obj = { eh: true } +isEnumerable(obj, 'eh') +//=> true + +const objPropEnumerable = isEnumerable(obj) +objPropEnumerable('eh') +//=> true + +Object.defineProperty(obj, 'length', { + enumerable: false, + value: () => Object.keys(obj).length, +}) +isEnumerable(obj, 'length') +//=> false + +``` +--- + + + + + +

is.error$1(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3115 "View in source") [Ⓣ][1] Function + +#### @Since +4.0.0 + #### Arguments 1. `x=undefined` *(*)*: value @@ -4911,12 +6574,15 @@ class Eh extends Error() -

# is.prototype._false(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L257 "View in source") [Ⓣ][1] +

is._false(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L856 "View in source") [Ⓣ][1] Function -#### Since + +#### @Since 4.0.0-alpha.1 #### Arguments @@ -4941,19 +6607,26 @@ isFalse('') - + + +

is._function(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L22 "View in source") [Ⓣ][1] + +(Function): Checks if `value` is classified as a `Function` object. -

# is.prototype._function(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L178 "View in source") [Ⓣ][1] -(Function): Checks if `value` is classified as a `Function` object. +#### @see +* fluents/chain able/blob/master/src/deps/reduce/clean.js -### @notes +#### @notes * || x instanceof Function -#### Since + +#### @Since 3.0.0 #### Arguments @@ -4985,16 +6658,49 @@ isFunction(/abc/) -

# is.prototype.(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1471 "View in source") [Ⓣ][1] +

is.isIn(obj=undefined, prop=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L494 "View in source") [Ⓣ][1] + +(Function): prop is in Object(obj) + + +#### @Since +5.0.0 + +#### Arguments +1. `obj=undefined` *(Object)*: object to check property of +2. `prop=undefined` *(Primitive)*: property in obj + +#### Returns +*(boolean)*: property + +#### Example +```js +isIn({ eh: true }, 'eh') //=> true +isIn({ eh: true }, 'oh') //=> false + +``` +--- + + + + + +

is.(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2308 "View in source") [Ⓣ][1] Function -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @Since 3.0.0 #### Arguments @@ -5040,16 +6746,19 @@ class Eh extends Set() -

# is.prototype.map(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L119 "View in source") [Ⓣ][1] +

is.map(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L694 "View in source") [Ⓣ][1] (Function): Checks if `value` is classified as a `Map` object. -### @see +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since +#### @Since 3.0.0 #### Arguments @@ -5095,17 +6804,20 @@ class Eh extends Map() -

# is.prototype.mapish(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5124 "View in source") [Ⓣ][1] +

is.mapish(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L8022 "View in source") [Ⓣ][1] Function -### @extends +#### @extends -#### Since + +#### @Since 3.0.0 #### Arguments @@ -5135,12 +6847,19 @@ isMapish(1) -

# is.prototype.matcher(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3083 "View in source") [Ⓣ][1] +

is.matcher(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5722 "View in source") [Ⓣ][1] Function -#### Since + +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @Since 3.0.0 #### Arguments @@ -5169,56 +6888,15 @@ isMatcher('.*') -

# is.prototype.notEmptyArray(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7657 "View in source") [Ⓣ][1] - -(Function): value is an Array, with at least `1` value - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @extends - - - -#### Since -4.0.0-alpha.1 - -#### Arguments -1. `x=undefined` *(*)*: value - -#### Returns -*(boolean)*: isNotEmptyArray - -#### Example -```js -isNotEmptyArray(new Array(3)) -//=> true -isNotEmptyArray([1, 2, 3]) -//=> true - -isNotEmptyArray(new Array()) -//=> false -isNotEmptyArray([]) -//=> false -isNotEmptyArray(new Map()) -//=> false - -``` ---- - - - - - -

# is.prototype._null(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L775 "View in source") [Ⓣ][1] +

is._null(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L188 "View in source") [Ⓣ][1] Function -#### Since + +#### @Since 3.0.0 #### Arguments @@ -5250,16 +6928,19 @@ isNull(1) -

# is.prototype.nullOrUndefined(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L814 "View in source") [Ⓣ][1] +

is.nullOrUndefined(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L235 "View in source") [Ⓣ][1] (Function): Checks if `value` is `null` or `undefined`. -### @see +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since +#### @Since 4.0.0-alpha.1 #### Arguments @@ -5295,17 +6976,19 @@ isNullOrUndefined(false) -

# is.prototype.number(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2086 "View in source") [Ⓣ][1] +

is.number(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5491 "View in source") [Ⓣ][1] Function -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js +* fluents/chain able/blob/master/src/deps/reduce/clean.js -### @notes +#### @notes * was not needed except for abstract == const isObj = require('./obj') @@ -5315,7 +6998,13 @@ Function : (/^0x[0-9a-f]+$/i).test(x) || (/^[-+]?(?:\d+(?:\.\d*)?|\.\d+)(e[-+]?\d+)?$/).test(x)) -#### Since + +#### @extends + + + + +#### @Since 3.0.0 #### Arguments @@ -5328,6 +7017,8 @@ Function ```js isNumber(1) //=> true +isNumber(new Number(1)) +//=> true isNumber(Number(1)) //=> true isNumber(NaN) @@ -5353,21 +7044,76 @@ isNumber(false) -

# is.prototype.obj(value=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2009 "View in source") [Ⓣ][1] +

is.numberPrimitive(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3320 "View in source") [Ⓣ][1] + +Function + + +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @Since +3.0.0 + +#### Arguments +1. `x=undefined` *(*)*: value + +#### Returns +*(boolean)*: isNumberPrimitive + +#### Example +```js +isNumberPrimitive(1) +//=> true +isNumberPrimitive(Number(1)) +//=> true +isNumberPrimitive(NaN) +//=> true +isNumberPrimitive(new Number(1)) +//=> false + +isNumberPrimitive(null) +//=> false +isNumberPrimitive(undefined) +//=> false +isNumberPrimitive(void 0) +//=> false +isNumberPrimitive({}) +//=> false +isNumberPrimitive('') +//=> false +isNumberPrimitive(false) +//=> false + +``` +--- + + + + + +

is.obj(value=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2176 "View in source") [Ⓣ][1] Function -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js +* fluents/chain able/blob/master/src/deps/reduce/clean.js -### @notes +#### @notes * Object.prototype.toString.call(val) === '[object Object]' -#### Since + +#### @Since 3.0.0 #### Arguments @@ -5393,46 +7139,211 @@ isObject(null) ``` --- - + + + + +

is.objTypeof(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1437 "View in source") [Ⓣ][1] + +Function + + +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @Since +3.0.0 + +#### Arguments +1. `x=undefined` *(*)*: value + +#### Returns +*(boolean)*: isObjLoose + +#### Example +```js +isObjLoose(new Object()) +//=> true +isObjLoose({}) +//=> true +isObjLoose(Object.create(null)) +//=> true +isObjLoose(null) +//=> true + +isObjLoose(new Set()) +//=> false +isObjLoose(function() {}) +//=> false +isObjLoose('') +//=> false +isObjLoose(1) +//=> false + +``` +--- + + + + + +

is.objNotNull(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L21 "View in source") [Ⓣ][1] + +Function + + +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @todos + +- [ ] !Array.isArray + + +#### @extends + + + + +#### @Since +3.0.0 + +#### Arguments +1. `x=undefined` *(*)*: value + +#### Returns +*(boolean)*: isObjNotNull + +#### Example +```js +isObjNotNull(new Object()) +//=> true +isObjNotNull({}) +//=> true +isObjNotNull(Object.create(null)) +//=> true +isObjNotNull(null) +//=> false + +isObjNotNull(new Set()) +//=> false +isObjNotNull(function() {}) +//=> false +isObjNotNull('') +//=> false +isObjNotNull(1) +//=> false + +``` +--- + + + + + +

is.isObjPure(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5644 "View in source") [Ⓣ][1] + +Function + + +#### @extends + +* undefined +* undefined +* undefined +* undefined + + + +#### @Since +3.0.0 + +#### Arguments +1. `x=undefined` *(*)*: value to check + +#### Returns +*(boolean)*: is obj & !null & !undefined & !array & !function + +#### Example +```js +isObjPure(function() {}) +//=> false +isObjPure(null) +//=> false +isObjPure([]) +//=> false + +isObjPure({}) +//=> true + +``` +--- + + + + + +

is.objWithKeys(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5689 "View in source") [Ⓣ][1] + +Function + + +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @todos - +- [ ] @NOTE need to be more careful, needs to check for vanilla objects, not native ones since e.g. Error has no keys + -

# is.prototype.objLoose(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L748 "View in source") [Ⓣ][1] +#### @extends -Function -### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since +#### @Since 3.0.0 #### Arguments 1. `x=undefined` *(*)*: value #### Returns -*(boolean)*: isObjLoose +*(boolean)*: isObjWithKeys #### Example ```js -isObjLoose(new Object()) -//=> true -isObjLoose({}) -//=> true -isObjLoose(Object.create(null)) -//=> true -isObjLoose(null) +isObjWithKeys({ eh: true }) //=> true - -isObjLoose(new Set()) +isObjWithKeys({}) //=> false -isObjLoose(function() {}) +isObjWithKeys(new Object()) //=> false -isObjLoose('') +isObjWithKeys(Object.create(null)) //=> false -isObjLoose(1) +isObjWithKeys(null) +//=> false +isObjWithKeys(new Set()) +//=> false +isObjWithKeys(function() {}) +//=> false +isObjWithKeys('') +//=> false +isObjWithKeys(1) //=> false ``` @@ -5442,52 +7353,47 @@ isObjLoose(1) -

# is.prototype.objStrict(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L856 "View in source") [Ⓣ][1] - -Function - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @todos +

is.promise(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3246 "View in source") [Ⓣ][1] -- [ ] !Array.isArray - +(Function): is a Promise -### @extends +#### @see +* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -3.0.0 +#### @Since +4.0.0-beta.2 #### Arguments 1. `x=undefined` *(*)*: value #### Returns -*(boolean)*: isObjStrict +*(boolean)*: x isPromise #### Example ```js -isObjStrict(new Object()) +isPromise(new Promise(r => r)) //=> true -isObjStrict({}) -//=> true -isObjStrict(Object.create(null)) -//=> true -isObjStrict(null) -//=> false +isPromise(async function() {}) +//=> false // on some environments, true -isObjStrict(new Set()) +isPromise({}) +//=> false +isPromise(Object.create(null)) //=> false -isObjStrict(function() {}) +isPromise(null) //=> false -isObjStrict('') +isPromise(new Set()) //=> false -isObjStrict(1) +isPromise(function() {}) +//=> false +isPromise('') +//=> false +isPromise(1) //=> false ``` @@ -5497,49 +7403,43 @@ isObjStrict(1) -

# is.prototype.objWithKeys(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3038 "View in source") [Ⓣ][1] - -Function +

is.isPrototypeOf(haystack=undefined, needle=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L21 "View in source") [Ⓣ][1] +(Function): check if arg `1` is prototype of arg `2` -### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js +#### @see -### @extends +* fluents/chain able/blob/master/src/deps/reduce/clean.js +#### @todos +- [ ] curry2 + -#### Since +#### @Since 3.0.0 #### Arguments -1. `x=undefined` *(*)*: value +1. `haystack=undefined` *(*|Object)*: check needle against +2. `needle=undefined` *(*|Object)*: is prototype of haystack #### Returns -*(boolean)*: isObjWithKeys +*(boolean)*: needle isPrototypeOf haystack #### Example ```js -isObjWithKeys({ eh: true }) -//=> true -isObjWithKeys({}) -//=> false -isObjWithKeys(new Object()) -//=> false -isObjWithKeys(Object.create(null)) -//=> false -isObjWithKeys(null) -//=> false -isObjWithKeys(new Set()) -//=> false -isObjWithKeys(function() {}) -//=> false -isObjWithKeys('') -//=> false -isObjWithKeys(1) -//=> false +class Eh extends Function {} +class Canada extends Eh {} +isPrototypeOf(Eh, Function) //=> true +isPrototypeOf(Canada, Function) //=> true +isPrototypeOf(Eh, Date) //=> false + +isPrototypeOf({}, Object) //=> true +isPrototypeOf({}, Array) //=> false ``` --- @@ -5548,27 +7448,30 @@ isObjWithKeys(1) -

# is.prototype.real(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2999 "View in source") [Ⓣ][1] +

is.real(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5573 "View in source") [Ⓣ][1] Function -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js +* fluents/chain able/blob/master/src/deps/reduce/clean.js -### @notes +#### @notes * eslint-disable-next-line no-self-compare && x !== x -### @extends +#### @extends -#### Since + +#### @Since 3.0.0 #### Arguments @@ -5611,12 +7514,15 @@ isReal(1) -

# is.prototype._true(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L886 "View in source") [Ⓣ][1] +

is._true(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1535 "View in source") [Ⓣ][1] Function -#### Since + +#### @Since 4.0.0-alpha.1 #### Arguments @@ -5643,21 +7549,19 @@ isTrue('') -

# is.prototype._undefined(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L52 "View in source") [Ⓣ][1] +

is._undefined(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L147 "View in source") [Ⓣ][1] (Function): Checks if `value` is `undefined`. -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js +* fluents/chain able/blob/master/src/deps/reduce/clean.js -### @notes - -* || typeof x === 'undefined' - -#### Since +#### @Since 4.0.0-alpha.1 #### Arguments @@ -5693,21 +7597,67 @@ isUndefined(false) -

# is.prototype.string(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L235 "View in source") [Ⓣ][1] +

is.primitive$2(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3360 "View in source") [Ⓣ][1] + +(Function): Checks if `value` is classified as a **primitive** +`(number|string|boolean|null|undefined)` + + +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @Since +4.0.0 was in another file + +#### Arguments +1. `x=undefined` *(*)*: The value to check. + +#### Returns +*(boolean)*: x is number|string|boolean|null|undefined + +#### Example +```js +isPrimitive('abc') // => true +isPrimitive(1) // => true +isPrimitive('') // => true +isPrimitive(null) // => true +isPrimitive(undefined) // => true +isPrimitive(void 0) // => true + +isPrimitive(new String('abc')) // => false +isPrimitive([]) // => false +isPrimitive(() => {}) // => false +isPrimitive({}) // => false + +``` +--- + + + + + +

is.string(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L833 "View in source") [Ⓣ][1] (Function): Checks if `value` is classified as a `String` primitive or object. -### @see +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js -* fluents/chain able/blob/master/src/deps/reduce/clean.js +#### @extends -### @extends -#### Since +#### @Since 3.0.0 #### Arguments @@ -5734,16 +7684,19 @@ isString(1) -

# is.prototype.stringOrNumber(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2949 "View in source") [Ⓣ][1] +

is.stringOrNumber(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5520 "View in source") [Ⓣ][1] (Function): Checks if `value` is classified as a `String` primitive or object. -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @Since 3.0.0 #### Arguments @@ -5767,16 +7720,19 @@ isString(1) -

# is.prototype.stringPrimitive(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L206 "View in source") [Ⓣ][1] +

is.stringPrimitive(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L797 "View in source") [Ⓣ][1] (Function): Checks if `value` is classified as a `String` **primitive**. -### @see +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since +#### @Since 3.0.0 #### Arguments @@ -5803,12 +7759,15 @@ isString(1) -

# is.prototype.symbol(value=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3059 "View in source") [Ⓣ][1] +

is.symbol(value=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3143 "View in source") [Ⓣ][1] (Function): Checks if `value` is classified as a `Symbol` primitive or object. -#### Since + +#### @Since 4.0.0 #### Arguments @@ -5830,28 +7789,35 @@ isSymbol('abc') + + -

# is.prototype.toS(value=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L77 "View in source") [Ⓣ][1] +## `is.index$12` -(Function): The base implementation of `getTag` without fallbacks for buggy environments. + +🌊 Types: is.d  -### @see +* 🔬 Tests: empty  +* 🔬 Tests: index  +* 🔬 Tests: is  +* 🔬 Tests: json  +* 🔬 Tests: not-exported-in-entry  +* 🔬 Tests: primitives  +* 🔬 Tests: simple  -* fluents/chain able/blob/master/src/deps/reduce/clean.js +

is.index$12

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5746 "View in source") [Ⓣ][1] -### @todos +Object -- [ ] obj[Symbol.toStringTag] - -#### Arguments -1. `value=undefined` *(*)*: The value to query. -#### Returns -*(string)*: Returns the `toStringTag`. +#### @see +* fluents/chain able/blob/master/src/deps/reduce/clean.js --- @@ -5860,26 +7826,21 @@ isSymbol('abc') -## `is.prototype.index$12` +## `isNotRealOrIsEmpty` -🌊 Types: is.d  - -* 🔬 Tests: index  -* 🔬 Tests: is  -* 🔬 Tests: primitives  -* 🔬 Tests: simple  - -

# is.prototype.index$12

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3100 "View in source") [Ⓣ][1] +

isNotRealOrIsEmpty

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5973 "View in source") [Ⓣ][1] -Object +Function -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js +* fluents/chain able/blob/master/src/deps/reduce/clean.js --- @@ -5888,22 +7849,46 @@ Object -## `isArray` +## `iteratable` -

# array

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L864 "View in source") [Ⓣ][1] +

iteratable(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3412 "View in source") [Ⓣ][1] -Function +(Function): is able to be iterated on -### @see +#### @extends -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -3.0.0 +* undefined +* undefined +* undefined +* undefined +* undefined +* undefined +* undefined +* undefined + + +#### Arguments +1. `x=undefined` *(*)*: node is iteratable + +#### Returns +*(boolean)*: x isIteratable +#### Example +```js +isIteratable([]) //=> true +isIteratable({}) //=> true +isIteratable(new Date()) //=> false +isIteratable(Symbol('eh')) //=> false +isIteratable(new Promise(r => r())) //=> false +isIteratable(new Error('eh')) //=> false + +``` --- @@ -5912,32 +7897,55 @@ Function -## `isRoot` +## `keysObjOrArray` -

# isRoot

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2537 "View in source") [Ⓣ][1] +

keysObjOrArray(obj=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L22 "View in source") [Ⓣ][1] -(Boolean): Whether the present node is the root node +(Function): Creates an array of the own enumerable property names of `object`. +**Note:** Non-object values are coerced to objects. See the +[ES spec](http://ecma-international.org/ecma-262/7.0/#sec-object.keys) +for more details. ---- - +#### @see - +* fluents/chain able/blob/master/src/deps/reduce/clean.js - +#### @todos -## `key` +- [ ] https://github.com/lodash/lodash/blob/master/.internal/arrayLikeKeys.js + - +#### @Since +0.1.0 -

# key

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2532 "View in source") [Ⓣ][1] +#### Arguments +1. `obj=undefined` *(Object)*: The object to query. -unknown +#### Returns +*(Array)*: Returns the array of property names. +#### Example +```js +function Foo() { + this.a = 1 + this.b = 2 +} + +Foo.prototype.c = 3 + +keys(new Foo()) +// => ['a', 'b'] (iteration order is not guaranteed) + +keys('hi') +// => ['0', '1'] + +``` --- @@ -5946,15 +7954,40 @@ unknown -## `level` +## `lengthFromZero` -

# level

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2542 "View in source") [Ⓣ][1] +

lengthFromZero(obj=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2970 "View in source") [Ⓣ][1] + +(Function): when length > `1`, use length-1 +otherwise, when length == `1`, use `0` +default, use length + + +#### @todos + +- [ ] lense to use an object, or transform it to one with .length? + const len = prop('length') + // when isObj, use len, otherwise, value + const coerceLength = lense([isObj, len]) + +#### Arguments +1. `obj=undefined` *(Array|Object|number)*: with length -(number): Depth of the node within the traversal +#### Returns +*(number)*: obj length from `0` + +#### Example +```js +lengthFromZero([1]) //=> 1 +lengthFromZero([]) //=> 0 +lengthFromZero([1, 2, 3]) //=> 2 +``` --- @@ -5967,22 +8000,25 @@ unknown -

# markForGarbageCollection(obj=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4268 "View in source") [Ⓣ][1] +

markForGarbageCollection(obj=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7135 "View in source") [Ⓣ][1] (Function): remove all methods, mark for garbage collection -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js +* fluents/chain able/blob/master/src/deps/reduce/clean.js -### @todos +#### @todos - [ ] blacklist = [] param - [ ] put all GC events into a cached map and debounce the operation -#### Since + +#### @Since 4.0.0 #### Arguments @@ -6012,25 +8048,28 @@ obj -## `matcher.prototype` +## `matcher` -

# matcher.prototype.escapeStringRegex(str=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L20 "View in source") [Ⓣ][1] +

matcher.escapeStringRegex(str=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L19 "View in source") [Ⓣ][1] Function -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js +* fluents/chain able/blob/master/src/deps/reduce/clean.js -### @notes +#### @notes * also as const escapeStringRegexp = require('escape-string-regexp'); -#### Since + +#### @Since 3.0.0 #### Arguments @@ -6052,12 +8091,15 @@ new RegExp(escaped) -

# matcher.prototype.make(pattern=undefined, shouldNegate=undefined, alphaOmega=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6268 "View in source") [Ⓣ][1] +

matcher.make(pattern=undefined, shouldNegate=undefined, alphaOmega=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L9032 "View in source") [Ⓣ][1] (Function): turn any string[], function[], or RegExp[] into a matcher -#### Since + +#### @Since 3.0.0 #### Arguments @@ -6115,16 +8157,19 @@ matcher.make(noName, true, true) -

# matcher.prototype.matcher(inputs=undefined, patterns=undefined, shouldNegate=undefined, alphaOmega=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6344 "View in source") [Ⓣ][1] +

matcher.matcher(inputs=undefined, patterns=undefined, shouldNegate=undefined, alphaOmega=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L9108 "View in source") [Ⓣ][1] (Function): same as .make but also accepts inputs, and returns an array -### @see +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since +#### @Since 3.0.0 #### Arguments @@ -6179,17 +8224,19 @@ matcher({ test: x => x === 'kinga' }, 'nope') 🔬 Tests: matcher  -

# matcher.prototype.matcher

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6219 "View in source") [Ⓣ][1] +

matcher.matcher

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L8983 "View in source") [Ⓣ][1] unknown -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js +* fluents/chain able/blob/master/src/deps/reduce/clean.js -### @symb +#### @symb 🎯 --- @@ -6198,13 +8245,15 @@ unknown -

# matcher.prototype.toRegexp(str=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6203 "View in source") [Ⓣ][1] +

matcher.toRegexp(str=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L8963 "View in source") [Ⓣ][1] Function -### @extends +#### @extends @@ -6234,22 +8283,25 @@ toRegExp('*') -

# merge([obj2=undefined])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5232 "View in source") [Ⓣ][1] +

merge([obj2=undefined])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L8135 "View in source") [Ⓣ][1] (Function): merges object in, goes through all keys, checks cbs, dopemerges -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js +* fluents/chain able/blob/master/src/deps/reduce/clean.js -### @todos +#### @todos - [ ] issue here if we extend without shorthands & we want to merge existing values... :s -#### Since + +#### @Since 1.0.0 #### Arguments @@ -6273,21 +8325,24 @@ chain.entries() -

# merge(obj=undefined, [handleMergeFn=undefined])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5553 "View in source") [Ⓣ][1] +

merge(obj=undefined, [handleMergeFn=undefined])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L8467 "View in source") [Ⓣ][1] (Function): merges an object with the current store -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js +* fluents/chain able/blob/master/src/deps/reduce/clean.js -### @todos +#### @todos - [ ] needs to pass in additional opts somehow... -#### Since + +#### @Since 0.4.0 #### Arguments @@ -6305,45 +8360,16 @@ chain.merge({ eh: [2] }) chain.get('eh') // => [1, 2] -``` -#### Example -```js -const chain = new Chain() - chain.set('emptyArr', []) - chain.merge({emptyArr: []}, mergeChain => - mergeChain.onExisting((a, b) => []).merger((a, b) => []).merge() - ) - chain.get('emptyArr').length) - //=> 0 -``` ---- - - - - - -

# merge(arr=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5665 "View in source") [Ⓣ][1] - -(Function): merge any Array/Set/Iteratable/Concatables into the array, at the end - -#### Since -0.4.0 - -#### Arguments -1. `arr=undefined` *(Array|Concatable|Set)*: values to merge in and append - -#### Returns -*(ChainedSet)*: @chainable - +``` #### Example ```js -const people = new ChainedSet() -people.add('sam').add('sue').prepend('first').merge(['merged']) - -for (let name of people) console.log(name) -//=> first, sam, sue, merged - +const chain = new Chain() + chain.set('emptyArr', []) + chain.merge({emptyArr: []}, mergeChain => + mergeChain.onExisting((a, b) => []).merger((a, b) => []).merge() + ) + chain.get('emptyArr').length) + //=> 0 ``` --- @@ -6357,12 +8383,15 @@ for (let name of people) console.log(name) -

# meta(key=undefined, [prop=undefined], [value=undefined])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1648 "View in source") [Ⓣ][1] +

meta(key=undefined, [prop=undefined], [value=undefined])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2594 "View in source") [Ⓣ][1] (Function): a single easily minifiable function, dynamically setting & getting depending on arguments to avoid nested property accessing only instantiating when values are **addded** -#### Since + +#### @Since 4.0.0 #### Arguments @@ -6385,16 +8414,19 @@ for (let name of people) console.log(name) -

# method(names=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5517 "View in source") [Ⓣ][1] +

method(names=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L8431 "View in source") [Ⓣ][1] (Function): the way to easily start building methods when using chainable instances -### @see +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since +#### @Since 4.0.0 #### Arguments @@ -6424,8 +8456,12 @@ chain.get('eh') -

# methodEncasingFactory(name=undefined, parent=undefined, built=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3956 "View in source") [Ⓣ][1] +🌊 Types: deps.encase.d  + +

methodEncasingFactory(name=undefined, parent=undefined, built=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6789 "View in source") [Ⓣ][1] (Function): 3 steps 0. enhance error @@ -6433,10 +8469,11 @@ chain.get('eh') 2. build a function to call onInvalid or onInvalid depending -### @symb +#### @symb ⛑🏭 -#### Since + +#### @Since 4.0.0 #### Arguments @@ -6461,36 +8498,38 @@ methodEncasingFactory('eh', {}, { onSet: console.log }) -## `node` +## `noop` -

# node

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2510 "View in source") [Ⓣ][1] - -(Array): The present node on the recursive walk - ---- - - +

noop()

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4 "View in source") [Ⓣ][1] - +Function - -## `node_` +#### @see - +* fluents/chain able/blob/master/src/deps/reduce/clean.js -

# node_

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2516 "View in source") [Ⓣ][1] +#### @Since +5.0.0 -Array +#### Returns +*(void)*: +#### Example +```js +noop -### @see +``` +#### Example +```js +noop() -* fluents/chain able/blob/master/src/deps/reduce/clean.js +``` --- @@ -6499,32 +8538,36 @@ Array -## `parent` +## `notNested` -

# parent

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2526 "View in source") [Ⓣ][1] - -unknown - ---- - - +

notNested(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5600 "View in source") [Ⓣ][1] - +Function - -## `path` +#### @Since +5.0.0 - +#### Arguments +1. `x=undefined` *(*)*: value to check -

# path

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2521 "View in source") [Ⓣ][1] +#### Returns +*(boolean)*: x isNotNested -(Array): An array of string keys from the root to the present node +#### Example +```js +isNotNested('') //=> true +isNotNested(true) //=> true +isNotNested(new RegExp()) //=> true +isNotNested(new Error('eh')) //=> false +isNotNested(null) //=> false +``` --- @@ -6537,50 +8580,48 @@ unknown -

# paths(key=undefined, value=undefined, longest=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2814 "View in source") [Ⓣ][1] +

paths(key=undefined, value=undefined, [longest=undefined])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5283 "View in source") [Ⓣ][1] (Function): gathers dot.prop from any value, with a prefixed/base key -### @notes - -* had `onlyLongest` & `asString` but can just .join(',') to match - -#### Since -4.0.0 - -#### Arguments -1. `key=undefined` *(Primitive)*: -2. `value=undefined` *(Traversable)*: -3. `longest=undefined` *(|boolean)*: - -#### Returns -*(*)*: paths - ---- - - +#### @see - +* fluents/chain able/blob/master/src/deps/reduce/clean.js - +#### @notes -## `post` +* had `onlyLongest` & `asString` but can just .join(',') to match + - +#### @todos -

# post(fn=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2621 "View in source") [Ⓣ][1] +- [ ] should build a trie if doing this + -(Function): Call this function after each of the children are traversed. +#### @Since +4.0.0 #### Arguments -1. `fn=undefined` *(Function)*: +1. `key=undefined` *(Primitive)*: prefixing key for the paths, root path/key +2. `value=undefined` *(Traversable)*: traversable value to extract paths from +3. `[longest=undefined]` *(|boolean)*: optionally filter to keep only longest/deepest paths #### Returns -*(any)*: +*(*)*: paths[] + +#### Example +```js +dotPropPaths('', { oh: { eh: true } }) +//=> ['oh.eh'] +dotPropPaths('moose', { oh: { eh: true } }) +//=> ['moose.oh.eh'] + +``` --- @@ -6589,119 +8630,105 @@ unknown -## `pre` +## `pooler` -

# pre(fn=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2613 "View in source") [Ⓣ][1] +

pooler.addPoolingTo(CopyConstructor=undefined, pooler=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4358 "View in source") [Ⓣ][1] + +(Function): Augments `CopyConstructor` to be a poolable class, augmenting only the class +itself *(statically)* not adding any prototypical fields. Any CopyConstructor +you give this may have a `poolSize` property, and will look for a +prototypical `destructor` on instances. + -(Function): Call this function before each of the children are traversed. +#### @Since +5.0.0 #### Arguments -1. `fn=undefined` *(Function)*: +1. `CopyConstructor=undefined` *(Function|Object)*: Constructor that can be used to reset. +2. `pooler=undefined` *(Function)*: Customizable pooler. #### Returns -*(any)*: +*(Object)*: enhanced constructor, decorated with pooler ---- +#### Example +```js +class Eh {} +addPoolingTo(Eh) // can optionally pass in pooler as second arg +//=> Eh.instancePool = [] +//=> Eh.getPooled = pooler || singleArgumentPooler +//=> Eh.poolSize = 10 +//=> Eh.release = standardReleaser - +``` +--- -## `prepend` - - +

pooler.oneArgumentPooler(copyFieldsFrom=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4320 "View in source") [Ⓣ][1] -

# prepend(value=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5641 "View in source") [Ⓣ][1] +(Function): Static poolers. Several custom versions for each potential number of +arguments. A completely generic pooler is easy to implement, but would +require accessing the `arguments` object. In each of these, `this` refers to +the Class itself, not an instance. If any others are needed, simply add them +here, or in their own files. -(Function): inserts the value at the **beginning** of the Set -#### Since -0.4.0 +#### @Since +5.0.0 #### Arguments -1. `value=undefined` *(any)*: any value to add to **beginning** the store +1. `copyFieldsFrom=undefined` *(Object)*: obj with instance pool #### Returns -*(ChainedSet)*: @chainable +*(Object)*: instance of Klass #### Example ```js -const people = new ChainedSet() -people.add('sue').prepend('first') - -for (let name of people) console.log(name) -//=> first, sue +class Eh {} +addPoolingTo(Eh) +const eh = Eh.getPooled() //=> oneArgumentPooler(Eh) +eh.release() ``` --- - - - - -## `prototype[iterator]` - -🔬 Tests: iteration  - -

# prototype[iterator]()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L391 "View in source") [Ⓣ][1] - -(generator): Iterator for looping values in the store - +

pooler.standardReleaser(instance=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4282 "View in source") [Ⓣ][1] -### @see +(Function): call destructor on a pooled instance, put it back in the pool -* fluents/chain able/blob/master/src/deps/reduce/clean.js -### @notes +#### @Since +5.0.0 -* assigned to a variable so buble ignores it - -#### Since -0.5.0 +#### Arguments +1. `instance=undefined` *(Object)*: call destructor #### Returns -*(Object)*: {value: undefined | any, done: true | false} - -#### Example -```js -const chain = new Chain().set('eh', 1) -for (var [key, val] of chain) console.log({ [key]: val }) -//=> {eh: 1} +*(void)*: -``` -#### Example -```js -*[Symbol.iterator](): void { for (const item of this.store) yield item } -``` #### Example ```js -const { ChainedSet } = require('chain-able') -const set = new ChainedSet() -set.add('eh') - -for (const arr of set) { - const [key, val] = arr - - key - //=> 0 - - val - //=> 'eh' - - arr.length - //=> 2 -} +class Eh {} +addPoolingTo(Eh) +const eh = Eh.getPooled() +eh.release() ``` --- @@ -6712,45 +8739,27 @@ for (const arr of set) { -## `prototype[primitive]` +## `pooler.// const pooler` -

# prototype[primitive](hint=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L646 "View in source") [Ⓣ][1] - -Function - +🔬 Tests: pooler  -### @see +

pooler.// const pooler

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3 "View in source") [Ⓣ][1] -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -1.0.2 +Object -#### Arguments -1. `hint=undefined` *(string)*: enum[default, string, number] -#### Returns -*(Primitive)*: +#### @see -#### Example -```js -const chain = new Chain() -chain.toNumber = () => 1 + chain -//=> 1 -chain + 1 -//=> +* fluents/chain able/blob/master/src/deps/reduce/clean.js -``` -#### Example -```js -const chain = new Chain() -chain.toString = () => 'eh' -chain + '' -//=> 'eh' +#### @symb -``` +🎱 --- @@ -6763,16 +8772,19 @@ chain + '' -

# reduce(map=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1337 "View in source") [Ⓣ][1] +

reduce(map=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2117 "View in source") [Ⓣ][1] (Function): Map -> Object -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @Since 4.0.0 #### Arguments @@ -6800,23 +8812,24 @@ reduce(map) - - -## `reduce.prototype` +

reduce.clean(obj=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L10754 "View in source") [Ⓣ][1] - +(Function): goes through the maps, and the map values, reduces them to array then to an object using the reduced values -

# reduce.prototype.clean(obj=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7692 "View in source") [Ⓣ][1] -(Function): goes through the maps, and the map values, reduces them to array then to an object using the reduced values +#### @see +* fluents/chain able/blob/master/src/deps/reduce/clean.js -### @see +#### @todos -* fluents/chain able/blob/master/src/deps/reduce/clean.js +- [ ] seems to be overkill with reducing mapping just copy & ignore or delete? + #### Arguments 1. `obj=undefined` *(Object): object to clean, usually .entries()* @@ -6850,20 +8863,23 @@ clean(map.entries()) -

# regexp(value=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L906 "View in source") [Ⓣ][1] +

regexp(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1558 "View in source") [Ⓣ][1] (Function): Checks if `value` is classified as a `RegExp` object. -### @see +#### @see + +* fluents/chain able/blob/master/src/deps/reduce/clean.js -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since +#### @Since 0.1.0 #### Arguments -1. `value=undefined` *(*)*: The value to check. +1. `x=undefined` *(*)*: The value to check. #### Returns *(boolean)*: Returns `true` if `value` is a regexp, else `false`. @@ -6885,58 +8901,14 @@ isRegExp('/abc/') -## `remove` - - - -

# remove(stopHere=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2577 "View in source") [Ⓣ][1] - -(Function): Remove the current element from the output. If the node is in an Array it will be spliced off. Otherwise it will be deleted from its parent. - -#### Arguments -1. `stopHere=undefined` *(boolean)*: - -#### Returns -*(void)*: - ---- - - - - - - - -## `return` - - - -

# return(node_=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2494 "View in source") [Ⓣ][1] - -Function - -#### Arguments -1. `node_=undefined` *(any)*: - -#### Returns -*(State)*: see types - ---- - - - - - - - ## `schema` -

# schema(obj=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3686 "View in source") [Ⓣ][1] +

schema(obj=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6462 "View in source") [Ⓣ][1] (Function): handles:
1. recursively building nestable schemas, 2. creating MethodChains for all types 3. carrying over the inheritable properties 4. @modifies @injects @decorates .add(customValidators) @@ -6950,16 +8922,12 @@ Function - - -## `schema.prototype` - - - -

# schema.prototype.typeListFactory(fullKey=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3357 "View in source") [Ⓣ][1] +

schema.typeListFactory(fullKey=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6121 "View in source") [Ⓣ][1] Function @@ -6987,20 +8955,23 @@ isStringOrNumber(Object) -

# schema.prototype.typeValidator(input=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3615 "View in source") [Ⓣ][1] +

schema.typeValidator(input=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6388 "View in source") [Ⓣ][1] (Function): build a recursive schema for all around runtime type safety -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js +* fluents/chain able/blob/master/src/deps/reduce/clean.js -### @symb +#### @symb 🛂 -#### Since + +#### @Since 4.0.0-beta.1 #### Arguments @@ -7050,12 +9021,15 @@ var isValid = typeValidator(1) -

# schemaFactory(property=undefined, nestedSchema=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3573 "View in source") [Ⓣ][1] +

schemaFactory(property=undefined, nestedSchema=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6346 "View in source") [Ⓣ][1] (Function): pass the property & schema in, get a nestable typeValidator out -#### Since + +#### @Since 4.0.0-alpha.1 #### Arguments @@ -7104,12 +9078,15 @@ input = { -

# scopedEncase(fnToEncase=undefined, [type=undefined], [specification=undefined])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3979 "View in source") [Ⓣ][1] +

scopedEncase(fnToEncase=undefined, [type=undefined], [specification=undefined])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6812 "View in source") [Ⓣ][1] Function -#### Since + +#### @Since 4.0.0-beta.1 #### Arguments @@ -7141,12 +9118,15 @@ const encased = scopedEncase(fnToEncase).onValid(onValid).onInvalid(onInvalid) -

# set(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L140 "View in source") [Ⓣ][1] +

set(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L719 "View in source") [Ⓣ][1] (Function): Checks if `value` is classified as a `Set` object. -#### Since + +#### @Since 4.3.0 #### Arguments @@ -7176,12 +9156,15 @@ isSet(new WeakSet()) -

# set$$2(key=undefined, [prop=undefined], [value=undefined])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1620 "View in source") [Ⓣ][1] +

set$$2(key=undefined, [prop=undefined], [value=undefined])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2566 "View in source") [Ⓣ][1] Function -#### Since + +#### @Since 4.0.0 #### Arguments @@ -7204,12 +9187,15 @@ Function -

# setChosen(keyToSet=undefined, valueToSet=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5311 "View in source") [Ⓣ][1] +

setChosen(keyToSet=undefined, valueToSet=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L8214 "View in source") [Ⓣ][1] (Function): when fn is a full method, not an extended shorthand -#### Since + +#### @Since 0.5.0 #### Arguments @@ -7248,59 +9234,38 @@ parent.get('oh') -

# simpleKindOf(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L984 "View in source") [Ⓣ][1] +

simpleKindOf(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1705 "View in source") [Ⓣ][1] (Function): when Array -> 'array' when null -> 'null' else `typeof x` -#### Arguments -1. `x=undefined` *(any)*: - -#### Returns -*(string)*: type - ---- - - - - - - - -## `state` - - -

# state

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2505 "View in source") [Ⓣ][1] +#### @todos -(Object): Each method that takes a callback has a context *(its this object)* with these attributes: - - -### @classProps - -* {isRoot} @alias isNotRoot Whether or not the present node is a leaf node (has no children) +- [ ] `type.split(' ').pop().replace(/\s\[\]/g, '').toLowerCase()` ---- - - - - - - -## `stop` - - - -

# stop()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2629 "View in source") [Ⓣ][1] +#### @Since +4.0.0 -Function +#### Arguments +1. `x=undefined` *(any)*: value for type #### Returns -*(void)*: +*(string)*: type +
+
+split at space, replace brackets and space, lowercase +#### Example +```js +simpleKindOf([]) //=> 'array' +simpleKindOf(null) //=> 'null' +simpleKindOf({}) //=> 'object' + +``` --- @@ -7313,13 +9278,15 @@ Function -

# test

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6373 "View in source") [Ⓣ][1] +

test

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L9134 "View in source") [Ⓣ][1] unknown -### @todos +#### @todos - [ ] replace to-test @@ -7335,8 +9302,10 @@ unknown -

# this.extend()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4436 "View in source") [Ⓣ][1] +

this.extend()

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7330 "View in source") [Ⓣ][1] Function @@ -7363,18 +9332,23 @@ chain -🌊 Types: deps.d  +* 🌊 Types: deps.d  +* 🌊 Types: deps.encase.d  +* 🌊 Types: deps.reduce.d  -

# toArr(ar=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1514 "View in source") [Ⓣ][1] +

toArr(ar=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2361 "View in source") [Ⓣ][1] (Function): anything into an array -### @sig +#### @sig * => Array -#### Since + +#### @Since 0.0.1 #### Arguments @@ -7424,17 +9398,20 @@ toarr('').concat(toarr(false)).concat(toarr(null)) -

# toTest(matchable=undefined, [arg1=undefined], [arg2=undefined])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6868 "View in source") [Ⓣ][1] +

toTest(matchable=undefined, [arg1=undefined], [arg2=undefined])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L9647 "View in source") [Ⓣ][1] (Function): like matcher, but .isMatch -### @notes +#### @notes * as else-if for easier ternary uglification -#### Since + +#### @Since 3.0.0 #### Arguments @@ -7482,36 +9459,19 @@ matcher({ test: x => x === 'kinga' }, 'nope') -

# traverse(obj=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4 "View in source") [Ⓣ][1] - -Function - -#### Arguments -1. `obj=undefined` *(Traversable)*: object to traverse - -#### Example -```js -traverse({}) -//=> new Traverse(obj) - -``` ---- - - - - - -

# traverse([useThis=false])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7127 "View in source") [Ⓣ][1] +

traverse([useThis=false])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L9954 "View in source") [Ⓣ][1] (Function): traverse `this`, or `this.entries` -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @Since 1.0.2 #### Arguments @@ -7532,109 +9492,23 @@ TAKE FROM TRAVERSECHAIN -## `traverse.prototype` - - - -* 🌊 Types: TraverseChain.d  -* 🌊 Types: traverse.d  - -

# traverse.prototype.eq(a=undefined, b=undefined, [loose=false])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6030 "View in source") [Ⓣ][1] - -(Function): deep traversal of nodes to compare any data types does not check reference, only value equality - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @symb - -⚖️ -#### Since -3.0.0 - -#### Arguments -1. `a=undefined` *(any)*: compare a with b -2. `b=undefined` *(any)*: compare b with a -3. `[loose=false]` *(boolean)*: whether to do looser equals check - -#### Returns -*(boolean)*: isEqual - -#### Example -```js -eq(1, 1) -//=> true - -eq(true, false) -//=> false - -eq({}, {}) -//=> true - -``` -#### Example -```js -eq( - { d: new Date(0, 0, 0, 0), x: [1, 2, 3] }, - { d: new Date(0, 0, 0, 0), x: [1, 2, 3] } -) -//=> true - -eq([new RegExp('x')], [/x/]) -//=> true - -eq([new String('x')], ['x']) -//=> true - -eq([new Boolean(false)], [false]) -//=> true - -eq([undefined], [null]) || eq(undefined, null) -//=> false - -``` -#### Example -```js -var xs = [1, 2, 3, 4] -delete xs[2] - -var ys = Object.create(Array.prototype) -ys[0] = 1 -ys[1] = 2 -ys[3] = 4 - -eq(xs, ys) -//=> true - -eq(xs, [1, 2, undefined, 4]) -//=> false - -``` ---- - - - - - - - ## `traversed` -

# traversed()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7075 "View in source") [Ⓣ][1] +

traversed()

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L9889 "View in source") [Ⓣ][1] (Function): value traversed in traverse -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @Since 1.0.0 #### Returns @@ -7703,43 +9577,19 @@ const eh = { -## `tryCatch` - - - -

# tryCatch(call=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3863 "View in source") [Ⓣ][1] - -Function - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Arguments -1. `call=undefined` *(Function)*: - -#### Returns -*(*)*: validation/encased function call result - ---- - - - - - - - ## `typedOnCall` -

# typedOnCall(arg=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4013 "View in source") [Ⓣ][1] +

typedOnCall(arg=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6846 "View in source") [Ⓣ][1] (Function): this is the actual built function -#### Since + +#### @Since 4.0.0-beta.1 #### Arguments @@ -7767,8 +9617,10 @@ const encased = encase(fnToEncase) -

# types(name=undefined, parent=undefined, built=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4051 "View in source") [Ⓣ][1] +

types(name=undefined, parent=undefined, built=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6896 "View in source") [Ⓣ][1] Function @@ -7788,43 +9640,21 @@ Function -## `update` - - - -

# update(x=undefined, stopHere=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2556 "View in source") [Ⓣ][1] - -(Function): Set a new value for the present node. -All the elements in value will be recursively traversed unless stopHere is true. - -#### Arguments -1. `x=undefined` *(Function)*: -2. `stopHere=undefined` *(boolean)*: - -#### Returns -*(void)*: - ---- - - - - +## `util` -## `updateState` - - +

util.assign

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7 "View in source") [Ⓣ][1] -

# updateState()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2653 "View in source") [Ⓣ][1] +Function -(Function): updates if needed: -#### Returns -*(void)*: +#### @see +* fluents/chain able/blob/master/src/deps/reduce/clean.js --- @@ -7837,8 +9667,10 @@ All the elements in value will be recursively traversed unless stopHere is true. -

# validators(validators=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3271 "View in source") [Ⓣ][1] +

validators(validators=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6044 "View in source") [Ⓣ][1] (Function): library of validators to use by name @@ -7853,85 +9685,14 @@ All the elements in value will be recursively traversed unless stopHere is true. -## `values` - - - -

# values()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L31 "View in source") [Ⓣ][1] - -(Function): spreads the entries from ChainedMap.store.values allocates a new array, adds the values from the iterator - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @notes - -* look at Chainable.constructor to ensure not to use `new Array...` -* moved from ChainedMap and ChainedSet to Chainable @2.0.2 -* this was [...] & Array.from(this.store.values()) - -#### Since -0.4.0 - -#### Returns -*(*): toArr(this.store.values())* - -#### Example -```js -const chain = new Chain() -chain.set('eh', 1) -chain.values() -//=> [1] - -``` ---- - - - - - - - -## `when` - - - -

# when(condition=undefined, [trueBrancher=Function], [falseBrancher=Function])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L458 "View in source") [Ⓣ][1] - -(Function): when the condition is true, trueBrancher is called, else, falseBrancher is called - -#### Arguments -1. `condition=undefined` *(boolean|string)*: when string, checks this.get -2. `[trueBrancher=Function]` *(Function)*: called when true -3. `[falseBrancher=Function]` *(Function)*: called when false - -#### Returns -*(Chainable)*: @chainable - -#### Example -```js -const prod = process.env.NODE_ENV === 'production' -chains.when(prod, c => c.set('prod', true), c => c.set('prod', false)) - -``` ---- - - - - - - - ## `while` -

# while()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2883 "View in source") [Ⓣ][1] +

while()

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3550 "View in source") [Ⓣ][1] Function @@ -7961,4 +9722,4 @@ Function - [1]: #cm "Jump back to the TOC." + [1]: #chainable "Jump back to the TOC." diff --git a/docs/docdown/compose/DotProp.md b/docs/docdown/compose/DotProp.md index 8c491bd..c08ef59 100644 --- a/docs/docdown/compose/DotProp.md +++ b/docs/docdown/compose/DotProp.md @@ -4,38 +4,38 @@ -## `DotProp.prototype` -* `DotProp.prototype.get` -* `DotProp.prototype.set` +## `DotProp` +* `DotProp.get` +* `DotProp.set` -## `Observe.prototype` -* `Observe.prototype.exports` +## `Observe` +* `Observe.exports` ## `delete` -* `delete` +* `delete` ## `dot` -* `dot` -* `dot` +* `dot` +* `dot` ## `has` -* `has` +* `has` @@ -45,26 +45,29 @@ -## `DotProp.prototype` +## `DotProp` -

# DotProp.prototype.get(key=undefined, [fallback=undefined])

+

DotProp.get(key=undefined, [fallback=undefined])

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/compose/DotProp.js#L199 "View in source") [Ⓣ][1] (Function): dot-prop enabled get -### @see +#### @see -* fluents/chain able/blob/master/src/deps/dot/delete.js -* fluents/chain able/blob/master/src/deps/is/dot.js +* fluents/chain able/blob/master/src/deps/dot/delete.js +* fluents/chain able/blob/master/src/deps/is/dot.js -### @todos +#### @todos - [ ] dot-prop on non-store instance.property when using nested chains... -#### Since + +#### @Since 3.0.1 #### Arguments @@ -99,17 +102,20 @@ chain.get(['moose', 'simple']) -

# DotProp.prototype.set

+

DotProp.set

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/compose/DotProp.js#L141 "View in source") [Ⓣ][1] unknown -### @see +#### @see + +* fluents/chain able/blob/master/src/deps/dot/delete.js +* fluents/chain able/blob/master/src/deps/is/dot.js -* fluents/chain able/blob/master/src/deps/dot/delete.js -* fluents/chain able/blob/master/src/deps/is/dot.js -#### Since +#### @Since 3.0.1 #### Example @@ -128,29 +134,31 @@ chain.set('moose.simple', 1) -## `Observe.prototype` +## `Observe` 🔬 Tests: DotProp  -

# Observe.prototype.exports(Chain=undefined)

+

Observe.exports(Target=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/compose/DotProp.js#L88 "View in source") [Ⓣ][1] Function -### @see +#### @see -* fluents/chain able/blob/master/src/deps/dot/delete.js -* fluents/chain able/blob/master/src/deps/is/dot.js +* fluents/chain able/blob/master/src/deps/dot/delete.js +* fluents/chain able/blob/master/src/deps/is/dot.js -### @extends +#### @extends ChainedMap #### Arguments -1. `Chain=undefined` *(Class|Composable)*: composable class +1. `Target=undefined` *(Class|Composable)*: composable class #### Returns *(DotProp)*: class @@ -200,17 +208,20 @@ chain.get(['moose', 'canada', 'igloo']) -

# delete

+

delete

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/compose/DotProp.js#L255 "View in source") [Ⓣ][1] unknown -### @see +#### @see + +* fluents/chain able/blob/master/src/deps/dot/delete.js +* fluents/chain able/blob/master/src/deps/is/dot.js -* fluents/chain able/blob/master/src/deps/dot/delete.js -* fluents/chain able/blob/master/src/deps/is/dot.js -#### Since +#### @Since 3.0.1 #### Example @@ -242,12 +253,15 @@ chain.has('moose.canada') -

# dot

+

dot

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/compose/DotProp.js#L4 "View in source") [Ⓣ][1] unknown -#### Since + +#### @Since 2.0.0 --- @@ -256,17 +270,20 @@ unknown -

# dot([useDot=undefined])

+

dot([useDot=undefined])

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/compose/DotProp.js#L116 "View in source") [Ⓣ][1] Function -### @see +#### @see + +* fluents/chain able/blob/master/src/deps/dot/delete.js +* fluents/chain able/blob/master/src/deps/is/dot.js -* fluents/chain able/blob/master/src/deps/dot/delete.js -* fluents/chain able/blob/master/src/deps/is/dot.js -#### Since +#### @Since 3.0.1 #### Arguments @@ -297,17 +314,20 @@ toArr(chain.store.keys()) -

# has

+

has

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/compose/DotProp.js#L222 "View in source") [Ⓣ][1] unknown -### @see +#### @see + +* fluents/chain able/blob/master/src/deps/dot/delete.js +* fluents/chain able/blob/master/src/deps/is/dot.js -* fluents/chain able/blob/master/src/deps/dot/delete.js -* fluents/chain able/blob/master/src/deps/is/dot.js -#### Since +#### @Since 3.0.1 #### Example @@ -325,4 +345,4 @@ chain.has('one.two') - [1]: #dotprop.prototype "Jump back to the TOC." + [1]: #dotprop "Jump back to the TOC." diff --git a/docs/docdown/compose/Observe.md b/docs/docdown/compose/Observe.md index 77c8d78..1e17980 100644 --- a/docs/docdown/compose/Observe.md +++ b/docs/docdown/compose/Observe.md @@ -4,9 +4,9 @@ -## `Observe.prototype` -* `Observe.prototype.` -* `Observe.prototype.exports` +## `Observe` +* `Observe.` +* `Observe.exports` @@ -16,17 +16,19 @@ -## `Observe.prototype` +## `Observe` -

# Observe.prototype.observe(properties=undefined, fn=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/compose/Observe.js#L46 "View in source") [Ⓣ][1] +

Observe.observe(properties=undefined, fn=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/compose/Observe.js#L48 "View in source") [Ⓣ][1] (Function): observe properties when they change -### @todos +#### @todos - [ ] gotta update `data` if `deleting` too... - [ ] un-observe @@ -75,23 +77,26 @@ chain 🔬 Tests: observe  -

# Observe.prototype.exports(Chain=undefined)

+

Observe.exports(Target=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/compose/Observe.js#L38 "View in source") [Ⓣ][1] (Function): > subscribe to changes ❗ called only on **change** observers are only called when data they subscribe to changes -### @extends +#### @extends * ChainedMap * DotProp -#### Since + +#### @Since 3.0.1 #### Arguments -1. `Chain=undefined` *(Class|Composable)*: composable class +1. `Target=undefined` *(Class|Composable)*: composable class #### Returns *(Observe)*: class @@ -112,4 +117,4 @@ new DotProp() - [1]: #observe.prototype "Jump back to the TOC." + [1]: #observe "Jump back to the TOC." diff --git a/docs/docdown/compose/Shorthands.md b/docs/docdown/compose/Shorthands.md index 124f920..843828a 100644 --- a/docs/docdown/compose/Shorthands.md +++ b/docs/docdown/compose/Shorthands.md @@ -4,31 +4,31 @@ -## `ShorthandChain.prototype` -* `ShorthandChain.prototype.return` -* `ShorthandChain.prototype.setIfEmpty` -* `ShorthandChain.prototype.wrap` +## `ShorthandChain` +* `ShorthandChain.return` +* `ShorthandChain.setIfEmpty` +* `ShorthandChain.wrap` -## `Shorthands.prototype` -* `Shorthands.prototype.exports` +## `Shorthands` +* `Shorthands.exports` ## `debug` -* `debug` +* `debug` ## `isUndefined` -* `isUndefined` +* `isUndefined` @@ -38,16 +38,19 @@ -## `ShorthandChain.prototype` +## `ShorthandChain` -

# ShorthandChain.prototype.return(value=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/compose/Shorthands.js#L175 "View in source") [Ⓣ][1] +

ShorthandChain.return(value=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/compose/Shorthands.js#L176 "View in source") [Ⓣ][1] (Function): returns any value passed in return a value at the end of a chain regardless -#### Since + +#### @Since 3.0.0 #### Arguments @@ -73,12 +76,15 @@ console.log(saveAndDebug(process.env)) -

# ShorthandChain.prototype.setIfEmpty(name=undefined, value=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/compose/Shorthands.js#L149 "View in source") [Ⓣ][1] +

ShorthandChain.setIfEmpty(name=undefined, value=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/compose/Shorthands.js#L150 "View in source") [Ⓣ][1] (Function): sets a value **only** when .has is false aka set if the value has not been set -#### Since + +#### @Since 1.0.2 #### Arguments @@ -124,12 +130,15 @@ chain.when(!chain.has('eh'), instance => instance.set('eh', false)) -

# ShorthandChain.prototype.wrap(fn=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/compose/Shorthands.js#L208 "View in source") [Ⓣ][1] +

ShorthandChain.wrap(fn=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/compose/Shorthands.js#L209 "View in source") [Ⓣ][1] (Function): wrap a value, if it's a Function call it, return this aka execute something and return this -#### Since + +#### @Since 2.0.0 #### Arguments @@ -170,26 +179,28 @@ new Chain() -## `Shorthands.prototype` +## `Shorthands` 🔬 Tests: shorthands  -

# Shorthands.prototype.exports(SuperClass=undefined)

+

Shorthands.exports(Target=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/compose/Shorthands.js#L30 "View in source") [Ⓣ][1] Function -### @extends +#### @extends * ChainedMap * DotProp #### Arguments -1. `SuperClass=undefined` *(Class|Composable)*: composable class +1. `Target=undefined` *(Class|Composable)*: composable class #### Returns *(Shorthands)*: class @@ -214,13 +225,15 @@ new DotProp() -

# debug([should=true])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/compose/Shorthands.js#L103 "View in source") [Ⓣ][1] +

debug([should=true])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/compose/Shorthands.js#L104 "View in source") [Ⓣ][1] (Function): sets on store not this.set for easier extension -### @notes +#### @notes * is inherited by any chain with a parent with .meta.debug @@ -256,12 +269,15 @@ chain.entries() -

# isUndefined

+

isUndefined

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/compose/Shorthands.js#L4 "View in source") [Ⓣ][1] unknown -#### Since + +#### @Since 2.0.0 --- @@ -272,4 +288,4 @@ unknown - [1]: #shorthandchain.prototype "Jump back to the TOC." + [1]: #shorthandchain "Jump back to the TOC." diff --git a/docs/docdown/compose/Transform.md b/docs/docdown/compose/Transform.md index 5a9e0d6..1824bb0 100644 --- a/docs/docdown/compose/Transform.md +++ b/docs/docdown/compose/Transform.md @@ -4,25 +4,25 @@ -## `TransformChain.prototype` -* `TransformChain.prototype.` -* `TransformChain.prototype.remap` -* `TransformChain.prototype.set` -* `TransformChain.prototype.transform` +## `TransformChain` +* `TransformChain.` +* `TransformChain.remap` +* `TransformChain.set` +* `TransformChain.transform` ## `exports` -* `exports` +* `exports` ## `traverse` -* `traverse` +* `traverse` @@ -32,23 +32,25 @@ -## `TransformChain.prototype` +## `TransformChain` 🔬 Tests: TransformChain  -

# TransformChain.prototype.

+

TransformChain.

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/compose/Transform.js#L8 "View in source") [Ⓣ][1] Map -### @symb +#### @symb 🤖 -### @extends +#### @extends ChainedMap @@ -58,16 +60,19 @@ ChainedMap -

# TransformChain.prototype.remap(from=undefined, [to=undefined])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/compose/Transform.js#L183 "View in source") [Ⓣ][1] +

TransformChain.remap(from=undefined, [to=undefined])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/compose/Transform.js#L210 "View in source") [Ⓣ][1] (Function): remap properties from `1` to another, for example, apis with inconsistent naming -### @symb +#### @symb 🗺 -#### Since + +#### @Since 1.0.0 #### Arguments @@ -100,12 +105,15 @@ chain -

# TransformChain.prototype.set(key=undefined, val=undefined, dotPropKey=undefined)

+

TransformChain.set(key=undefined, val=undefined, dotPropKey=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/compose/Transform.js#L124 "View in source") [Ⓣ][1] Function -#### Since + +#### @Since 1.0.0 #### Arguments @@ -122,17 +130,20 @@ Function -

# TransformChain.prototype.transform(key=undefined, value=undefined)

+

TransformChain.transform(key=undefined, value=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/compose/Transform.js#L106 "View in source") [Ⓣ][1] Function -### @todos +#### @todos - [ ] dot-prop here -#### Since + +#### @Since 1.0.2 #### Arguments @@ -182,13 +193,15 @@ const { created_at } = chain.entries() -

# exports(SuperClass=undefined)

+

exports(Target=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/compose/Transform.js#L18 "View in source") [Ⓣ][1] Function #### Arguments -1. `SuperClass=undefined` *(Class|Composable)*: composable class +1. `Target=undefined` *(Class|Composable)*: composable class #### Returns *(TransformChain)*: class @@ -211,12 +224,15 @@ compose(class {}) -

# traverse([useThis=false])

+

traverse([useThis=false])

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/compose/Transform.js#L56 "View in source") [Ⓣ][1] (Function): traverse `this`, or `this.entries` -#### Since + +#### @Since 1.0.2 #### Arguments @@ -237,4 +253,4 @@ TAKE FROM TRAVERSECHAIN - [1]: #transformchain.prototype "Jump back to the TOC." + [1]: #transformchain "Jump back to the TOC." diff --git a/docs/docdown/compose/compose.md b/docs/docdown/compose/compose.md index fba866c..ab7f5cb 100644 --- a/docs/docdown/compose/compose.md +++ b/docs/docdown/compose/compose.md @@ -4,8 +4,8 @@ -## `compose.prototype` -* `compose.prototype.compose` +## `compose` +* `compose.compose` @@ -15,7 +15,7 @@ -## `compose.prototype` +## `compose` @@ -23,16 +23,19 @@ 🔬 Tests: compose  -

# compose.prototype.compose([target=ChainedMap], [extensions=[Observe,Shorthands,Transform,DotProp]])

+

compose.compose([target=ChainedMap], [extensions=[Observe,Shorthands,Transform,DotProp]])

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/compose/compose.js#L70 "View in source") [Ⓣ][1] (Function): compose chains all the way up from Chainable -### @symb +#### @symb 🎼 -#### Since + +#### @Since 3.0.0 #### Arguments @@ -87,4 +90,4 @@ yes instanceof Winning && yes.winning - [1]: #compose.prototype "Jump back to the TOC." + [1]: #compose "Jump back to the TOC." diff --git a/docs/docdown/deps/argumentor.md b/docs/docdown/deps/argumentor.md index 1178b7a..4c6c728 100644 --- a/docs/docdown/deps/argumentor.md +++ b/docs/docdown/deps/argumentor.md @@ -4,8 +4,8 @@ -## `exports` -* `exports` +## `argumentor` +* `argumentor` @@ -15,16 +15,23 @@ -## `exports` +## `argumentor` -

# exports()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/argumentor.js#L23 "View in source") [Ⓣ][1] +

argumentor()

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/argumentor.js#L25 "View in source") [Ⓣ][1] (Function): turns arguments into an array, used as a util, for opt -#### Since + +#### @see + +* fluents/chain able/blob/master/src/deps/util/length from zero.js + +#### @Since 3.0.0 #### Returns @@ -49,4 +56,4 @@ eh(0, 1, 10, 100) - [1]: #exports "Jump back to the TOC." + [1]: #argumentor "Jump back to the TOC." diff --git a/docs/docdown/deps/array/concat.md b/docs/docdown/deps/array/concat.md new file mode 100644 index 0000000..438303d --- /dev/null +++ b/docs/docdown/deps/array/concat.md @@ -0,0 +1,61 @@ +# concat.js API documentation + + + + + +## `concat` +* `concat` + + + + + + + + + +## `concat` + + + +

concat(one=undefined, two=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/array/concat.js#L27 "View in source") [Ⓣ][1] + +(Function): concat two values, coerce to arrays + + +#### @Since +4.0.0 + +#### Arguments +1. `one=undefined` *(*|Array)*: toArr1 +2. `two=undefined` *(*|Array)*: toArr2 + +#### Returns +*(Array)*: [one, two] + +#### Example +```js +concat([1], [2]) //=> [1, 2] +concat([1], 2) //=> [1, 2] +concat(1, 2) //=> [1, 2] +concat(new Set([1]), 2) //=> [1, 2] + +// kind of weird... +concat(null, 2) //=> [2] +concat(undefined, 2) //=> [2] +concat(1, null) //=> [1, null] + +``` +--- + + + + + + + + [1]: #concat "Jump back to the TOC." diff --git a/docs/docdown/deps/array/insertAtIndex.md b/docs/docdown/deps/array/insertAtIndex.md new file mode 100644 index 0000000..b9e314b --- /dev/null +++ b/docs/docdown/deps/array/insertAtIndex.md @@ -0,0 +1,54 @@ +# insertAtIndex.js API documentation + + + + + +## `exports` +* `exports` + + + + + + + + + +## `exports` + + + +

exports(arr=undefined, index=undefined, val=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/array/insertAtIndex.js#L26 "View in source") [Ⓣ][1] + +(Function): put a value at any index in an array + + +#### @Since +? was in insert-at-index dep... + +#### Arguments +1. `arr=undefined` *(Array)*: array to put value in at index +2. `index=undefined` *(number)*: index to put valu eat +3. `val=undefined` *(*)*: value to put at index + +#### Returns +*(*)*: array with new value at index + +#### Example +```js +insertAtIndex(['zero-1', 'one-2'], 1, 1) //=> ['zero-1', 1, 'one-two'] + +``` +--- + + + + + + + + [1]: #exports "Jump back to the TOC." diff --git a/docs/docdown/deps/array/uniq.md b/docs/docdown/deps/array/uniq.md index 9005e92..fb36d79 100644 --- a/docs/docdown/deps/array/uniq.md +++ b/docs/docdown/deps/array/uniq.md @@ -2,10 +2,60 @@ + + +## `uniqFilter` +* `uniqFilter` + + + + + +## `uniqFilter` + + + +

uniqFilter(value=undefined, index=undefined, arr=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/array/uniq.js#L18 "View in source") [Ⓣ][1] + +Function + + +#### @see + +* Developer.mozilla.org/en us/docs/web/java script/reference/global objects/array/filter + +#### @Since +0.1.0 + +#### Arguments +1. `value=undefined` *(*)*: value in array iteration +2. `index=undefined` *(number)*: current index +3. `arr=undefined` *(Array)*: array being iterated, `thisArg` when using .filter + +#### Returns +*(Array)*: arr + +#### Example +```js +var list = [1, 2, 3, 1, 2, 3, 1, 2, 3] + +list.filter(uniq) +//=> [1, 2, 3] + +``` +--- + + + + + - [1]: # "Jump back to the TOC." + [1]: #uniqfilter "Jump back to the TOC." diff --git a/docs/docdown/deps/cache/pooler.md b/docs/docdown/deps/cache/pooler.md new file mode 100644 index 0000000..5d14584 --- /dev/null +++ b/docs/docdown/deps/cache/pooler.md @@ -0,0 +1,161 @@ +# pooler.js API documentation + + + + + +## `pooler` +* `pooler.addPoolingTo` +* `pooler.oneArgumentPooler` +* `pooler.standardReleaser` + + + + + +## `pooler.// const pooler` +* `pooler.// const pooler` + + + + + + + + + +## `pooler` + + + +

pooler.addPoolingTo(CopyConstructor=undefined, pooler=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/cache/pooler.js#L111 "View in source") [Ⓣ][1] + +(Function): Augments `CopyConstructor` to be a poolable class, augmenting only the class +itself *(statically)* not adding any prototypical fields. Any CopyConstructor +you give this may have a `poolSize` property, and will look for a +prototypical `destructor` on instances. + + +#### @Since +5.0.0 + +#### Arguments +1. `CopyConstructor=undefined` *(Function|Object)*: Constructor that can be used to reset. +2. `pooler=undefined` *(Function)*: Customizable pooler. + +#### Returns +*(Object)*: enhanced constructor, decorated with pooler + +#### Example +```js +class Eh {} +addPoolingTo(Eh) // can optionally pass in pooler as second arg +//=> Eh.instancePool = [] +//=> Eh.getPooled = pooler || singleArgumentPooler +//=> Eh.poolSize = 10 +//=> Eh.release = standardReleaser + +``` +--- + + + + + +

pooler.oneArgumentPooler(copyFieldsFrom=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/cache/pooler.js#L73 "View in source") [Ⓣ][1] + +(Function): Static poolers. Several custom versions for each potential number of +arguments. A completely generic pooler is easy to implement, but would +require accessing the `arguments` object. In each of these, `this` refers to +the Class itself, not an instance. If any others are needed, simply add them +here, or in their own files. + + +#### @Since +5.0.0 + +#### Arguments +1. `copyFieldsFrom=undefined` *(Object)*: obj with instance pool + +#### Returns +*(Object)*: instance of Klass + +#### Example +```js +class Eh {} +addPoolingTo(Eh) +const eh = Eh.getPooled() //=> oneArgumentPooler(Eh) +eh.release() + +``` +--- + + + + + +

pooler.standardReleaser(instance=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/cache/pooler.js#L34 "View in source") [Ⓣ][1] + +(Function): call destructor on a pooled instance, put it back in the pool + + +#### @Since +5.0.0 + +#### Arguments +1. `instance=undefined` *(Object)*: call destructor + +#### Returns +*(void)*: + +#### Example +```js +class Eh {} +addPoolingTo(Eh) +const eh = Eh.getPooled() +eh.release() + +``` +--- + + + + + + + +## `pooler.// const pooler` + + + +🔬 Tests: pooler  + +

pooler.// const pooler

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/cache/pooler.js#L10 "View in source") [Ⓣ][1] + +Object + + +#### @symb + +🎱 +--- + + + + + + + + [1]: #pooler "Jump back to the TOC." diff --git a/docs/docdown/deps/cache/scoped.md b/docs/docdown/deps/cache/scoped.md index 38ed4a4..a3fcfc7 100644 --- a/docs/docdown/deps/cache/scoped.md +++ b/docs/docdown/deps/cache/scoped.md @@ -2,10 +2,36 @@ + + +## `scoped` +* `` + + + + + +## `scoped` + + + +

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/cache/scoped.js#L100 "View in source") [Ⓣ][1] + +unknown + +--- + + + + + - [1]: # "Jump back to the TOC." + [1]: #scoped "Jump back to the TOC." diff --git a/docs/docdown/deps/camel-case.md b/docs/docdown/deps/camel-case.md index 47ef511..2b44454 100644 --- a/docs/docdown/deps/camel-case.md +++ b/docs/docdown/deps/camel-case.md @@ -5,7 +5,7 @@ ## `exports` -* `exports` +* `exports` @@ -19,17 +19,20 @@ -

# exports(str=undefined)

+

exports(str=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/camel-case.js#L22 "View in source") [Ⓣ][1] (Function): camelCase -### @todos +#### @todos - [ ] s.charAt(0).toLowerCase() + string.slice(1) -#### Since + +#### @Since 0.2.0 #### Arguments diff --git a/docs/docdown/deps/class-names.md b/docs/docdown/deps/class-names.md deleted file mode 100644 index e3f72e0..0000000 --- a/docs/docdown/deps/class-names.md +++ /dev/null @@ -1,45 +0,0 @@ -# class-names.js API documentation - - - - - -## `exports` -* `exports` - - - - - - - - - -## `exports` - - - -

# exports(_c)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/class-names.js#L6 "View in source") [Ⓣ][1] - - - -#### Arguments -1. `_c` *(Object)*: - -#### Returns -*(string)*: - -#### Example -```js -get className() {return classNames(this)} -``` ---- - - - - - - - - [1]: #exports "Jump back to the TOC." diff --git a/docs/docdown/deps/clean.md b/docs/docdown/deps/clean.md deleted file mode 100644 index f49a210..0000000 --- a/docs/docdown/deps/clean.md +++ /dev/null @@ -1,44 +0,0 @@ -# clean.js API documentation - - - - - -## `exports` -* `exports` - - - - - - - - - -## `exports` - - - -

# exports(obj)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/clean.js#L17 "View in source") [Ⓣ][1] - - - -#### Since -4.0.0 <- moved as a dep function - -#### Arguments -1. `obj` *(Object): object to clean, usually .entries()* - -#### Returns -*(Object)*: - ---- - - - - - - - - [1]: #exports "Jump back to the TOC." diff --git a/docs/docdown/deps/concat.md b/docs/docdown/deps/concat.md index a514a9c..026da3a 100644 --- a/docs/docdown/deps/concat.md +++ b/docs/docdown/deps/concat.md @@ -2,10 +2,60 @@ + + +## `concat` +* `concat` + + + + + +## `concat` + + + +

concat(one=undefined, two=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/concat.js#L27 "View in source") [Ⓣ][1] + +(Function): conat two values, coerce to arrays + + +#### @Since +4.0.0 + +#### Arguments +1. `one=undefined` *(*|Array)*: toArr1 +2. `two=undefined` *(*|Array)*: toArr2 + +#### Returns +*(Array)*: [one, two] + +#### Example +```js +concat([1], [2]) //=> [1, 2] +concat([1], 2) //=> [1, 2] +concat(1, 2) //=> [1, 2] +concat(new Set([1]), 2) //=> [1, 2] + +// kind of weird... +concat(null, 2) //=> [2] +concat(undefined, 2) //=> [2] +concat(1, null) //=> [1, null] + +``` +--- + + + + + - [1]: # "Jump back to the TOC." + [1]: #concat "Jump back to the TOC." diff --git a/docs/docdown/deps/conditional/all.md b/docs/docdown/deps/conditional/all.md index f1568f3..7fa6bd9 100644 --- a/docs/docdown/deps/conditional/all.md +++ b/docs/docdown/deps/conditional/all.md @@ -4,8 +4,8 @@ -## `conditional.prototype` -* `conditional.prototype.all` +## `conditional` +* `conditional.all` @@ -15,20 +15,39 @@ -## `conditional.prototype` +## `conditional` -

# conditional.prototype.all(predicate=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/conditional/all.js#L19 "View in source") [Ⓣ][1] +

conditional.all(predicate=undefined, array=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/conditional/all.js#L26 "View in source") [Ⓣ][1] (Function): map all values in an array to see if all match +Returns `true` if all elements of the list match the predicate, `false` if there are any that don't. -#### Since + +#### @see + +* ramda/ramda/blob/master/src/all.js +* fluents/chain able/blob/master/src/deps/fp/curry.js + +#### @todos + +- [ ] `not(some)` ? + + +#### @sig + +(a -> Boolean) -> [a] -> Boolean + +#### @Since 4.0.1 #### Arguments 1. `predicate=undefined` *(Function)*: match the value +2. `array=undefined` *(Array)*: to match against predicate #### Returns *(boolean)*: all match predicate @@ -51,4 +70,4 @@ const allBoolean = all(x => typeof x === 'boolean'q) - [1]: #conditional.prototype "Jump back to the TOC." + [1]: #conditional "Jump back to the TOC." diff --git a/docs/docdown/deps/conditional/and.md b/docs/docdown/deps/conditional/and.md index 61cfd67..a7cb100 100644 --- a/docs/docdown/deps/conditional/and.md +++ b/docs/docdown/deps/conditional/and.md @@ -4,8 +4,8 @@ -## `conditional.prototype` -* `conditional.prototype.exports` +## `conditional` +* `conditional.and` @@ -15,16 +15,19 @@ -## `conditional.prototype` +## `conditional` -

# conditional.prototype.exports(left=undefined, right=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/conditional/and.js#L23 "View in source") [Ⓣ][1] +

conditional.and(left=undefined, right=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/conditional/and.js#L29 "View in source") [Ⓣ][1] (Function): first fn & second fn -#### Since + +#### @Since 4.0.1 #### Arguments @@ -56,4 +59,4 @@ both([1]) - [1]: #conditional.prototype "Jump back to the TOC." + [1]: #conditional "Jump back to the TOC." diff --git a/docs/docdown/deps/is/eqeq.md b/docs/docdown/deps/conditional/eqeq.md similarity index 100% rename from docs/docdown/deps/is/eqeq.md rename to docs/docdown/deps/conditional/eqeq.md diff --git a/docs/docdown/deps/conditional/includes/all.md b/docs/docdown/deps/conditional/includes/all.md index 4bbad8c..6c8523a 100644 --- a/docs/docdown/deps/conditional/includes/all.md +++ b/docs/docdown/deps/conditional/includes/all.md @@ -4,22 +4,22 @@ -## `arrayHasAll` -* `arrayHasAll` +## `arrayIncludesAll` +* `arrayIncludesAll` ## `includesAll` -* `includesAll` +* `includesAll` -## `strHasAll` -* `strHasAll` +## `stringIncludesAll` +* `stringIncludesAll` @@ -29,12 +29,14 @@ -## `arrayHasAll` +## `arrayIncludesAll` -

# arrayHasAll(needles=undefined, haystack=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/conditional/includes/all.js#L24 "View in source") [Ⓣ][1] +

arrayIncludesAll(needles=undefined, haystack=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/conditional/includes/all.js#L28 "View in source") [Ⓣ][1] Function @@ -57,18 +59,33 @@ Function -

# includesAll(needle=undefined, haystack=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/conditional/includes/all.js#L39 "View in source") [Ⓣ][1] +

includesAll(needle=undefined, haystack=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/conditional/includes/all.js#L54 "View in source") [Ⓣ][1] Function + +#### @Since +4.0.0 + #### Arguments -1. `needle=undefined` *(string|string[])*: -2. `haystack=undefined` *(string[])*: +1. `needle=undefined` *(string|string[])*: everything in haystack is in this +2. `haystack=undefined` *(string[])*: everything in this is in the needle #### Returns *(boolean)*: +#### Example +```js +/// 'canada' and 'can' are both in it, so true +includesAll('canada', ['canada', 'can']) +includesAll(['eh'], 'e') //=> true +includesAll(['eh'], 'nope') //=> false +includesAll('eh', ['no', 'eh']) //=> false + +``` --- @@ -77,12 +94,14 @@ Function -## `strHasAll` +## `stringIncludesAll` -

# strHasAll(needle=undefined, haystack=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/conditional/includes/all.js#L9 "View in source") [Ⓣ][1] +

stringIncludesAll(needle=undefined, haystack=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/conditional/includes/all.js#L13 "View in source") [Ⓣ][1] Function @@ -93,6 +112,10 @@ Function #### Returns *(boolean)*: +#### Example +```js + +``` --- @@ -101,4 +124,4 @@ Function - [1]: #arrayhasall "Jump back to the TOC." + [1]: #arrayincludesall "Jump back to the TOC." diff --git a/docs/docdown/deps/conditional/includes/any.md b/docs/docdown/deps/conditional/includes/any.md index 2281ee2..33d3475 100644 --- a/docs/docdown/deps/conditional/includes/any.md +++ b/docs/docdown/deps/conditional/includes/any.md @@ -5,21 +5,21 @@ ## `arrayHasAny` -* `arrayHasAny` +* `arrayHasAny` ## `includesAny` -* `includesAny` +* `includesAny` ## `strHasAny` -* `strHasAny` +* `strHasAny` @@ -33,8 +33,10 @@ -

# arrayHasAny(needles=undefined, haystack=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/conditional/includes/any.js#L27 "View in source") [Ⓣ][1] +

arrayHasAny(needles=undefined, haystack=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/conditional/includes/any.js#L26 "View in source") [Ⓣ][1] Function @@ -57,8 +59,10 @@ Function -

# includesAny(needle=undefined, haystack=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/conditional/includes/any.js#L47 "View in source") [Ⓣ][1] +

includesAny(needle=undefined, haystack=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/conditional/includes/any.js#L52 "View in source") [Ⓣ][1] Function @@ -69,6 +73,14 @@ Function #### Returns *(boolean)*: +#### Example +```js +includesAny('eh', 'e') //=> true +includesAny('eh', 'eh') //=> true +includesAny(['eh'], 'e') //=> true +includesAny(['eh'], 'nope') //=> false + +``` --- @@ -81,8 +93,10 @@ Function -

# strHasAny(needle=undefined, haystack=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/conditional/includes/any.js#L9 "View in source") [Ⓣ][1] +

strHasAny(needle=undefined, haystack=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/conditional/includes/any.js#L10 "View in source") [Ⓣ][1] Function diff --git a/docs/docdown/deps/is/pureObj.md b/docs/docdown/deps/conditional/includes/flipped.md similarity index 81% rename from docs/docdown/deps/is/pureObj.md rename to docs/docdown/deps/conditional/includes/flipped.md index b4f10f1..4c526ab 100644 --- a/docs/docdown/deps/is/pureObj.md +++ b/docs/docdown/deps/conditional/includes/flipped.md @@ -1,4 +1,4 @@ -# pureObj.js API documentation +# flipped.js API documentation diff --git a/docs/docdown/deps/conditional/includes/includes.md b/docs/docdown/deps/conditional/includes/includes.md index c865ca9..127182a 100644 --- a/docs/docdown/deps/conditional/includes/includes.md +++ b/docs/docdown/deps/conditional/includes/includes.md @@ -2,10 +2,61 @@ + + +## `includes` +* `includes.includes` + + + + + +## `includes` + + + +

includes.includes(haystack=undefined, needle=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/conditional/includes/includes.js#L21 "View in source") [Ⓣ][1] + +Function + + +#### @see + +* Developer.mozilla.org/en/docs/web/java script/reference/operators/bitwise operators +* fluents/chain able/blob/master/src/deps/conditional/includes/flipped.js + +#### @todos + +- [ ] `~haystack.indexOf(needle)` + +#### Arguments +1. `haystack=undefined` *(Array|string)*: haystack includes needle +2. `needle=undefined` *(*|string)*: needle in haystack + +#### Returns +*(boolean)*: needle in haystack + +#### Example +```js +includes('eh', 'e') //=> true +includes('eh', 'nope') //=> false +includes(['eh'], 'eh') //=> true +includes(['eh'], 'nope') //=> false + +``` +--- + + + + + - [1]: # "Jump back to the TOC." + [1]: #includes "Jump back to the TOC." diff --git a/docs/docdown/deps/conditional/index.md b/docs/docdown/deps/conditional/index.md new file mode 100644 index 0000000..c767ad2 --- /dev/null +++ b/docs/docdown/deps/conditional/index.md @@ -0,0 +1,37 @@ +# index.js API documentation + + + + + +## `conditional.conditional` +* `conditional.conditional` + + + + + + + + + +## `conditional.conditional` + + + +

conditional.conditional

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/conditional/index.js#L13 "View in source") [Ⓣ][1] + +Object + +--- + + + + + + + + [1]: #conditional.conditional "Jump back to the TOC." diff --git a/docs/docdown/deps/conditional/not.md b/docs/docdown/deps/conditional/not.md index 3f95750..89f8480 100644 --- a/docs/docdown/deps/conditional/not.md +++ b/docs/docdown/deps/conditional/not.md @@ -4,8 +4,8 @@ -## `conditional.prototype` -* `conditional.prototype.exports` +## `conditional` +* `conditional.not` @@ -15,23 +15,33 @@ -## `conditional.prototype` +## `conditional` -

# conditional.prototype.exports(fn=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/conditional/not.js#L20 "View in source") [Ⓣ][1] +

conditional.not(fn=undefined, x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/conditional/not.js#L31 "View in source") [Ⓣ][1] (Function): return a negated function +A function wrapping a call to the given function in a `!` operation. +It will:
+
+* return `true` when the underlying function would return a false-y value, +
+* and `false` when it would return a truth-y one. -#### Since + +#### @Since 4.0.1 #### Arguments 1. `fn=undefined` *(Function)*: any function +2. `x=undefined` *(*)*: value to pass to function #### Returns -*(Function)*: !Function +*(Function): !Function(x)* #### Example ```js @@ -53,4 +63,4 @@ falsed() - [1]: #conditional.prototype "Jump back to the TOC." + [1]: #conditional "Jump back to the TOC." diff --git a/docs/docdown/deps/conditional/or.md b/docs/docdown/deps/conditional/or.md index fa6b7bf..7969ce3 100644 --- a/docs/docdown/deps/conditional/or.md +++ b/docs/docdown/deps/conditional/or.md @@ -4,8 +4,8 @@ -## `conditional.prototype` -* `conditional.prototype.exports` +## `conditional` +* `conditional.or` @@ -15,28 +15,34 @@ -## `conditional.prototype` +## `conditional` -

# conditional.prototype.exports(left=undefined, right=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/conditional/or.js#L23 "View in source") [Ⓣ][1] +

conditional.or(left=undefined, right=undefined, x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/conditional/or.js#L33 "View in source") [Ⓣ][1] -(Function): first fn || second fn +(Function): first fn || second fn, curried -#### Since + +#### @Since 4.0.1 #### Arguments 1. `left=undefined` *(Function)*: first fn 2. `right=undefined` *(Function)*: second fn +3. `x=undefined` *(*)*: value to pass into left & right, curried #### Returns *(boolean)*: one of the functions return truthy #### Example ```js -const either = or(x => x === false, x => x === true) +const { isTrue, isFalse } = require('chain-able') + +const either = or(isFalse, isTrue) either([true]) //=> true @@ -47,6 +53,9 @@ either([new Boolean(true)]) either([1]) //=> false +// because curried +or(isTrue, isFalse, true) //=> true + ``` --- @@ -56,4 +65,4 @@ either([1]) - [1]: #conditional.prototype "Jump back to the TOC." + [1]: #conditional "Jump back to the TOC." diff --git a/docs/docdown/deps/conditional/some.md b/docs/docdown/deps/conditional/some.md index 4217860..26fde46 100644 --- a/docs/docdown/deps/conditional/some.md +++ b/docs/docdown/deps/conditional/some.md @@ -4,8 +4,8 @@ -## `conditional.prototype` -* `conditional.prototype.some` +## `conditional` +* `conditional.some` @@ -15,23 +15,27 @@ -## `conditional.prototype` +## `conditional` -

# conditional.prototype.some(predicate=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/conditional/some.js#L23 "View in source") [Ⓣ][1] +

conditional.some(predicate=undefined, arr=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/conditional/some.js#L29 "View in source") [Ⓣ][1] -(Function): map all values in an array to see if **some** match +(Function): map all values in an array to see if **some** match, curried -#### Since + +#### @Since 4.0.1 #### Arguments 1. `predicate=undefined` *(Function)*: match the value +2. `arr=undefined` *(Array|any)*: values to match on the predicate #### Returns -*(boolean)*: all match predicate +*(boolean)*: **some** match predicate #### Example ```js @@ -54,4 +58,4 @@ const someBoolean = some(x => typeof x === 'boolean'q) - [1]: #conditional.prototype "Jump back to the TOC." + [1]: #conditional "Jump back to the TOC." diff --git a/docs/docdown/deps/uniq.md b/docs/docdown/deps/construct/map.md similarity index 82% rename from docs/docdown/deps/uniq.md rename to docs/docdown/deps/construct/map.md index 9005e92..2bf4eff 100644 --- a/docs/docdown/deps/uniq.md +++ b/docs/docdown/deps/construct/map.md @@ -1,4 +1,4 @@ -# uniq.js API documentation +# map.js API documentation diff --git a/docs/docdown/deps/prefix.md b/docs/docdown/deps/construct/regexp.md similarity index 81% rename from docs/docdown/deps/prefix.md rename to docs/docdown/deps/construct/regexp.md index 25d578a..214d545 100644 --- a/docs/docdown/deps/prefix.md +++ b/docs/docdown/deps/construct/regexp.md @@ -1,4 +1,4 @@ -# prefix.js API documentation +# regexp.js API documentation diff --git a/docs/docdown/deps/primitives/true.md b/docs/docdown/deps/construct/set.md similarity index 82% rename from docs/docdown/deps/primitives/true.md rename to docs/docdown/deps/construct/set.md index 7d1b9a9..e2a6d32 100644 --- a/docs/docdown/deps/primitives/true.md +++ b/docs/docdown/deps/construct/set.md @@ -1,4 +1,4 @@ -# true.js API documentation +# set.js API documentation diff --git a/docs/docdown/deps/define.md b/docs/docdown/deps/define.md index 4ec9f2f..8b0d246 100644 --- a/docs/docdown/deps/define.md +++ b/docs/docdown/deps/define.md @@ -5,7 +5,7 @@ ## `exports` -* `exports` +* `exports` @@ -19,12 +19,15 @@ -

# exports(obj=undefined, name=undefined, descriptor=undefined)

+

exports(obj=undefined, name=undefined, descriptor=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/define.js#L19 "View in source") [Ⓣ][1] (Function): default to configurable and enumerable, unless configured otherwise -#### Since + +#### @Since 4.0.0 #### Arguments diff --git a/docs/docdown/deps/dopemerge/dopemerge.md b/docs/docdown/deps/dopemerge/dopemerge.md index f836f2f..d1553e1 100644 --- a/docs/docdown/deps/dopemerge/dopemerge.md +++ b/docs/docdown/deps/dopemerge/dopemerge.md @@ -4,12 +4,11 @@ -## `dopemerge.prototype` -* `dopemerge.prototype.cloneIfNeeded` -* `dopemerge.prototype.defaultArrayMerge` -* `dopemerge.prototype.dopemerge` -* `dopemerge.prototype.emptyTarget` -* `dopemerge.prototype.isMergeableObj` +## `dopemerge` +* `dopemerge.cloneIfNeeded` +* `dopemerge.defaultArrayMerge` +* `dopemerge.dopemerge` +* `dopemerge.isMergeableObj` @@ -19,21 +18,24 @@ -## `dopemerge.prototype` +## `dopemerge` -

# dopemerge.prototype.cloneIfNeeded(value=undefined, optsArg=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/dopemerge/dopemerge.js#L90 "View in source") [Ⓣ][1] +

dopemerge.cloneIfNeeded(value=undefined, optsArg=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/dopemerge/dopemerge.js#L71 "View in source") [Ⓣ][1] (Function): Defaults to `false`. If `clone` is `true` then both `x` and `y` are recursively cloned as part of the merge. -### @see +#### @see -* kyle a mathews/deepmerge -#### Since +* kyle a mathews/deepmerge + +#### @Since 2.0.0 #### Arguments @@ -60,15 +62,18 @@ cloneIfNeeded(obj, { clone: false }) === obj -

# dopemerge.prototype.defaultArrayMerge(target=undefined, source=undefined, optsArg=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/dopemerge/dopemerge.js#L129 "View in source") [Ⓣ][1] +

dopemerge.defaultArrayMerge(target=undefined, source=undefined, optsArg=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/dopemerge/dopemerge.js#L110 "View in source") [Ⓣ][1] (Function): The merge will also merge arrays and array values by default. However, there are nigh-infinite valid ways to merge arrays, and you may want to supply your own. You can do this by passing an `arrayMerge` function as an option. -#### Since + +#### @Since 2.0.0 #### Arguments @@ -105,16 +110,18 @@ merge([1, 2, 3], [3, 2, 1], { arrayMerge: concatMerge }) 🌊 Types: _dopemergelater.d  -

# dopemerge.prototype.dopemerge(obj1=undefined, obj2=undefined, opts=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/dopemerge/dopemerge.js#L67 "View in source") [Ⓣ][1] +

dopemerge.dopemerge(obj1=undefined, obj2=undefined, opts=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/dopemerge/dopemerge.js#L58 "View in source") [Ⓣ][1] (Function): Merge the enumerable attributes of two objects deeply. Merge two objects `x` and `y` deeply, returning a new merged object with the elements from both `x` and `y`. If an element at the same key is present for both `x` and `y`, the value from `y` will appear in the result. Merging creates a new object, so that neither `x` or `y` are be modified. However, child objects on `x` or `y` are copied over - if you want to copy all values, you must pass `true` to the clone option. -### @see +#### @see -* kyle a mathews/deepmerge +* kyle a mathews/deepmerge #### Arguments 1. `obj1=undefined` *(*)*: left 2. `obj2=undefined` *(*)*: right @@ -176,41 +183,15 @@ merge(x, y) -

# dopemerge.prototype.emptyTarget(val=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/dopemerge/dopemerge.js#L61 "View in source") [Ⓣ][1] - -(Function): make a new empty Array or Object for cloning - -#### Since -2.0.0 - -#### Arguments -1. `val=undefined` *(*)*: array or object to return an empty one of - -#### Returns -*(*)*: depending on the data type of val - -#### Example -```js -emptyTarget({ eh: true }) -//=> {} - -emptyTarget([1]) -//=> [] - -``` ---- - - - - - -

# dopemerge.prototype.isMergeableObj(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/dopemerge/dopemerge.js#L41 "View in source") [Ⓣ][1] +

dopemerge.isMergeableObj(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/dopemerge/dopemerge.js#L42 "View in source") [Ⓣ][1] (Function): 1: not null object `2`: object toString is not a date or regex -#### Since + +#### @Since 2.0.0 #### Arguments @@ -242,4 +223,4 @@ isMergeableObj(/eh/) - [1]: #dopemerge.prototype "Jump back to the TOC." + [1]: #dopemerge "Jump back to the TOC." diff --git a/docs/docdown/deps/dopemerge/emptyTarget.md b/docs/docdown/deps/dopemerge/emptyTarget.md new file mode 100644 index 0000000..29fe4c1 --- /dev/null +++ b/docs/docdown/deps/dopemerge/emptyTarget.md @@ -0,0 +1,56 @@ +# emptyTarget.js API documentation + + + + + +## `dopemerge` +* `dopemerge.emptyTarget` + + + + + + + + + +## `dopemerge` + + + +

dopemerge.emptyTarget(val=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/dopemerge/emptyTarget.js#L22 "View in source") [Ⓣ][1] + +(Function): make a new empty Array or Object for cloning + + +#### @Since +2.0.0 + +#### Arguments +1. `val=undefined` *(*)*: array or object to return an empty one of + +#### Returns +*(*)*: depending on the data type of val + +#### Example +```js +emptyTarget({ eh: true }) +//=> {} + +emptyTarget([1]) +//=> [] + +``` +--- + + + + + + + + [1]: #dopemerge "Jump back to the TOC." diff --git a/docs/docdown/deps/dopemerge/map.md b/docs/docdown/deps/dopemerge/map.md index 2bf4eff..331743f 100644 --- a/docs/docdown/deps/dopemerge/map.md +++ b/docs/docdown/deps/dopemerge/map.md @@ -2,10 +2,62 @@ + + +## `dopemerge` +* `dopemerge.exports` + + + + + +## `dopemerge` + + + +

dopemerge.exports(obj1=undefined, obj2=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/dopemerge/map.js#L32 "View in source") [Ⓣ][1] + +(Function): merge maps & sets + + +#### @todos + +- [ ] easy clone + +#### Arguments +1. `obj1=undefined` *(Map|Set)*: merge with `2` +2. `obj2=undefined` *(Map|Set)*: merge with `1` + +#### Returns +*(*)*: merged + +#### Example +```js +var targetMap = new Map() +targetMap.set('true', false) +targetMap.set('obj', { obj: [] }) +targetMap.set('arr', [1]) +var srcMap = new Map() +srcMap.set('true', true) +srcMap.set('obj', { obj: [Symbol] }) +srcMap.set('arr', [2]) +srcMap.set('emptyArr', []) +var mergedMap = dopemergeMap(targetMap, srcMap, { clone: true }) + +``` +--- + + + + + - [1]: # "Jump back to the TOC." + [1]: #dopemerge "Jump back to the TOC." diff --git a/docs/docdown/deps/dot/delete.md b/docs/docdown/deps/dot/delete.md index a0a1434..1ba2195 100644 --- a/docs/docdown/deps/dot/delete.md +++ b/docs/docdown/deps/dot/delete.md @@ -2,10 +2,59 @@ + + +## `dot` +* `dot.dot.delete` + + + + + +## `dot` + + + +

dot.dot.delete(obj=undefined, path=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/dot/delete.js#L26 "View in source") [Ⓣ][1] + +(Function): delete a path on an object + + +#### @extends + + + + +#### @Since +3.0.0 + +#### Arguments +1. `obj=undefined` *(Object)*: the object to DELETE the nested property from. +2. `path=undefined` *(Array|Dottable|string)*: dot-prop-path to use + +#### Returns +*(void)*: + +#### Example +```js +dot.get({ a: { b: 2 } }, 'a.b') //=> 2 +dot.get({ a: { b: 2 } }, ['a', 'b']) //=> 2 +dot.get({ c: { b: 2 } }, ['a', 'b']) //=> undefined + +``` +--- + + + + + - [1]: # "Jump back to the TOC." + [1]: #dot "Jump back to the TOC." diff --git a/docs/docdown/deps/dot/escape.md b/docs/docdown/deps/dot/escape.md index 1dd358e..1a1be80 100644 --- a/docs/docdown/deps/dot/escape.md +++ b/docs/docdown/deps/dot/escape.md @@ -2,10 +2,41 @@ + + +## `dot` +* `dot.escapeDot` + + + + + +## `dot` + + + +

dot.escapeDot

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/dot/escape.js#L8 "View in source") [Ⓣ][1] + +unknown + + +#### @extends + + + +--- + + + + + - [1]: # "Jump back to the TOC." + [1]: #dot "Jump back to the TOC." diff --git a/docs/docdown/deps/dot/get.md b/docs/docdown/deps/dot/get.md index b235fbe..9528780 100644 --- a/docs/docdown/deps/dot/get.md +++ b/docs/docdown/deps/dot/get.md @@ -2,10 +2,60 @@ + + +## `dot` +* `dot.dot.get` + + + + + +## `dot` + + + +

dot.dot.get(obj=undefined, path=undefined, fallback=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/dot/get.js#L27 "View in source") [Ⓣ][1] + +Function + + +#### @extends + + + + +#### @Since +3.0.0 + +#### Arguments +1. `obj=undefined` *(Object)*: the object to retrieve the nested property from. +2. `path=undefined` *(Array|Dottable|string)*: dot-prop-path to use +3. `fallback=undefined` *(*)*: use when there is no value at specified path + +#### Returns +*(*)*: value at path or fallback + +#### Example +```js +dot.get({ a: { b: 2 } }, 'a.b') //=> 2 +dot.get({ a: { b: 2 } }, ['a', 'b']) //=> 2 +dot.get({ c: { b: 2 } }, ['a', 'b']) //=> undefined + +``` +--- + + + + + - [1]: # "Jump back to the TOC." + [1]: #dot "Jump back to the TOC." diff --git a/docs/docdown/deps/dot/has.md b/docs/docdown/deps/dot/has.md index 9a98c3a..f0d74f9 100644 --- a/docs/docdown/deps/dot/has.md +++ b/docs/docdown/deps/dot/has.md @@ -2,10 +2,59 @@ + + +## `dot` +* `dot.dot.has` + + + + + +## `dot` + + + +

dot.dot.has(obj=undefined, path=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/dot/has.js#L23 "View in source") [Ⓣ][1] + +Function + + +#### @extends + + + + +#### @Since +3.0.0 + +#### Arguments +1. `obj=undefined` *(Object)*: the object to retrieve the nested property from. +2. `path=undefined` *(Array|Dottable|string)*: dot-prop-path to use + +#### Returns +*(boolean)*: has at path + +#### Example +```js +dot.has({ a: { b: 2 } }, 'a.b') //=> true +dot.has({ a: { b: 2 } }, ['a', 'b']) //=> true +dot.has({ c: { b: 2 } }, ['a', 'b']) //=> undefined + +``` +--- + + + + + - [1]: # "Jump back to the TOC." + [1]: #dot "Jump back to the TOC." diff --git a/docs/docdown/deps/dot/paths.md b/docs/docdown/deps/dot/paths.md index 38428f1..f736c15 100644 --- a/docs/docdown/deps/dot/paths.md +++ b/docs/docdown/deps/dot/paths.md @@ -5,7 +5,7 @@ ## `exports` -* `exports` +* `exports` @@ -19,27 +19,48 @@ -

# exports(key=undefined, value=undefined, longest=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/dot/paths.js#L16 "View in source") [Ⓣ][1] +

exports(key=undefined, value=undefined, [longest=undefined])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/dot/paths.js#L32 "View in source") [Ⓣ][1] (Function): gathers dot.prop from any value, with a prefixed/base key -### @notes +#### @see + +* fluents/chain able/blob/master/src/deps/traverse.js + +#### @notes * had `onlyLongest` & `asString` but can just .join(',') to match -#### Since + +#### @todos + +- [ ] should build a trie if doing this + + +#### @Since 4.0.0 #### Arguments -1. `key=undefined` *(Primitive)*: -2. `value=undefined` *(Traversable)*: -3. `longest=undefined` *(|boolean)*: +1. `key=undefined` *(Primitive)*: prefixing key for the paths, root path/key +2. `value=undefined` *(Traversable)*: traversable value to extract paths from +3. `[longest=undefined]` *(|boolean)*: optionally filter to keep only longest/deepest paths #### Returns -*(*)*: paths +*(*)*: paths[] + +#### Example +```js +dotPropPaths('', { oh: { eh: true } }) +//=> ['oh.eh'] + +dotPropPaths('moose', { oh: { eh: true } }) +//=> ['moose.oh.eh'] +``` --- diff --git a/docs/docdown/deps/dot/segments.md b/docs/docdown/deps/dot/segments.md index 050c0c3..dd439e4 100644 --- a/docs/docdown/deps/dot/segments.md +++ b/docs/docdown/deps/dot/segments.md @@ -4,8 +4,15 @@ +## `dot` +* `dot.dotPropSegments` + + + + + ## `while` -* `while` +* `while` @@ -15,12 +22,50 @@ +## `dot` + + + +

dot.dotPropSegments(path=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/dot/segments.js#L22 "View in source") [Ⓣ][1] + +Function + + +#### @Since +4.0.0 + +#### Arguments +1. `path=undefined` *(string|string[])*: dot-prop-path + +#### Returns +*(*)*: array path + +#### Example +```js +dotPropSegments('eh.oh') //=> ['eh', 'oh'] +dotPropSegments(['eh', 'oh']) //=> ['eh', 'oh'] +dotPropSegments('ehoh') //=> ['ehoh'] + +``` +--- + + + + + + + ## `while` -

# while()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/dot/segments.js#L30 "View in source") [Ⓣ][1] +

while()

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/dot/segments.js#L46 "View in source") [Ⓣ][1] Function @@ -50,4 +95,4 @@ Function - [1]: #while "Jump back to the TOC." + [1]: #dot "Jump back to the TOC." diff --git a/docs/docdown/deps/encase/encase.md b/docs/docdown/deps/encase/encase.md index f62ac1c..af4c24e 100644 --- a/docs/docdown/deps/encase/encase.md +++ b/docs/docdown/deps/encase/encase.md @@ -4,8 +4,8 @@ -## `exports` -* `exports` +## `encase` +* `encase.exports` @@ -15,16 +15,28 @@ -## `exports` +## `encase` -

# exports(call=undefined, [encaser=tryCatch])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/encase/encase.js#L33 "View in source") [Ⓣ][1] +

encase.exports(call=undefined, [encaser=tryCatch])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/encase/encase.js#L31 "View in source") [Ⓣ][1] Function -#### Since + +#### @see + +* lodash/lodash/blob/master/attempt.js +* fluture js/fluture + +#### @symb + +🛡 + +#### @Since 4.0.0 #### Arguments @@ -64,4 +76,4 @@ api.call(true) - [1]: #exports "Jump back to the TOC." + [1]: #encase "Jump back to the TOC." diff --git a/docs/docdown/deps/encase/tryCatch.md b/docs/docdown/deps/encase/tryCatch.md index 3abc7f1..b352800 100644 --- a/docs/docdown/deps/encase/tryCatch.md +++ b/docs/docdown/deps/encase/tryCatch.md @@ -4,8 +4,8 @@ -## `exports` -* `exports` +## `encase` +* `encase.exports` @@ -15,15 +15,22 @@ -## `exports` +## `encase` -

# exports(call=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/encase/tryCatch.js#L9 "View in source") [Ⓣ][1] +

encase.exports(call=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/encase/tryCatch.js#L14 "View in source") [Ⓣ][1] Function + +#### @todos + +- [ ] could curry + #### Arguments 1. `call=undefined` *(Function)*: @@ -38,4 +45,4 @@ Function - [1]: #exports "Jump back to the TOC." + [1]: #encase "Jump back to the TOC." diff --git a/docs/docdown/deps/encase/withSpecification.md b/docs/docdown/deps/encase/withSpecification.md index 9d50694..39bad8b 100644 --- a/docs/docdown/deps/encase/withSpecification.md +++ b/docs/docdown/deps/encase/withSpecification.md @@ -2,10 +2,63 @@ + + +## `encase` +* `encase.withSpecification` + + + + + +## `encase` + + + +

encase.withSpecification(specification=undefined, call=undefined, onInvalid=undefined, onInvalid=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/encase/withSpecification.js#L26 "View in source") [Ⓣ][1] + +(Function): a special encased wrapper with no try catch but same api + + +#### @see + +* fluents/chain able/blob/master/src/deps/fp/curry.js + +#### @Since +4.0.0 + +#### Arguments +1. `specification=undefined` *(Function)*: match +2. `call=undefined` *(Function)*: cb to determine valid or invalid +3. `onInvalid=undefined` *(Function)*: cb when invalid +4. `onInvalid=undefined` *(Function)*: cb when valid + +#### Returns +*(Function)*: a lot of functions... + +#### Example +```js +const onInvalid = console.error +const onValid = console.debug +const onCall = console.log +const encased = withSpecification(x => true)(onCall)(onValid, onInvalid) + +encased(1, 2, 3) //=> onCall (did not throw) + +``` +--- + + + + + - [1]: # "Jump back to the TOC." + [1]: #encase "Jump back to the TOC." diff --git a/docs/docdown/deps/primitives/false.md b/docs/docdown/deps/expressions/above.md similarity index 82% rename from docs/docdown/deps/primitives/false.md rename to docs/docdown/deps/expressions/above.md index 6fecc40..2157746 100644 --- a/docs/docdown/deps/primitives/false.md +++ b/docs/docdown/deps/expressions/above.md @@ -1,4 +1,4 @@ -# false.js API documentation +# above.js API documentation diff --git a/docs/docdown/deps/expressions/below.md b/docs/docdown/deps/expressions/below.md new file mode 100644 index 0000000..df7fc66 --- /dev/null +++ b/docs/docdown/deps/expressions/below.md @@ -0,0 +1,11 @@ +# below.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/expressions/between.md b/docs/docdown/deps/expressions/between.md new file mode 100644 index 0000000..e6d295d --- /dev/null +++ b/docs/docdown/deps/expressions/between.md @@ -0,0 +1,53 @@ +# between.js API documentation + + + + + +## `between` +* `between` + + + + + + + + + +## `between` + + + +

between(x=undefined, min=undefined, max=undefined, greaterThanOrEqualTo=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/expressions/between.js#L15 "View in source") [Ⓣ][1] + +Function + +#### Arguments +1. `x=undefined` *(number)*: number between +2. `min=undefined` *(number)*: minimum +3. `max=undefined` *(number)*: maximum +4. `greaterThanOrEqualTo=undefined` *(boolean): strictly between, not equal to *(left right)** + +#### Returns +*(boolean)*: x >= min && x <= max + +#### Example +```js +between(100, 0, 200) //=> true +between(100, 100, 100) //=> true +between(100, 10, 99) //=> false + +``` +--- + + + + + + + + [1]: #between "Jump back to the TOC." diff --git a/docs/docdown/deps/escape-string-regex.md b/docs/docdown/deps/expressions/bitwiseMathOperator.md similarity index 75% rename from docs/docdown/deps/escape-string-regex.md rename to docs/docdown/deps/expressions/bitwiseMathOperator.md index 05ff141..b9e74da 100644 --- a/docs/docdown/deps/escape-string-regex.md +++ b/docs/docdown/deps/expressions/bitwiseMathOperator.md @@ -1,4 +1,4 @@ -# escape-string-regex.js API documentation +# bitwiseMathOperator.js API documentation diff --git a/docs/docdown/deps/expressions/even.md b/docs/docdown/deps/expressions/even.md new file mode 100644 index 0000000..431e9f1 --- /dev/null +++ b/docs/docdown/deps/expressions/even.md @@ -0,0 +1,60 @@ +# even.js API documentation + + + + + +## `exports` +* `exports` + + + + + + + + + +## `exports` + + + +

exports(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/expressions/even.js#L24 "View in source") [Ⓣ][1] + +(Function): isEven + + +#### @extends + + + +#### Arguments +1. `x=undefined` *(any|number)*: value to check + +#### Returns +*(boolean)*: isEven + +#### Example +```js +isEven(1) +//=> false +isEven(2) +//=> true + +var rando = Math.floor(Math.random(0, 10000)) +isEven(rando) !== isOdd(rando) +//=> true + +``` +--- + + + + + + + + [1]: #exports "Jump back to the TOC." diff --git a/docs/docdown/deps/expressions/expressions.md b/docs/docdown/deps/expressions/expressions.md new file mode 100644 index 0000000..f2a4afd --- /dev/null +++ b/docs/docdown/deps/expressions/expressions.md @@ -0,0 +1,11 @@ +# expressions.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/expressions/increment.md b/docs/docdown/deps/expressions/increment.md new file mode 100644 index 0000000..127ef2d --- /dev/null +++ b/docs/docdown/deps/expressions/increment.md @@ -0,0 +1,11 @@ +# increment.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/expressions/index.md b/docs/docdown/deps/expressions/index.md new file mode 100644 index 0000000..5ac127d --- /dev/null +++ b/docs/docdown/deps/expressions/index.md @@ -0,0 +1,11 @@ +# index.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/expressions/odd.md b/docs/docdown/deps/expressions/odd.md new file mode 100644 index 0000000..b5cd1b7 --- /dev/null +++ b/docs/docdown/deps/expressions/odd.md @@ -0,0 +1,56 @@ +# odd.js API documentation + + + + + +## `exports` +* `exports` + + + + + + + + + +## `exports` + + + +

exports(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/expressions/odd.js#L20 "View in source") [Ⓣ][1] + +(Function): isOdd + + +#### @extends + + + +#### Arguments +1. `x=undefined` *(any|number)*: value to check + +#### Returns +*(boolean)*: isOdd + +#### Example +```js +isOdd(1) +//=> true +isOdd(2) +//=> false + +``` +--- + + + + + + + + [1]: #exports "Jump back to the TOC." diff --git a/docs/docdown/deps/fp/always.md b/docs/docdown/deps/fp/always.md new file mode 100644 index 0000000..4f06ea9 --- /dev/null +++ b/docs/docdown/deps/fp/always.md @@ -0,0 +1,73 @@ +# always.js API documentation + + + + + +## `fp` +* `fp.` + + + + + + + + + +## `fp` + + + +🌊 Types: fp.d  + +🔬 Tests: always  + +

fp.exports(value=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/fp/always.js#L22 "View in source") [Ⓣ][1] + +(Function): Returns a function that always returns the given value. Note that for +non-primitives the value returned is a reference to the original value. +
+
+This function is known as `const`, `constant`, or `K` *(for K combinator)* in +other languages and libraries. + + +#### @see + +* ramda/ramda/issues/1038 +* ramda/ramda/blob/master/src/always.js +* lodash/lodash/issues/1010 +* Underscorejs.org + +#### @sig + +a -> (* -> a) + +#### @Since +v5.0.0 + +#### Arguments +1. `value=undefined` *(*)*: The value to wrap in a function + +#### Returns +*(Function)*: A Function :: * -> val. + +#### Example +```js +var t = always('Tee') +t() //=> 'Tee' + +``` +--- + + + + + + + + [1]: #fp "Jump back to the TOC." diff --git a/docs/docdown/deps/fp/arity.md b/docs/docdown/deps/fp/arity.md new file mode 100644 index 0000000..3023772 --- /dev/null +++ b/docs/docdown/deps/fp/arity.md @@ -0,0 +1,63 @@ +# arity.js API documentation + + + + + +## `fp` +* `fp.exports` + + + + + + + + + +## `fp` + + + +

fp.exports(n=undefined, fn=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/fp/arity.js#L17 "View in source") [Ⓣ][1] + +(Function): just for `.length` of a function? + + +#### @see + +* Developer.mozilla.org/en us/docs/web/java script/reference/global objects/function/arity + +#### @todos + +- [ ] keeping this means change uglify... + + +#### @Since +5.0.0 + +#### Arguments +1. `n=undefined` *(number)*: number of arguments +2. `fn=undefined` *(Function)*: function to wrap + +#### Returns +*(Function)*: function with params + +#### Example +```js +const wan = one => console.log(one) + arity(1, wan) + => function(one => wan(one)) +``` +--- + + + + + + + + [1]: #fp "Jump back to the TOC." diff --git a/docs/docdown/deps/insert-at-index.md b/docs/docdown/deps/fp/callDestructure.md similarity index 77% rename from docs/docdown/deps/insert-at-index.md rename to docs/docdown/deps/fp/callDestructure.md index 3b28de7..55fae32 100644 --- a/docs/docdown/deps/insert-at-index.md +++ b/docs/docdown/deps/fp/callDestructure.md @@ -1,4 +1,4 @@ -# insert-at-index.js API documentation +# callDestructure.js API documentation diff --git a/docs/docdown/deps/fp/construct.md b/docs/docdown/deps/fp/construct.md new file mode 100644 index 0000000..1174a16 --- /dev/null +++ b/docs/docdown/deps/fp/construct.md @@ -0,0 +1,95 @@ +# construct.js API documentation + + + + + +## `fp` +* `fp.` + + + + + + + + + +## `fp` + + + +

fp.constructN(n=undefined, Klass=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/fp/construct.js#L47 "View in source") [Ⓣ][1] + +(Function): Wraps a constructor function inside a curried function that can be called +with the same arguments and returns the same type. The arity of the function +returned is specified to allow using variadic constructor functions. + + +#### @see + +* ramda/ramda/blob/master/src/construct n.js + +#### @sig + +Number -> (* -> {*}) -> (* -> {*}) + +#### @symb + +👷 + +#### @extends + +* undefined +* undefined + + + +#### @Since +5.0.0-beta.4 + +#### Arguments +1. `n=undefined` *(number): The arity of the constructor function. *(aka, number of args)** +2. `Klass=undefined` *(Function): The constructor function to wrap. *(class to do `new Klass` on)** + +#### Returns +*(Function)*: A wrapped, curried constructor function. + +#### Example +```js +// Variadic Constructor function +function Salad() { + this.ingredients = arguments +} + +Salad.prototype.recipe = function() { + var instructions = R.map( + ingredient => 'Add a dollop of ' + ingredient, + this.ingredients + ) + return R.join('\n', instructions) +} + +var ThreeLayerSalad = R.constructN(3, Salad) + +// Notice we no longer need the 'new' keyword, and the constructor is curried for 3 arguments. +var salad = ThreeLayerSalad('Mayonnaise')('Potato Chips')('Ketchup') + +console.log(salad.recipe()) +// Add a dollop of Mayonnaise +// Add a dollop of Potato Chips +// Add a dollop of Ketchup + +``` +--- + + + + + + + + [1]: #fp "Jump back to the TOC." diff --git a/docs/docdown/deps/fp/constructInit.md b/docs/docdown/deps/fp/constructInit.md new file mode 100644 index 0000000..bebbdc3 --- /dev/null +++ b/docs/docdown/deps/fp/constructInit.md @@ -0,0 +1,11 @@ +# constructInit.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/fp/curry.md b/docs/docdown/deps/fp/curry.md new file mode 100644 index 0000000..772e0d9 --- /dev/null +++ b/docs/docdown/deps/fp/curry.md @@ -0,0 +1,154 @@ +# curry.js API documentation + + + + + +## `fp` +* `fp.` +* `fp.` + + + + + + + + + +## `fp` + + + +🌊 Types: fp.d  + +🔬 Tests: curry  + +

fp._curryN(length=undefined, received=undefined, fn=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/fp/curry.js#L45 "View in source") [Ⓣ][1] + +(Function): Returns a curried equivalent of the provided function, with the specified +arity. The curried function has two unusual capabilities. First, its +arguments needn't be provided one at a time. If `g` is `R.curryN(3, f)`, the +following are equivalent: +
+
+
* `g(1)(2)(3)` +
* `g(1)(2, 3)` +
* `g(1, 2)(3)` +
* `g(1, 2, 3)` +
+
+Secondly, the special placeholder value [`R.__`](#__) may be used to specify +"gaps", allowing partial application of any combination of arguments, +regardless of their positions. If `g` is as above and `_` is [`R.__`](#__), +the following are equivalent: +
+
+
* `g(1, 2, 3)` +
* `g(_, 2, 3)(1)` +
* `g(_, _, 3)(1)(2)` +
* `g(_, _, 3)(1, 2)` +
* `g(_, 2)(1)(3)` +
* `g(_, 2)(1, 3)` +
* `g(_, 2)(_, 3)(1)` + + +#### @sig + +Number -> (* -> a) -> (* -> a) + +#### @Since +5.0.0-beta.1 + +#### Arguments +1. `length=undefined` *(Number)*: The arity of the curried function. +2. `received=undefined` *(Array)*: An array of arguments received thus far. +3. `fn=undefined` *(Function)*: The function to curry. + +#### Returns +*(Function)*: A new, curried function. + +#### Example +```js +var sumArgs = (...args) => R.sum(args) + +var curriedAddFourNumbers = R.curryN(4, sumArgs) +var f = curriedAddFourNumbers(1, 2) +var g = f(3) +g(4) //=> 10 + +``` +--- + + + + + +

fp.exports(length=undefined, fn=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/fp/curry.js#L139 "View in source") [Ⓣ][1] + +(Function): Returns a curried equivalent of the provided function, with the specified +arity. The curried function has two unusual capabilities. First, its +arguments needn't be provided one at a time. If `g` is `R.curryN(3, f)`, the +following are equivalent: +
+
+
* `g(1)(2)(3)` +
* `g(1)(2, 3)` +
* `g(1, 2)(3)` +
* `g(1, 2, 3)` +
+
+Secondly, the special placeholder value [`R.__`](#__) may be used to specify +"gaps", allowing partial application of any combination of arguments, +regardless of their positions. If `g` is as above and `_` is [`R.__`](#__), +the following are equivalent: +
+
+
* `g(1, 2, 3)` +
* `g(_, 2, 3)(1)` +
* `g(_, _, 3)(1)(2)` +
* `g(_, _, 3)(1, 2)` +
* `g(_, 2)(1)(3)` +
* `g(_, 2)(1, 3)` +
* `g(_, 2)(_, 3)(1)` + + +#### @sig + +Number -> (* -> a) -> (* -> a) + +#### @Since +v0.5.0 + +#### Arguments +1. `length=undefined` *(Number)*: The arity for the returned function. +2. `fn=undefined` *(Function)*: The function to curry. + +#### Returns +*(Function)*: A new, curried function. + +#### Example +```js +var sumArgs = (...args) => R.sum(args) + +var curriedAddFourNumbers = R.curryN(4, sumArgs) +var f = curriedAddFourNumbers(1, 2) +var g = f(3) +g(4) //=> 10 + +``` +--- + + + + + + + + [1]: #fp "Jump back to the TOC." diff --git a/docs/docdown/deps/fp/first.md b/docs/docdown/deps/fp/first.md new file mode 100644 index 0000000..aea48f2 --- /dev/null +++ b/docs/docdown/deps/fp/first.md @@ -0,0 +1,67 @@ +# first.js API documentation + + + + + +## `fp` +* `fp.` + + + + + + + + + +## `fp` + + + +

fp.exports(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/fp/first.js#L33 "View in source") [Ⓣ][1] + +(Function): Returns the first element of the given list or string. In some libraries +this function is named `first`. + + +#### @todos + +- [ ] could just pipe nth + + +#### @extends + + + + +#### @Since +v5.0.0 + +#### Arguments +1. `x=undefined` *(*)*: Array or Object find the last key of + +#### Returns +*(*)*: value at last index + +#### Example +```js +first(['fi', 'fo', 'fum']) //=> 'fi' +first([]) //=> undefined + +first('abc') //=> 'a' +first('') //=> '' + +``` +--- + + + + + + + + [1]: #fp "Jump back to the TOC." diff --git a/docs/docdown/deps/fp/firstIndex.md b/docs/docdown/deps/fp/firstIndex.md new file mode 100644 index 0000000..da7bcb3 --- /dev/null +++ b/docs/docdown/deps/fp/firstIndex.md @@ -0,0 +1,67 @@ +# firstIndex.js API documentation + + + + + +## `fp` +* `fp.firstIndex` + + + + + + + + + +## `fp` + + + +

fp.firstIndex(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/fp/firstIndex.js#L22 "View in source") [Ⓣ][1] + +(Function): get first index in a list + + +#### @see + +* fluents/chain able/blob/master/src/deps/fp/first.js + +#### @notes + +* works for strings too eh + + +#### @extends + + + + +#### @Since +5.0.0-beta.2 + +#### Arguments +1. `x=undefined` *(*|Array|Object|string)*: item to find the first index of + +#### Returns +*(*)*: first index, usually number/string + +#### Example +```js +firstIndex([0, 'one']) //=> 0 +firstIndex({ one: 1, two: 2 }) //=> 'one' + +``` +--- + + + + + + + + [1]: #fp "Jump back to the TOC." diff --git a/docs/docdown/deps/fp/flip.md b/docs/docdown/deps/fp/flip.md new file mode 100644 index 0000000..33dc4e1 --- /dev/null +++ b/docs/docdown/deps/fp/flip.md @@ -0,0 +1,82 @@ +# flip.js API documentation + + + + + +## `fp` +* `fp.` + + + + + + + + + +## `fp` + + + +🌊 Types: fp.d  + +* 🔬 Tests: flip  +* 🔬 Tests: flip2  + +

fp.exports(fn=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/fp/flip.js#L33 "View in source") [Ⓣ][1] + +(Function): flip the fn args:
Creates a function that invokes `func` with arguments reversed. + + +#### @see + +* ramda/ramda/blob/master/src/flip.js +* lodash/lodash/blob/4.2.1 npm packages/lodash.flip/index.js +* fluents/chain able/blob/master/src/deps/fp/reverse.js + +#### @todos + +- [ ] could also just call with fn.apply([b, a]), and have flipN + + +#### @sig + +((a, b, c, ...) -> z) -> (b -> a -> c -> ... -> z) + +#### @symb + +🙃 + +#### @Since +5.0.0-beta.4 + +#### Arguments +1. `fn=undefined` *(Function)*: The function to invoke with its first two parameters reversed. + +#### Returns +*(*)*: The result of invoking `fn` with its first two parameters' order reversed. + +#### Example +```js +var mergeThree = (a, b, c) => [].concat(a, b, c) +mergeThree(1, 2, 3) //=> [1, 2, 3] +flip(mergeThree)(1, 2, 3) //=> [3, 2, 1] + +const flipped = flip((...args) => args) +flipped('a', 'b', 'c', 'd') +// => ['d', 'c', 'b', 'a'] + +``` +--- + + + + + + + + [1]: #fp "Jump back to the TOC." diff --git a/docs/docdown/deps/fp/flip2.md b/docs/docdown/deps/fp/flip2.md new file mode 100644 index 0000000..dee3e0d --- /dev/null +++ b/docs/docdown/deps/fp/flip2.md @@ -0,0 +1,81 @@ +# flip2.js API documentation + + + + + +## `fp` +* `fp.exports` + + + + + + + + + +## `fp` + + + +🌊 Types: fp.d  + +🔬 Tests: flip2  + +

fp.exports(fn=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/fp/flip2.js#L34 "View in source") [Ⓣ][1] + +(Function): Returns a new function much like the supplied one, except that the first two +arguments' order is reversed. + + +#### @see + +* fluents/chain able/blob/master/src/deps/fp/flip.js + +#### @todos + +- [ ] flipN + + +#### @symb + +🙃🙃 + +#### @extends + + + + +#### @Since +5.0.0-beta.4 + +#### Arguments +1. `fn=undefined` *(Function)*: The function to invoke with its first two parameters reversed. + +#### Returns +*(*)*: The result of invoking `fn` with its first two parameters' order reversed. + +#### Example +```js +var mergeThree = (a, b, c) => [].concat(a, b, c) +mergeThree(1, 2, 3) //=> [1, 2, 3] +flip(mergeThree)(1, 2, 3) //=> [2, 1, 3] + +const flipped = flip((...args) => args) +flipped('a', 'b', 'c', 'd') +// => ['b', 'a', 'c', 'd'] + +``` +--- + + + + + + + + [1]: #fp "Jump back to the TOC." diff --git a/docs/docdown/deps/fp/fp.md b/docs/docdown/deps/fp/fp.md new file mode 100644 index 0000000..790e8be --- /dev/null +++ b/docs/docdown/deps/fp/fp.md @@ -0,0 +1,55 @@ +# fp.js API documentation + + + + + +## `fp.exports` +* `fp.exports` + + + + + + + + + +## `fp.exports` + + + +🌊 Types: fp.d  + +* 🔬 Tests: always  +* 🔬 Tests: construct  +* 🔬 Tests: curry  +* 🔬 Tests: firstLast  +* 🔬 Tests: flip  +* 🔬 Tests: flip2  +* 🔬 Tests: path  +* 🔬 Tests: pipe  +* 🔬 Tests: remove  +* 🔬 Tests: replace  +* 🔬 Tests: reverse  + +

fp.exports

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/fp/fp.js#L31 "View in source") [Ⓣ][1] + +Object + + +#### @symb + +🐏 +--- + + + + + + + + [1]: #fp.exports "Jump back to the TOC." diff --git a/docs/docdown/deps/fp/hasInMatching.md b/docs/docdown/deps/fp/hasInMatching.md new file mode 100644 index 0000000..4767a6a --- /dev/null +++ b/docs/docdown/deps/fp/hasInMatching.md @@ -0,0 +1,70 @@ +# hasInMatching.js API documentation + + + + + +## `is` +* `is.hasInMatching` + + + + + + + + + +## `is` + + + +

is.hasInMatching(predicate=undefined, obj=undefined, prop=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/fp/hasInMatching.js#L30 "View in source") [Ⓣ][1] + +(Function): isIn + hasIn ...and also allows a predicate/matcher/specification + + +#### @todos + +- [ ] surely would be better with focusing on a prop, then applying predicate, lense? :s +- [ ] is it better in fp/ or is/ ? needs some definitions + + +#### @extends + +* undefined +* undefined +* undefined + + + +#### @Since +5.0.0-beta.4 + +#### Arguments +1. `predicate=undefined` *(Object)*: predicate match the property against this +2. `obj=undefined` *(Object)*: object to check +3. `prop=undefined` *(any)*: property to check in object + +#### Returns +*(boolean)*: obj[prop] hasIn & satisfies + +#### Example +```js +hasIn({}, 'eh') //=> false +hasIn(null, 'eh') //=> false +hasIn({ eh: true }, 'eh') //=> true + +``` +--- + + + + + + + + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/fp/includesCount.md b/docs/docdown/deps/fp/includesCount.md new file mode 100644 index 0000000..122c8e4 --- /dev/null +++ b/docs/docdown/deps/fp/includesCount.md @@ -0,0 +1,62 @@ +# includesCount.js API documentation + + + + + +## `getIncludesCount` +* `getIncludesCount` + + + + + + + + + +## `getIncludesCount` + + + +

getIncludesCount(haystack=undefined, needle=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/fp/includesCount.js#L19 "View in source") [Ⓣ][1] + +(Function): getIncludesCount, how many times a needle occurrs in a haystack + + +#### @see + +* Developer.mozilla.org/en/docs/web/java script/reference/global objects/string/index of +* Developer.mozilla.org/en/docs/web/java script/reference/global objects/array/index of + +#### @Since +5.0.0-beta.4 + +#### Arguments +1. `haystack=undefined` *(Array|string)*: haystack to look in +2. `needle=undefined` *(Matchable|string)*: needle to find + +#### Returns +*(number)*: occurrs/includes times/count + +#### Example +```js +getIncludesCount('1 00 1', '1') //=> 2 +getIncludesCount([1, 1, 0, 0], 1) //=> 2 +getIncludesCount([0], 1) //=> 0 +getIncludesCount('', 1) //=> 0 +getIncludesCount(null, 1) //=> 0 + +``` +--- + + + + + + + + [1]: #getincludescount "Jump back to the TOC." diff --git a/docs/docdown/deps/fp/index.md b/docs/docdown/deps/fp/index.md new file mode 100644 index 0000000..5ac127d --- /dev/null +++ b/docs/docdown/deps/fp/index.md @@ -0,0 +1,11 @@ +# index.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/fp/invoke.md b/docs/docdown/deps/fp/invoke.md new file mode 100644 index 0000000..f2c44ef --- /dev/null +++ b/docs/docdown/deps/fp/invoke.md @@ -0,0 +1,11 @@ +# invoke.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/fp/isPlaceholder.md b/docs/docdown/deps/fp/isPlaceholder.md new file mode 100644 index 0000000..9ebdf23 --- /dev/null +++ b/docs/docdown/deps/fp/isPlaceholder.md @@ -0,0 +1,11 @@ +# isPlaceholder.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/fp/last.md b/docs/docdown/deps/fp/last.md new file mode 100644 index 0000000..e681559 --- /dev/null +++ b/docs/docdown/deps/fp/last.md @@ -0,0 +1,75 @@ +# last.js API documentation + + + + + +## `fp` +* `fp.` + + + + + + + + + +## `fp` + + + +🌊 Types: fp.d  + +* 🔬 Tests: always  +* 🔬 Tests: construct  +* 🔬 Tests: curry  +* 🔬 Tests: firstLast  +* 🔬 Tests: flip  +* 🔬 Tests: flip2  +* 🔬 Tests: path  +* 🔬 Tests: pipe  +* 🔬 Tests: remove  +* 🔬 Tests: replace  +* 🔬 Tests: reverse  + +

fp.exports(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/fp/last.js#L33 "View in source") [Ⓣ][1] + +(Function): Returns the last element of the given list or string. + + +#### @extends + + + + +#### @Since +5.0.0-beta.2 + +#### Arguments +1. `x=undefined` *(*)*: list to get last index of + +#### Returns +*(*)*: + +#### Example +```js +last(['fi', 'fo', 'fum']) //=> 'fum' +last([]) //=> undefined + +last('abc') //=> 'c' +last('') //=> '' + +``` +--- + + + + + + + + [1]: #fp "Jump back to the TOC." diff --git a/docs/docdown/deps/fp/lastIndex.md b/docs/docdown/deps/fp/lastIndex.md new file mode 100644 index 0000000..7f25edc --- /dev/null +++ b/docs/docdown/deps/fp/lastIndex.md @@ -0,0 +1,67 @@ +# lastIndex.js API documentation + + + + + +## `fp` +* `fp.lastIndex` + + + + + + + + + +## `fp` + + + +

fp.lastIndex(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/fp/lastIndex.js#L23 "View in source") [Ⓣ][1] + +(Function): get last index in a list + + +#### @see + +* fluents/chain able/blob/master/src/deps/fp/last.js + +#### @notes + +* works for strings too eh + + +#### @extends + + + + +#### @Since +5.0.0-beta.2 + +#### Arguments +1. `x=undefined` *(*|Array|Object|string)*: item to find the last index of + +#### Returns +*(*)*: last index, usually number/string + +#### Example +```js +lastIndex([0, 'one']) //=> 1 +lastIndex({ one: 1, two: 2 }) //=> 'two' + +``` +--- + + + + + + + + [1]: #fp "Jump back to the TOC." diff --git a/docs/docdown/deps/fp/mapWhere.md b/docs/docdown/deps/fp/mapWhere.md new file mode 100644 index 0000000..0b70164 --- /dev/null +++ b/docs/docdown/deps/fp/mapWhere.md @@ -0,0 +1,56 @@ +# mapWhere.js API documentation + + + + + +## `fp` +* `fp.mapWhere` + + + + + + + + + +## `fp` + + + +

fp.mapWhere(obj=undefined, predicate=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/fp/mapWhere.js#L26 "View in source") [Ⓣ][1] + +(Function): Creates an array of values by running each property of `object` thru +`iteratee`. The iteratee is invoked with three arguments: *(value, key, object)*. + + +#### @Since +5.0.0 + +#### Arguments +1. `obj=undefined` *(Object)*: The object to iterate over. +2. `predicate=undefined` *(Function)*: The function invoked per iteration. + +#### Returns +*(Array)*: Returns the new mapped array. + +#### Example +```js +const square = n => n * n +map({ a: 4, b: 8 }, square) +// => [16, 64] (iteration order is not guaranteed) + +``` +--- + + + + + + + + [1]: #fp "Jump back to the TOC." diff --git a/docs/docdown/deps/fp/path.md b/docs/docdown/deps/fp/path.md new file mode 100644 index 0000000..36e690f --- /dev/null +++ b/docs/docdown/deps/fp/path.md @@ -0,0 +1,58 @@ +# path.js API documentation + + + + + +## `fp` +* `fp.` + + + + + + + + + +## `fp` + + + +

fp.exports(path=undefined, obj=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/fp/path.js#L27 "View in source") [Ⓣ][1] + +(Function): Retrieve the value at a given path. + + +#### @sig + +[Idx] -> {a} -> a | Undefined + +#### @Since +v5.0.0 + +#### Arguments +1. `path=undefined` *(Array)*: The path to use. +2. `obj=undefined` *(Object)*: The object to retrieve the nested property from. + +#### Returns +*(*)*: The data at `path`. + +#### Example +```js +R.path(['a', 'b'], { a: { b: 2 } }) //=> 2 +R.path(['a', 'b'], { c: { b: 2 } }) //=> undefined + +``` +--- + + + + + + + + [1]: #fp "Jump back to the TOC." diff --git a/docs/docdown/deps/fp/pipe.md b/docs/docdown/deps/fp/pipe.md new file mode 100644 index 0000000..a510aff --- /dev/null +++ b/docs/docdown/deps/fp/pipe.md @@ -0,0 +1,85 @@ +# pipe.js API documentation + + + + + +## `fp` +* `fp.` + + + + + + + + + +## `fp` + + + +🌊 Types: fp.d  + +🔬 Tests: pipe  + +

fp.exports(first=undefined, rest=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/fp/pipe.js#L46 "View in source") [Ⓣ][1] + +(Function): Performs left-to-right function composition. The leftmost function may have +any arity; the remaining functions must be unary. +In some libraries this function is named `sequence`. + + +#### @sig + +(((a, b, ..., n) -> o), (o -> p), ..., (x -> y), (y -> z)) -> ((a, b, ..., n) -> z) + +#### @symb + +R.pipe(f, g, h)(a, b) = h(g(f(a, b))) + +#### @extends + + + + +#### @Since +v5.0.0 + +#### Arguments +1. `first=undefined` *(Function)*: function first +2. `rest=undefined` *(...Function)*: function next + +#### Returns +*(Function)*: + +#### Example +```js +var f = R.pipe(Math.pow, R.negate, R.inc) +f(3, 4) // -(3^4) + 1 + +``` +#### Example +```js +var x = v => v + 'x' +var y = v => v + 'y' +var z = v => v + 'z' + +const xyz = pipe(x, y, z) +/// starts with w, adds x, then y, then z +const wxyz = xyz('w') +//=> 'wxyz' + +``` +--- + + + + + + + + [1]: #fp "Jump back to the TOC." diff --git a/docs/docdown/deps/fp/pipeTwo.md b/docs/docdown/deps/fp/pipeTwo.md new file mode 100644 index 0000000..69a5b79 --- /dev/null +++ b/docs/docdown/deps/fp/pipeTwo.md @@ -0,0 +1,64 @@ +# pipeTwo.js API documentation + + + + + +## `fp` +* `fp.` + + + + + + + + + +## `fp` + + + +🌊 Types: fp.d  + +🔬 Tests: pipe  + +

fp.exports(f=undefined, g=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/fp/pipeTwo.js#L28 "View in source") [Ⓣ][1] + +(Function): Performs left-to-right function composition. ONLY CAN PIPE `2` ARGUMENTS + + +#### @notes + +* The result of pipe is not automatically curried. +* This is a variation, is the internal version with only 2 functions, for now + + +#### @Since +v5.0.0 + +#### Arguments +1. `f=undefined` *(...Function)*: function first +2. `g=undefined` *(...Function)*: function next + +#### Returns +*(Function)*: + +#### Example +```js +var f = R.pipe(Math.pow, R.negate) +f(3, 4) // -(3^4) + 1 + +``` +--- + + + + + + + + [1]: #fp "Jump back to the TOC." diff --git a/docs/docdown/deps/fp/prop.md b/docs/docdown/deps/fp/prop.md new file mode 100644 index 0000000..440182e --- /dev/null +++ b/docs/docdown/deps/fp/prop.md @@ -0,0 +1,61 @@ +# prop.js API documentation + + + + + +## `fp` +* `fp.` + + + + + + + + + +## `fp` + + + +🌊 Types: fp.d  + +

fp.exports(p=undefined, obj=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/fp/prop.js#L26 "View in source") [Ⓣ][1] + +(Function): Returns a function that when supplied an object returns the indicated +property of that object, if it exists. + + +#### @sig + +s -> {s: a} -> a | Undefined + +#### @Since +v5.0.0 + +#### Arguments +1. `p=undefined` *(String)*: The property name +2. `obj=undefined` *(Object)*: The object to query + +#### Returns +*(*)*: The value at `obj.p`. + +#### Example +```js +R.prop('x', { x: 100 }) //=> 100 +R.prop('x', {}) //=> undefined + +``` +--- + + + + + + + + [1]: #fp "Jump back to the TOC." diff --git a/docs/docdown/deps/fp/remove.md b/docs/docdown/deps/fp/remove.md new file mode 100644 index 0000000..dbe41a0 --- /dev/null +++ b/docs/docdown/deps/fp/remove.md @@ -0,0 +1,11 @@ +# remove.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/fp/replace.md b/docs/docdown/deps/fp/replace.md new file mode 100644 index 0000000..b13ab6d --- /dev/null +++ b/docs/docdown/deps/fp/replace.md @@ -0,0 +1,71 @@ +# replace.js API documentation + + + + + +## `fp` +* `fp.` + + + + + + + + + +## `fp` + + + +🌊 Types: fp.d  + +🔬 Tests: replace  + +

fp.exports(pattern=undefined, replacement=undefined, str=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/fp/replace.js#L30 "View in source") [Ⓣ][1] + +(Function): Replace a substring or regex match in a string with a replacement. + + +#### @see + +* ramda/ramda/blob/master/src/replace.js +* lodash/lodash/blob/master/replace.js + +#### @sig + +RegExp|String -> String -> String -> String + +#### @Since +v5.0.0 + +#### Arguments +1. `pattern=undefined` *(RegExp|String)*: A regular expression or a substring to match. +2. `replacement=undefined` *(String)*: The string to replace the matches with. +3. `str=undefined` *(String)*: The String to do the search and replacement in. + +#### Returns +*(String)*: The result. + +#### Example +```js +replace('foo', 'bar', 'foo foo foo') //=> 'bar foo foo' +replace(/foo/, 'bar', 'foo foo foo') //=> 'bar foo foo' + +// Use the "g" (global) flag to replace all occurrences: +replace(/foo/g, 'bar', 'foo foo foo') //=> 'bar bar bar' + +``` +--- + + + + + + + + [1]: #fp "Jump back to the TOC." diff --git a/docs/docdown/deps/fp/reverse.md b/docs/docdown/deps/fp/reverse.md new file mode 100644 index 0000000..e238d71 --- /dev/null +++ b/docs/docdown/deps/fp/reverse.md @@ -0,0 +1,70 @@ +# reverse.js API documentation + + + + + +## `fp` +* `fp.` + + + + + + + + + +## `fp` + + + +

fp.exports(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/fp/reverse.js#L30 "View in source") [Ⓣ][1] + +(Function): Returns a new list or string with the elements or characters in reverse +order. + + +#### @see + +* ramda/ramda/blob/master/src/reverse.js +* a/26610963/2855712 + +#### @symb + +⬅️ + +#### @Since +5.0.0-beta.5 + +#### Arguments +1. `x=undefined` *(Array|String): *(list)** string or array to reverse + +#### Returns +*(*)*: + +#### Example +```js +reverse([1, 2, 3]) //=> [3, 2, 1] +reverse([1, 2]) //=> [2, 1] +reverse([1]) //=> [1] +reverse([]) //=> [] + +reverse('abc') //=> 'cba' +reverse('ab') //=> 'ba' +reverse('a') //=> 'a' +reverse('') //=> '' + +``` +--- + + + + + + + + [1]: #fp "Jump back to the TOC." diff --git a/docs/docdown/deps/gc.md b/docs/docdown/deps/gc.md index b12f9ed..4e25f98 100644 --- a/docs/docdown/deps/gc.md +++ b/docs/docdown/deps/gc.md @@ -5,7 +5,7 @@ ## `markForGarbageCollection` -* `markForGarbageCollection` +* `markForGarbageCollection` @@ -19,18 +19,21 @@ -

# markForGarbageCollection(obj=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/gc.js#L41 "View in source") [Ⓣ][1] +

markForGarbageCollection(obj=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/gc.js#L42 "View in source") [Ⓣ][1] (Function): remove all methods, mark for garbage collection -### @todos +#### @todos - [ ] blacklist = [] param - [ ] put all GC events into a cached map and debounce the operation -#### Since + +#### @Since 4.0.0 #### Arguments diff --git a/docs/docdown/deps/is/JSON.md b/docs/docdown/deps/is/JSON.md new file mode 100644 index 0000000..e4f897e --- /dev/null +++ b/docs/docdown/deps/is/JSON.md @@ -0,0 +1,55 @@ +# JSON.js API documentation + + + + + +## `isJSON` +* `isJSON` + + + + + + + + + +## `isJSON` + + + +

isJSON(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/JSON.js#L57 "View in source") [Ⓣ][1] + +(Function): isJSON, without tryCatch + +#### Arguments +1. `x=undefined` *(*)*: value to check + +#### Returns +*(boolean)*: x isJSON + +#### Example +```js +isJSON('{}') +// => true + +isJSON('') +// => false + +isJSON('[]') +// => true + +``` +--- + + + + + + + + [1]: #isjson "Jump back to the TOC." diff --git a/docs/docdown/deps/is/arguments.md b/docs/docdown/deps/is/arguments.md new file mode 100644 index 0000000..09e3a04 --- /dev/null +++ b/docs/docdown/deps/is/arguments.md @@ -0,0 +1,66 @@ +# arguments.js API documentation + + + + + +## `isArguments` +* `isArguments` + + + + + + + + + +## `isArguments` + + + +

isArguments(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/arguments.js#L18 "View in source") [Ⓣ][1] + +(Function): check if toString on object is Arguments + + +#### @see + +* fluents/chain able/blob/master/src/deps/is/to s.js +* Developer.mozilla.org/en us/docs/web/java script/reference/functions/arguments +* substack/node deep equal/blob/master/lib/is arguments.js +* lodash/lodash/blob/master/is arguments.js +* Underscorejs.org/docs/underscore.html + +#### @Since +4.0.0 + +#### Arguments +1. `x=undefined` *(*|Object)*: value to check if isArguments + +#### Returns +*(boolean)*: isArguments + +#### Example +```js +isArguments({})( + //=> false + function() { + isArguments(arguments) + //=> true + } +)() + +``` +--- + + + + + + + + [1]: #isarguments "Jump back to the TOC." diff --git a/docs/docdown/deps/is/array.md b/docs/docdown/deps/is/array.md index fd0efc8..32c73ac 100644 --- a/docs/docdown/deps/is/array.md +++ b/docs/docdown/deps/is/array.md @@ -4,8 +4,8 @@ -## `isArray` -* `isArray` +## `is` +* `is.isArray` @@ -15,18 +15,36 @@ -## `isArray` +## `is` -

# exports

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/array.js#L7 "View in source") [Ⓣ][1] +

is.isArray(arg=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/array.js#L8 "View in source") [Ⓣ][1] Function -#### Since + +#### @see + +* Developer.mozilla.org/en/docs/web/java script/reference/global objects/array/is array + +#### @todos + +- [ ] is-arraylike https://github.com/facebook/immutable-js/blob/master/src/utils/isArrayLike.js + + +#### @Since 3.0.0 +#### Arguments +1. `arg=undefined` *(*)*: + +#### Returns +*(boolean): isArray(arg)* + --- @@ -35,4 +53,4 @@ Function - [1]: #isarray "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/arrayOf.md b/docs/docdown/deps/is/arrayOf.md new file mode 100644 index 0000000..847cf1b --- /dev/null +++ b/docs/docdown/deps/is/arrayOf.md @@ -0,0 +1,56 @@ +# arrayOf.js API documentation + + + + + +## `is` +* `is.exports` + + + + + + + + + +## `is` + + + +

is.exports(predicate=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/arrayOf.js#L23 "View in source") [Ⓣ][1] + +(Function): every item in an array matches predicate + + +#### @Since +4.0.0 was in validatorBuilder + +#### Arguments +1. `predicate=undefined` *(Function)*: test to pass on every item in an array + +#### Returns +*(boolean)*: all match predicate + +#### Example +```js +isArrayOf(isTrue)([true, true]) //=> true +isArrayOf(isEmpty)(['']) //=> true + +isArrayOf(isBoolean)([true, false, 1, 2, 0]) //=> false +isArrayOf(isString)(['string', Number]) //=> false + +``` +--- + + + + + + + + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/async.md b/docs/docdown/deps/is/async.md index e612ab0..ed4e85f 100644 --- a/docs/docdown/deps/is/async.md +++ b/docs/docdown/deps/is/async.md @@ -4,8 +4,8 @@ -## `is.prototype` -* `is.prototype.isAsync` +## `is` +* `is.isAsync` @@ -15,16 +15,23 @@ -## `is.prototype` +## `is` -

# is.prototype.exports(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/async.js#L23 "View in source") [Ⓣ][1] +

is.exports(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/async.js#L24 "View in source") [Ⓣ][1] Function -#### Since + +#### @see + +* fluents/chain able/blob/master/src/deps/is/to s.js + +#### @Since 4.0.0-beta.2 #### Arguments @@ -52,4 +59,4 @@ isAsync(function() {}) - [1]: #is.prototype "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/asyncish.md b/docs/docdown/deps/is/asyncish.md index 114ebc8..2c3987d 100644 --- a/docs/docdown/deps/is/asyncish.md +++ b/docs/docdown/deps/is/asyncish.md @@ -4,8 +4,8 @@ -## `is.prototype` -* `is.prototype.isAsyncish` +## `is` +* `is.isAsyncish` @@ -15,23 +15,26 @@ -## `is.prototype` +## `is` -

# is.prototype.exports(x=undefined)

+

is.isAsyncish(x=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/asyncish.js#L29 "View in source") [Ⓣ][1] (Function): async function or promise -### @extends +#### @extends * undefined * undefined -#### Since + +#### @Since 4.0.0-beta.2 #### Arguments @@ -42,14 +45,11 @@ #### Example ```js -isAsyncish(async function() {}) -//=> true -isAsyncish(new Promise(r => r())) -//=> true +isAsyncish(async function() {}) //=> true +isAsyncish(new Promise(r => r())) //=> true -isAsyncish({}) -//=> false -isAsyncish(function() {}) +isAsyncish({}) //=> false +isAsyncish(function() {}) //=> false ``` --- @@ -60,4 +60,4 @@ isAsyncish(function() {}) - [1]: #is.prototype "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/boolean.md b/docs/docdown/deps/is/boolean.md index 388a134..625be51 100644 --- a/docs/docdown/deps/is/boolean.md +++ b/docs/docdown/deps/is/boolean.md @@ -4,8 +4,8 @@ -## `is.prototype` -* `is.prototype.isBoolean` +## `is` +* `is.isBoolean` @@ -15,32 +15,31 @@ -## `is.prototype` +## `is` -

# is.prototype.exports(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/boolean.js#L33 "View in source") [Ⓣ][1] +

is.exports(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/boolean.js#L32 "View in source") [Ⓣ][1] -(Function): Checks if `value` is classified as a boolean primitive or object. +(Function): Checks if `value` is classified as a boolean primitive OR object. -### @see +#### @see -* fluents/chain able/blob/master/src/deps/is/to s.js +* fluents/chain able/blob/master/src/deps/is/to s.js -### @notes - -* could also have typeof x === 'boolean' || (/true|false/).test(x) - - -### @extends +#### @extends * undefined * undefined +* undefined + -#### Since +#### @Since 3.0.0 #### Arguments @@ -69,4 +68,4 @@ isBoolean('') - [1]: #is.prototype "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/booleanPrimitive.md b/docs/docdown/deps/is/booleanPrimitive.md new file mode 100644 index 0000000..9688409 --- /dev/null +++ b/docs/docdown/deps/is/booleanPrimitive.md @@ -0,0 +1,76 @@ +# booleanPrimitive.js API documentation + + + + + +## `is` +* `is.isBooleanPrimitive` + + + + + + + + + +## `is` + + + +

is.exports(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/booleanPrimitive.js#L33 "View in source") [Ⓣ][1] + +(Function): Checks if `value` is classified as a boolean primitive NOT object. + + +#### @see + +* fluents/chain able/blob/master/src/deps/is/to s.js + +#### @notes + +* could also have typeof x === 'boolean' || (/true|false/).test(x) + + +#### @extends + +* undefined +* undefined + + + +#### @Since +5.0.0-beta.4 + +#### Arguments +1. `x=undefined` *(*)*: value + +#### Returns +*(boolean)*: isBooleanPrimitive + +#### Example +```js +isBooleanPrimitive(false) +//=> true +isBooleanPrimitive(new Boolean(1)) +//=> false + +isBooleanPrimitive(1) +//=> false +isBooleanPrimitive('') +//=> false + +``` +--- + + + + + + + + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/browser.md b/docs/docdown/deps/is/browser.md new file mode 100644 index 0000000..18af69c --- /dev/null +++ b/docs/docdown/deps/is/browser.md @@ -0,0 +1,54 @@ +# browser.js API documentation + + + + + +## `is` +* `is.isBrowser` + + + + + + + + + +## `is` + + + +

is.isBrowser()

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/browser.js#L15 "View in source") [Ⓣ][1] + +(Function): check typeof window + + +#### @extends + + + + +#### @Since +5.0.0-beta.1 + +#### Returns +*(boolean)*: is in browser, or has global window + +#### Example +```js +isBrowser() //=> true | false + +``` +--- + + + + + + + + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/buffer.md b/docs/docdown/deps/is/buffer.md new file mode 100644 index 0000000..cfe295f --- /dev/null +++ b/docs/docdown/deps/is/buffer.md @@ -0,0 +1,56 @@ +# buffer.js API documentation + + + + + +## `is` +* `is.exports` + + + + + + + + + +## `is` + + + +

is.exports(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/buffer.js#L23 "View in source") [Ⓣ][1] + +(Function): isBuffer, global Buffer + + +#### @Since +5.0.0-beta.1 + +#### Arguments +1. `x=undefined` *(*|Buffer)*: value to check if Buffer + +#### Returns +*(boolean)*: x is Buffer +
+
+If you need to support Safari `5-7` *(8-10 yr-old browser)*, + +#### Example +```js +isBuffer({}) //=> false +isBuffer(new Buffer('eh')) //=> true + +``` +--- + + + + + + + + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/circular.md b/docs/docdown/deps/is/circular.md new file mode 100644 index 0000000..e8caf02 --- /dev/null +++ b/docs/docdown/deps/is/circular.md @@ -0,0 +1,115 @@ +# circular.js API documentation + + + + + +## `errorKeywords` +* `errorKeywords` + + + + + +## `is` +* `is.exports` + + + + + + + + + +## `errorKeywords` + + + +

errorKeywords

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/circular.js#L7 "View in source") [Ⓣ][1] + +unknown + +--- + + + + + + + +## `is` + + + +

is.exports(obj=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/circular.js#L50 "View in source") [Ⓣ][1] + +(Function): check if a value is circular + + +#### @notes + +* is slow try catch json +* if (isFunction(obj)) { throw new Error('cannot determine if function is circular')} + + +#### @todos + +- [ ] find the circular property... + + +#### @symb + +🔘 + +#### @Since +5.0.0-beta.4 + +#### Arguments +1. `obj=undefined` *(*|Object)*: object to check if is circular + +#### Returns +*(boolean)*: isCircular / hasCircular + +#### Example +```js +const a = {} +a.b = a +isCircular(a) //=> true + +const a = {} +a.b = { + c: a, +} +isCircular(a) //=> true + +const a = {} +a.b = { + c: 4, +} +isCircular(a) //=> false + +const a = [] +a.push(a) +isCircular(a) //=> true + +isCircular({}) //=> false +isCircular('hi') //=> false +isCircular(undefined) //=> false + +``` +--- + + + + + + + + [1]: #errorkeywords "Jump back to the TOC." diff --git a/docs/docdown/deps/is/date.md b/docs/docdown/deps/is/date.md index e387449..29267a6 100644 --- a/docs/docdown/deps/is/date.md +++ b/docs/docdown/deps/is/date.md @@ -4,8 +4,8 @@ -## `is.prototype` -* `is.prototype.isDate` +## `is` +* `is.isDate` @@ -15,21 +15,24 @@ -## `is.prototype` +## `is` -

# is.prototype.exports(x=undefined)

+

is.exports(x=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/date.js#L36 "View in source") [Ⓣ][1] Function -### @extends +#### @extends -#### Since + +#### @Since 3.0.0 #### Arguments @@ -72,4 +75,4 @@ class Eh extends Date() - [1]: #is.prototype "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/dot.md b/docs/docdown/deps/is/dot.md index bd80a38..b5c5ed4 100644 --- a/docs/docdown/deps/is/dot.md +++ b/docs/docdown/deps/is/dot.md @@ -2,10 +2,62 @@ + + +## `is` +* `is.isDot` + + + + + +## `is` + + + +

is.isDot(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/dot.js#L24 "View in source") [Ⓣ][1] + +Function + + +#### @see + +* fluents/chain able/blob/master/src/deps/conditional/includes/all.js + +#### @todos + +- [ ] update with conditional + + +#### @Since +3.0.0 + +#### Arguments +1. `x=undefined` *(*)*: value to check + +#### Returns +*(boolean)*: x isDot + +#### Example +```js +isDot('eh.oh') //=> true +isDot('eh') //=> false +isDot(['eh', 'oh']) //=> true + +``` +--- + + + + + - [1]: # "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/empty.md b/docs/docdown/deps/is/empty.md new file mode 100644 index 0000000..7299aef --- /dev/null +++ b/docs/docdown/deps/is/empty.md @@ -0,0 +1,66 @@ +# empty.js API documentation + + + + + +## `is` +* `is.` + + + + + + + + + +## `is` + + + +

is.exports(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/empty.js#L33 "View in source") [Ⓣ][1] + +(Function): Returns `true` if the given value is its type's empty value; +`false` otherwise. + + +#### @see + +* fluents/chain able/blob/master/src/deps/dopemerge/empty target.js + +#### @sig + +a -> Boolean + +#### @Since +v0.1.0 + +#### Arguments +1. `x=undefined` *(*)*: value to check if empty + +#### Returns +*(boolean)*: + +#### Example +```js +isEmpty([1, 2, 3]) //=> false +isEmpty([]) //=> true +isEmpty('') //=> true +isEmpty(null) //=> false +isEmpty({}) //=> true +isEmpty({ length: 0 }) //=> false + +``` +--- + + + + + + + + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/enumerable.md b/docs/docdown/deps/is/enumerable.md index d146a52..ac3aa92 100644 --- a/docs/docdown/deps/is/enumerable.md +++ b/docs/docdown/deps/is/enumerable.md @@ -2,10 +2,74 @@ + + +## `is` +* `is.isEnumerable` + + + + + +## `is` + + + +

is.isEnumerable(obj=undefined, prop=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/enumerable.js#L32 "View in source") [Ⓣ][1] + +(Function): object at property is enumerable + + +#### @see + +* Developer.mozilla.org/en/docs/web/java script/reference/global objects/object/property is enumerable + +#### @todos + +- [ ] use fp/call + + +#### @Since +3.0.0 + +#### Arguments +1. `obj=undefined` *(*|Object)*: +2. `prop=undefined` *(*|string)*: + +#### Returns +*(boolean)*: obj[prop] is enumerable + +#### Example +```js +const obj = { eh: true } +isEnumerable(obj, 'eh') +//=> true + +const objPropEnumerable = isEnumerable(obj) +objPropEnumerable('eh') +//=> true + +Object.defineProperty(obj, 'length', { + enumerable: false, + value: () => Object.keys(obj).length, +}) +isEnumerable(obj, 'length') +//=> false + +``` +--- + + + + + - [1]: # "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/error.md b/docs/docdown/deps/is/error.md index 11a1fff..afb43e2 100644 --- a/docs/docdown/deps/is/error.md +++ b/docs/docdown/deps/is/error.md @@ -4,8 +4,8 @@ -## `is.prototype` -* `is.prototype.isError` +## `is` +* `is.isError` @@ -15,15 +15,21 @@ -## `is.prototype` +## `is` -

# is.prototype.exports(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/error.js#L35 "View in source") [Ⓣ][1] +

is.exports(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/error.js#L36 "View in source") [Ⓣ][1] Function + +#### @Since +4.0.0 + #### Arguments 1. `x=undefined` *(*)*: value @@ -64,4 +70,4 @@ class Eh extends Error() - [1]: #is.prototype "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/false.md b/docs/docdown/deps/is/false.md index f495f93..253d3b9 100644 --- a/docs/docdown/deps/is/false.md +++ b/docs/docdown/deps/is/false.md @@ -4,8 +4,8 @@ -## `is.prototype` -* `is.prototype.isFalse` +## `is` +* `is.isFalse` @@ -15,16 +15,19 @@ -## `is.prototype` +## `is` -

# is.prototype.exports(x=undefined)

+

is.exports(x=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/false.js#L21 "View in source") [Ⓣ][1] Function -#### Since + +#### @Since 4.0.0-alpha.1 #### Arguments @@ -53,4 +56,4 @@ isFalse('') - [1]: #is.prototype "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/function.md b/docs/docdown/deps/is/function.md index 2f4e1e8..06c4f5c 100644 --- a/docs/docdown/deps/is/function.md +++ b/docs/docdown/deps/is/function.md @@ -4,8 +4,8 @@ -## `is.prototype` -* `is.prototype.isFunction` +## `is` +* `is.isFunction` @@ -15,21 +15,28 @@ -## `is.prototype` +## `is` -

# is.prototype.exports(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/function.js#L37 "View in source") [Ⓣ][1] +

is.exports(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/function.js#L36 "View in source") [Ⓣ][1] (Function): Checks if `value` is classified as a `Function` object. -### @notes +#### @see + +* Underscorejs.org/docs/underscore.html + +#### @notes * || x instanceof Function -#### Since + +#### @Since 3.0.0 #### Arguments @@ -63,4 +70,4 @@ isFunction(/abc/) - [1]: #is.prototype "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/generator.md b/docs/docdown/deps/is/generator.md index 8f0fcff..a2ed919 100644 --- a/docs/docdown/deps/is/generator.md +++ b/docs/docdown/deps/is/generator.md @@ -5,7 +5,7 @@ ## `exports` -* `exports` +* `exports` @@ -19,12 +19,15 @@ -

# exports(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/generator.js#L16 "View in source") [Ⓣ][1] +

exports(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/generator.js#L18 "View in source") [Ⓣ][1] (Function): is generator function -#### Since + +#### @Since 4.0.0-beta.2 #### Arguments diff --git a/docs/docdown/deps/is/hasIn.md b/docs/docdown/deps/is/hasIn.md index 9771612..a1d2721 100644 --- a/docs/docdown/deps/is/hasIn.md +++ b/docs/docdown/deps/is/hasIn.md @@ -4,8 +4,8 @@ -## `exports` -* `exports` +## `is` +* `is.exports` @@ -15,22 +15,28 @@ -## `exports` +## `is` -

# exports(obj=undefined, prop=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/hasIn.js#L12 "View in source") [Ⓣ][1] +

is.exports(obj=undefined, prop=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/hasIn.js#L23 "View in source") [Ⓣ][1] -Function +(Function): isIn, but first checks it is not null -### @extends +#### @extends * undefined * undefined + +#### @Since +5.0.0 + #### Arguments 1. `obj=undefined` *(Object)*: object to check 2. `prop=undefined` *(any)*: property to check in object @@ -38,6 +44,13 @@ Function #### Returns *(boolean)*: +#### Example +```js +hasIn({}, 'eh') //=> false +hasIn(null, 'eh') //=> false +hasIn({ eh: true }, 'eh') //=> true + +``` --- @@ -46,4 +59,4 @@ Function - [1]: #exports "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/in.md b/docs/docdown/deps/is/in.md index 9dc6b4c..f2b1f63 100644 --- a/docs/docdown/deps/is/in.md +++ b/docs/docdown/deps/is/in.md @@ -4,8 +4,8 @@ -## `in` -* `` +## `is` +* `is.isIn` @@ -15,15 +15,34 @@ -## `in` +## `is` -

# 

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/in.js#L7 "View in source") [Ⓣ][1] +

is.isIn(obj=undefined, prop=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/in.js#L20 "View in source") [Ⓣ][1] -Function +(Function): prop is in Object(obj) + +#### @Since +5.0.0 + +#### Arguments +1. `obj=undefined` *(Object)*: object to check property of +2. `prop=undefined` *(Primitive)*: property in obj + +#### Returns +*(boolean)*: property + +#### Example +```js +isIn({ eh: true }, 'eh') //=> true +isIn({ eh: true }, 'oh') //=> false + +``` --- @@ -32,4 +51,4 @@ Function - [1]: #in "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/index.md b/docs/docdown/deps/is/index.md index b6088ec..3c63a66 100644 --- a/docs/docdown/deps/is/index.md +++ b/docs/docdown/deps/is/index.md @@ -4,8 +4,8 @@ -## `is.prototype.exports` -* `is.prototype.exports` +## `is.exports` +* `is.exports` @@ -15,19 +15,24 @@ -## `is.prototype.exports` +## `is.exports` 🌊 Types: is.d  +* 🔬 Tests: empty  * 🔬 Tests: index  * 🔬 Tests: is  +* 🔬 Tests: json  +* 🔬 Tests: not-exported-in-entry  * 🔬 Tests: primitives  * 🔬 Tests: simple  -

# is.prototype.exports

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/index.js#L37 "View in source") [Ⓣ][1] +

is.exports

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/index.js#L38 "View in source") [Ⓣ][1] Object @@ -39,4 +44,4 @@ Object - [1]: #is.prototype.exports "Jump back to the TOC." + [1]: #is.exports "Jump back to the TOC." diff --git a/docs/docdown/deps/is/instanceOf.md b/docs/docdown/deps/is/instanceOf.md new file mode 100644 index 0000000..25f7b3a --- /dev/null +++ b/docs/docdown/deps/is/instanceOf.md @@ -0,0 +1,62 @@ +# instanceOf.js API documentation + + + + + +## `instanceOf` +* `instanceOf` + + + + + + + + + +## `instanceOf` + + + +

instanceOf(instanceToCheckAgainst=undefined, isThisInstanceOfThat=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/instanceOf.js#L26 "View in source") [Ⓣ][1] + +Function + + +#### @Since +5.0.0-beta.4 + +#### Arguments +1. `instanceToCheckAgainst=undefined` *(Object)*: check the second arg against this +2. `isThisInstanceOfThat=undefined` *(Object)*: check this against first arg + +#### Returns +*(boolean)*: arg2 instanceof arg1 + +#### Example +```js +const isObjInstance = instanceOf(Object) +isObjInstance({}) +//=> true + +const isArrInstance = instanceOf(Array) +isArrInstance({}) +//=> false + +isArrInstance(new Array()) +//=> true + +``` +--- + + + + + + + + [1]: #instanceof "Jump back to the TOC." diff --git a/docs/docdown/deps/is/iteratable.md b/docs/docdown/deps/is/iteratable.md new file mode 100644 index 0000000..e0da288 --- /dev/null +++ b/docs/docdown/deps/is/iteratable.md @@ -0,0 +1,66 @@ +# iteratable.js API documentation + + + + + +## `exports` +* `exports` + + + + + + + + + +## `exports` + + + +

exports(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/iteratable.js#L35 "View in source") [Ⓣ][1] + +(Function): is able to be iterated on + + +#### @extends + +* undefined +* undefined +* undefined +* undefined +* undefined +* undefined +* undefined +* undefined + + +#### Arguments +1. `x=undefined` *(*)*: node is iteratable + +#### Returns +*(boolean)*: x isIteratable + +#### Example +```js +isIteratable([]) //=> true +isIteratable({}) //=> true +isIteratable(new Date()) //=> false +isIteratable(Symbol('eh')) //=> false +isIteratable(new Promise(r => r())) //=> false +isIteratable(new Error('eh')) //=> false + +``` +--- + + + + + + + + [1]: #exports "Jump back to the TOC." diff --git a/docs/docdown/deps/is/iterator.md b/docs/docdown/deps/is/iterator.md index c6758be..6a00d30 100644 --- a/docs/docdown/deps/is/iterator.md +++ b/docs/docdown/deps/is/iterator.md @@ -4,8 +4,8 @@ -## `is.prototype` -* `is.prototype.isIterator` +## `is` +* `is.isIterator` @@ -15,16 +15,19 @@ -## `is.prototype` +## `is` -

# is.prototype.(x=undefined)

+

is.(x=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/iterator.js#L42 "View in source") [Ⓣ][1] Function -#### Since + +#### @Since 3.0.0 #### Arguments @@ -72,4 +75,4 @@ class Eh extends Set() - [1]: #is.prototype "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/map.md b/docs/docdown/deps/is/map.md index 5f3cd1b..14e8010 100644 --- a/docs/docdown/deps/is/map.md +++ b/docs/docdown/deps/is/map.md @@ -4,8 +4,8 @@ -## `is.prototype` -* `is.prototype.isMap` +## `is` +* `is.isMap` @@ -15,16 +15,19 @@ -## `is.prototype` +## `is` -

# is.prototype.exports(x=undefined)

+

is.exports(x=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/map.js#L43 "View in source") [Ⓣ][1] (Function): Checks if `value` is classified as a `Map` object. -#### Since + +#### @Since 3.0.0 #### Arguments @@ -72,4 +75,4 @@ class Eh extends Map() - [1]: #is.prototype "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/mapish.md b/docs/docdown/deps/is/mapish.md index f7551d1..18582ff 100644 --- a/docs/docdown/deps/is/mapish.md +++ b/docs/docdown/deps/is/mapish.md @@ -4,8 +4,8 @@ -## `is.prototype` -* `is.prototype.isMapish` +## `is` +* `is.isMapish` @@ -15,21 +15,24 @@ -## `is.prototype` +## `is` -

# is.prototype.exports(x=undefined)

+

is.exports(x=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/mapish.js#L30 "View in source") [Ⓣ][1] Function -### @extends +#### @extends -#### Since + +#### @Since 3.0.0 #### Arguments @@ -61,4 +64,4 @@ isMapish(1) - [1]: #is.prototype "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/match.md b/docs/docdown/deps/is/match.md new file mode 100644 index 0000000..858d0c2 --- /dev/null +++ b/docs/docdown/deps/is/match.md @@ -0,0 +1,11 @@ +# match.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/is/matcher.md b/docs/docdown/deps/is/matcher.md index 14093e8..f1424f3 100644 --- a/docs/docdown/deps/is/matcher.md +++ b/docs/docdown/deps/is/matcher.md @@ -4,8 +4,8 @@ -## `is.prototype` -* `is.prototype.isMatcher` +## `is` +* `is.isMatcher` @@ -15,16 +15,24 @@ -## `is.prototype` +## `is` -

# is.prototype.exports(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/matcher.js#L25 "View in source") [Ⓣ][1] +

is.exports(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/matcher.js#L31 "View in source") [Ⓣ][1] Function -#### Since + +#### @see + +* fluents/chain able/blob/master/src/deps/is/regexp.js +* fluents/chain able/blob/master/src/deps/is/function.js + +#### @Since 3.0.0 #### Arguments @@ -55,4 +63,4 @@ isMatcher('.*') - [1]: #is.prototype "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/native.md b/docs/docdown/deps/is/native.md index 1eb42eb..e0bb528 100644 --- a/docs/docdown/deps/is/native.md +++ b/docs/docdown/deps/is/native.md @@ -4,8 +4,8 @@ -## `is.prototype` -* `is.prototype.isNative` +## `is` +* `is.isNative` @@ -15,16 +15,26 @@ -## `is.prototype` +## `is` -

# is.prototype.exports(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/native.js#L19 "View in source") [Ⓣ][1] +

is.exports(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/native.js#L14 "View in source") [Ⓣ][1] (Function): based on isNative from react-fibers, based on isNative() from Lodash -#### Since + +#### @see + +* Developer.mozilla.org/en us/docs/web/java script/reference/global objects/function/to string +* fluents/chain able/blob/masterhttp:/tc39.github.io/function prototype to string revision +* lodash/lodash/issues/2185 +* Esdiscuss.org/topic/spec feedback on rev 6 + +#### @Since 4.0.6 #### Arguments @@ -50,4 +60,4 @@ isNative(function normalFunction() {}) - [1]: #is.prototype "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/notEmptyArray.md b/docs/docdown/deps/is/notEmptyArray.md index ac61556..aded1ed 100644 --- a/docs/docdown/deps/is/notEmptyArray.md +++ b/docs/docdown/deps/is/notEmptyArray.md @@ -4,8 +4,8 @@ -## `is.prototype` -* `is.prototype.isNotEmptyArray` +## `is` +* `is.isNotEmptyArray` @@ -15,26 +15,29 @@ -## `is.prototype` +## `is` -

# is.prototype.exports(x=undefined)

+

is.exports(x=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/notEmptyArray.js#L30 "View in source") [Ⓣ][1] (Function): value is an Array, with at least `1` value -### @see +#### @see -* fluents/chain able/blob/master/src/deps/is/obj with keys.js -* fluents/chain able/blob/master/src/deps/is/array.js +* fluents/chain able/blob/master/src/deps/is/obj with keys.js +* fluents/chain able/blob/master/src/deps/is/array.js -### @extends +#### @extends -#### Since + +#### @Since 4.0.0-alpha.1 #### Arguments @@ -66,4 +69,4 @@ isNotEmptyArray(new Map()) - [1]: #is.prototype "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/notNested.md b/docs/docdown/deps/is/notNested.md new file mode 100644 index 0000000..36d25fa --- /dev/null +++ b/docs/docdown/deps/is/notNested.md @@ -0,0 +1,56 @@ +# notNested.js API documentation + + + + + +## `exports` +* `exports` + + + + + + + + + +## `exports` + + + +

exports(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/notNested.js#L21 "View in source") [Ⓣ][1] + +Function + + +#### @Since +5.0.0 + +#### Arguments +1. `x=undefined` *(*)*: value to check + +#### Returns +*(boolean)*: x isNotNested + +#### Example +```js +isNotNested('') //=> true +isNotNested(true) //=> true +isNotNested(new RegExp()) //=> true +isNotNested(new Error('eh')) //=> false +isNotNested(null) //=> false + +``` +--- + + + + + + + + [1]: #exports "Jump back to the TOC." diff --git a/docs/docdown/deps/is/notRealOrIsEmpty.md b/docs/docdown/deps/is/notRealOrIsEmpty.md new file mode 100644 index 0000000..3ed6236 --- /dev/null +++ b/docs/docdown/deps/is/notRealOrIsEmpty.md @@ -0,0 +1,42 @@ +# notRealOrIsEmpty.js API documentation + + + + + +## `isNotRealOrIsEmpty` +* `isNotRealOrIsEmpty` + + + + + + + + + +## `isNotRealOrIsEmpty` + + + +

isNotRealOrIsEmpty

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/notRealOrIsEmpty.js#L17 "View in source") [Ⓣ][1] + +Function + + +#### @see + +* fluents/chain able/blob/master/src/deps/conditional/and.js +* fluents/chain able/blob/master/src/deps/conditional/not.js +--- + + + + + + + + [1]: #isnotrealorisempty "Jump back to the TOC." diff --git a/docs/docdown/deps/is/null.md b/docs/docdown/deps/is/null.md index 7d6228e..66eb977 100644 --- a/docs/docdown/deps/is/null.md +++ b/docs/docdown/deps/is/null.md @@ -4,8 +4,8 @@ -## `is.prototype` -* `is.prototype.isNull` +## `is` +* `is.isNull` @@ -15,16 +15,19 @@ -## `is.prototype` +## `is` -

# is.prototype.exports(x=undefined)

+

is.exports(x=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/null.js#L26 "View in source") [Ⓣ][1] Function -#### Since + +#### @Since 3.0.0 #### Arguments @@ -58,4 +61,4 @@ isNull(1) - [1]: #is.prototype "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/nullOrUndefined.md b/docs/docdown/deps/is/nullOrUndefined.md index d0c16b3..aeba37d 100644 --- a/docs/docdown/deps/is/nullOrUndefined.md +++ b/docs/docdown/deps/is/nullOrUndefined.md @@ -4,8 +4,8 @@ -## `is.prototype` -* `is.prototype.isNullOrUndefined` +## `is` +* `is.isNullOrUndefined` @@ -15,21 +15,24 @@ -## `is.prototype` +## `is` -

# is.prototype.exports(x=undefined)

+

is.exports(x=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/nullOrUndefined.js#L41 "View in source") [Ⓣ][1] (Function): Checks if `value` is `null` or `undefined`. -### @see +#### @see -* fluents/chain able/blob/master/src/deps/is/null.js -* fluents/chain able/blob/master/src/deps/is/undefined.js -#### Since +* fluents/chain able/blob/master/src/deps/is/null.js +* fluents/chain able/blob/master/src/deps/is/undefined.js + +#### @Since 4.0.0-alpha.1 #### Arguments @@ -67,4 +70,4 @@ isNullOrUndefined(false) - [1]: #is.prototype "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/number.md b/docs/docdown/deps/is/number.md index ec51cfd..29be137 100644 --- a/docs/docdown/deps/is/number.md +++ b/docs/docdown/deps/is/number.md @@ -4,8 +4,8 @@ -## `is.prototype` -* `is.prototype.isNumber` +## `is` +* `is.isNumber` @@ -15,21 +15,23 @@ -## `is.prototype` +## `is` -

# is.prototype.exports(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/number.js#L42 "View in source") [Ⓣ][1] +

is.exports(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/number.js#L51 "View in source") [Ⓣ][1] Function -### @see +#### @see -* fluents/chain able/blob/master/src/deps/is/real.js +* fluents/chain able/blob/master/src/deps/is/real.js -### @notes +#### @notes * was not needed except for abstract == const isObj = require('./obj') @@ -39,7 +41,13 @@ Function : (/^0x[0-9a-f]+$/i).test(x) || (/^[-+]?(?:\d+(?:\.\d*)?|\.\d+)(e[-+]?\d+)?$/).test(x)) -#### Since + +#### @extends + + + + +#### @Since 3.0.0 #### Arguments @@ -52,6 +60,8 @@ Function ```js isNumber(1) //=> true +isNumber(new Number(1)) +//=> true isNumber(Number(1)) //=> true isNumber(NaN) @@ -79,4 +89,4 @@ isNumber(false) - [1]: #is.prototype "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/numberPrimitive.md b/docs/docdown/deps/is/numberPrimitive.md new file mode 100644 index 0000000..6d7b4ef --- /dev/null +++ b/docs/docdown/deps/is/numberPrimitive.md @@ -0,0 +1,76 @@ +# numberPrimitive.js API documentation + + + + + +## `is` +* `is.isNumberPrimitive` + + + + + + + + + +## `is` + + + +

is.exports(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/numberPrimitive.js#L35 "View in source") [Ⓣ][1] + +Function + + +#### @see + +* fluents/chain able/blob/master/src/deps/is/real.js + +#### @Since +3.0.0 + +#### Arguments +1. `x=undefined` *(*)*: value + +#### Returns +*(boolean)*: isNumberPrimitive + +#### Example +```js +isNumberPrimitive(1) +//=> true +isNumberPrimitive(Number(1)) +//=> true +isNumberPrimitive(NaN) +//=> true +isNumberPrimitive(new Number(1)) +//=> false + +isNumberPrimitive(null) +//=> false +isNumberPrimitive(undefined) +//=> false +isNumberPrimitive(void 0) +//=> false +isNumberPrimitive({}) +//=> false +isNumberPrimitive('') +//=> false +isNumberPrimitive(false) +//=> false + +``` +--- + + + + + + + + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/obj.md b/docs/docdown/deps/is/obj.md index 3a9e6b4..d3ec787 100644 --- a/docs/docdown/deps/is/obj.md +++ b/docs/docdown/deps/is/obj.md @@ -4,8 +4,8 @@ -## `is.prototype` -* `is.prototype.isObj` +## `is` +* `is.isObj` @@ -15,21 +15,24 @@ -## `is.prototype` +## `is` -

# is.prototype.exports(value=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/obj.js#L34 "View in source") [Ⓣ][1] +

is.exports(value=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/obj.js#L38 "View in source") [Ⓣ][1] Function -### @notes +#### @notes * Object.prototype.toString.call(val) === '[object Object]' -#### Since + +#### @Since 3.0.0 #### Arguments @@ -61,4 +64,4 @@ isObject(null) - [1]: #is.prototype "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/objLoose.md b/docs/docdown/deps/is/objLoose.md deleted file mode 100644 index 3832328..0000000 --- a/docs/docdown/deps/is/objLoose.md +++ /dev/null @@ -1,72 +0,0 @@ -# objLoose.js API documentation - - - - - -## `is.prototype` -* `is.prototype.isObjLoose` - - - - - - - - - -## `is.prototype` - - - -

# is.prototype.exports(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/objLoose.js#L34 "View in source") [Ⓣ][1] - -Function - - -### @see - -* fluents/chain able/blob/master/src/deps/is/obj.js -* fluents/chain able/blob/master/src/deps/is/obj with keys.js -* fluents/chain able/blob/master/src/deps/is/obj strict.js -* fluents/chain able/blob/master/src/deps/is/null.js -#### Since -3.0.0 - -#### Arguments -1. `x=undefined` *(*)*: value - -#### Returns -*(boolean)*: isObjLoose - -#### Example -```js -isObjLoose(new Object()) -//=> true -isObjLoose({}) -//=> true -isObjLoose(Object.create(null)) -//=> true -isObjLoose(null) -//=> true - -isObjLoose(new Set()) -//=> false -isObjLoose(function() {}) -//=> false -isObjLoose('') -//=> false -isObjLoose(1) -//=> false - -``` ---- - - - - - - - - [1]: #is.prototype "Jump back to the TOC." diff --git a/docs/docdown/deps/is/objNotNull.md b/docs/docdown/deps/is/objNotNull.md new file mode 100644 index 0000000..1671571 --- /dev/null +++ b/docs/docdown/deps/is/objNotNull.md @@ -0,0 +1,87 @@ +# objNotNull.js API documentation + + + + + +## `is` +* `is.isObjNotNull` + + + + + + + + + +## `is` + + + +

is.exports(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/objNotNull.js#L34 "View in source") [Ⓣ][1] + +Function + + +#### @see + +* fluents/chain able/blob/master/src/deps/is/obj.js +* fluents/chain able/blob/master/src/deps/is/obj with keys.js +* fluents/chain able/blob/master/src/deps/is/obj typeof.js +* fluents/chain able/blob/master/src/deps/is/null.js +* sindresorhus/is obj/blob/master/index.js +* lodash/lodash/blob/master/is object like.js + +#### @todos + +- [ ] !Array.isArray + + +#### @extends + + + + +#### @Since +3.0.0 + +#### Arguments +1. `x=undefined` *(*)*: value + +#### Returns +*(boolean)*: isObjNotNull + +#### Example +```js +isObjNotNull(new Object()) +//=> true +isObjNotNull({}) +//=> true +isObjNotNull(Object.create(null)) +//=> true +isObjNotNull(null) +//=> false + +isObjNotNull(new Set()) +//=> false +isObjNotNull(function() {}) +//=> false +isObjNotNull('') +//=> false +isObjNotNull(1) +//=> false + +``` +--- + + + + + + + + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/objPure.md b/docs/docdown/deps/is/objPure.md index e985fe6..b3d872f 100644 --- a/docs/docdown/deps/is/objPure.md +++ b/docs/docdown/deps/is/objPure.md @@ -2,10 +2,68 @@ + + +## `is` +* `is.isObjPure` + + + + + +## `is` + + + +

is.isObjPure(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/objPure.js#L34 "View in source") [Ⓣ][1] + +Function + + +#### @extends + +* undefined +* undefined +* undefined +* undefined + + + +#### @Since +3.0.0 + +#### Arguments +1. `x=undefined` *(*)*: value to check + +#### Returns +*(boolean)*: is obj & !null & !undefined & !array & !function + +#### Example +```js +isObjPure(function() {}) +//=> false +isObjPure(null) +//=> false +isObjPure([]) +//=> false + +isObjPure({}) +//=> true + +``` +--- + + + + + - [1]: # "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/objStrict.md b/docs/docdown/deps/is/objStrict.md deleted file mode 100644 index 391f298..0000000 --- a/docs/docdown/deps/is/objStrict.md +++ /dev/null @@ -1,82 +0,0 @@ -# objStrict.js API documentation - - - - - -## `is.prototype` -* `is.prototype.isObjStrict` - - - - - - - - - -## `is.prototype` - - - -

# is.prototype.exports(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/objStrict.js#L42 "View in source") [Ⓣ][1] - -Function - - -### @see - -* fluents/chain able/blob/master/src/deps/is/obj.js -* fluents/chain able/blob/master/src/deps/is/obj with keys.js -* fluents/chain able/blob/master/src/deps/is/obj loose.js -* fluents/chain able/blob/master/src/deps/is/null.js - -### @todos - -- [ ] !Array.isArray - - -### @extends - - - -#### Since -3.0.0 - -#### Arguments -1. `x=undefined` *(*)*: value - -#### Returns -*(boolean)*: isObjStrict - -#### Example -```js -isObjStrict(new Object()) -//=> true -isObjStrict({}) -//=> true -isObjStrict(Object.create(null)) -//=> true -isObjStrict(null) -//=> false - -isObjStrict(new Set()) -//=> false -isObjStrict(function() {}) -//=> false -isObjStrict('') -//=> false -isObjStrict(1) -//=> false - -``` ---- - - - - - - - - [1]: #is.prototype "Jump back to the TOC." diff --git a/docs/docdown/deps/is/objTypeof.md b/docs/docdown/deps/is/objTypeof.md new file mode 100644 index 0000000..6943897 --- /dev/null +++ b/docs/docdown/deps/is/objTypeof.md @@ -0,0 +1,74 @@ +# objTypeof.js API documentation + + + + + +## `is` +* `is.isObjLoose` + + + + + + + + + +## `is` + + + +

is.exports(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/objTypeof.js#L34 "View in source") [Ⓣ][1] + +Function + + +#### @see + +* fluents/chain able/blob/master/src/deps/is/obj.js +* fluents/chain able/blob/master/src/deps/is/obj with keys.js +* fluents/chain able/blob/master/src/deps/is/null.js + +#### @Since +3.0.0 + +#### Arguments +1. `x=undefined` *(*)*: value + +#### Returns +*(boolean)*: isObjLoose + +#### Example +```js +isObjLoose(new Object()) +//=> true +isObjLoose({}) +//=> true +isObjLoose(Object.create(null)) +//=> true +isObjLoose(null) +//=> true + +isObjLoose(new Set()) +//=> false +isObjLoose(function() {}) +//=> false +isObjLoose('') +//=> false +isObjLoose(1) +//=> false + +``` +--- + + + + + + + + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/objWithKeys.md b/docs/docdown/deps/is/objWithKeys.md index 61bd528..53d5a91 100644 --- a/docs/docdown/deps/is/objWithKeys.md +++ b/docs/docdown/deps/is/objWithKeys.md @@ -4,8 +4,8 @@ -## `is.prototype` -* `is.prototype.isObjWithKeys` +## `is` +* `is.isObjWithKeys` @@ -15,28 +15,35 @@ -## `is.prototype` +## `is` -

# is.prototype.exports(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/objWithKeys.js#L41 "View in source") [Ⓣ][1] +

is.exports(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/objWithKeys.js#L43 "View in source") [Ⓣ][1] Function -### @see +#### @see -* fluents/chain able/blob/master/src/deps/is/obj.js -* fluents/chain able/blob/master/src/deps/is/obj with keys.js -* fluents/chain able/blob/master/src/deps/is/obj strict.js -* fluents/chain able/blob/master/src/deps/is/null.js +* fluents/chain able/blob/master/src/deps/is/obj.js +* fluents/chain able/blob/master/src/deps/is/obj with keys.js +* fluents/chain able/blob/master/src/deps/is/null.js -### @extends +#### @todos +- [ ] @NOTE need to be more careful, needs to check for vanilla objects, not native ones since e.g. Error has no keys + +#### @extends -#### Since + + + +#### @Since 3.0.0 #### Arguments @@ -75,4 +82,4 @@ isObjWithKeys(1) - [1]: #is.prototype "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/primitive.md b/docs/docdown/deps/is/primitive.md new file mode 100644 index 0000000..ec88afa --- /dev/null +++ b/docs/docdown/deps/is/primitive.md @@ -0,0 +1,63 @@ +# primitive.js API documentation + + + + + +## `is` +* `is.exports` + + + + + + + + + +## `is` + + + +

is.exports(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/primitive.js#L36 "View in source") [Ⓣ][1] + +(Function): Checks if `value` is classified as a **primitive** +`(number|string|boolean|null|undefined)` + + +#### @Since +4.0.0 was in another file + +#### Arguments +1. `x=undefined` *(*)*: The value to check. + +#### Returns +*(boolean)*: x is number|string|boolean|null|undefined + +#### Example +```js +isPrimitive('abc') // => true +isPrimitive(1) // => true +isPrimitive('') // => true +isPrimitive(null) // => true +isPrimitive(undefined) // => true +isPrimitive(void 0) // => true + +isPrimitive(new String('abc')) // => false +isPrimitive([]) // => false +isPrimitive(() => {}) // => false +isPrimitive({}) // => false + +``` +--- + + + + + + + + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/promise.md b/docs/docdown/deps/is/promise.md index 00b2e44..748587c 100644 --- a/docs/docdown/deps/is/promise.md +++ b/docs/docdown/deps/is/promise.md @@ -4,8 +4,8 @@ -## `is.prototype` -* `is.prototype.isPromise` +## `is` +* `is.isPromise` @@ -15,16 +15,19 @@ -## `is.prototype` +## `is` -

# is.prototype.exports(x=undefined)

+

is.exports(x=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/promise.js#L38 "View in source") [Ⓣ][1] (Function): is a Promise -#### Since + +#### @Since 4.0.0-beta.2 #### Arguments @@ -64,4 +67,4 @@ isPromise(1) - [1]: #is.prototype "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/prototypeOf.md b/docs/docdown/deps/is/prototypeOf.md index 9b8b715..69f48d4 100644 --- a/docs/docdown/deps/is/prototypeOf.md +++ b/docs/docdown/deps/is/prototypeOf.md @@ -2,10 +2,68 @@ + + +## `is` +* `is.isPrototypeOf` + + + + + +## `is` + + + +

is.isPrototypeOf(haystack=undefined, needle=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/prototypeOf.js#L24 "View in source") [Ⓣ][1] + +(Function): check if arg `1` is prototype of arg `2` + + +#### @see + +* Developer.mozilla.org/en us/docs/web/java script/reference/global objects/object/is prototype of + +#### @todos + +- [ ] curry2 + + +#### @Since +3.0.0 + +#### Arguments +1. `haystack=undefined` *(*|Object)*: check needle against +2. `needle=undefined` *(*|Object)*: is prototype of haystack + +#### Returns +*(boolean)*: needle isPrototypeOf haystack + +#### Example +```js +class Eh extends Function {} +class Canada extends Eh {} +isPrototypeOf(Eh, Function) //=> true +isPrototypeOf(Canada, Function) //=> true +isPrototypeOf(Eh, Date) //=> false + +isPrototypeOf({}, Object) //=> true +isPrototypeOf({}, Array) //=> false + +``` +--- + + + + + - [1]: # "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/real.md b/docs/docdown/deps/is/real.md index aa9c5c6..d7cad03 100644 --- a/docs/docdown/deps/is/real.md +++ b/docs/docdown/deps/is/real.md @@ -4,8 +4,8 @@ -## `is.prototype` -* `is.prototype.isReal` +## `is` +* `is.isReal` @@ -15,32 +15,35 @@ -## `is.prototype` +## `is` -

# is.prototype.exports(x=undefined)

+

is.exports(x=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/real.js#L51 "View in source") [Ⓣ][1] Function -### @see +#### @see -* fluents/chain able/blob/master/src/deps/is/null.js -* fluents/chain able/blob/master/src/deps/is/undefined.js +* fluents/chain able/blob/master/src/deps/is/null.js +* fluents/chain able/blob/master/src/deps/is/undefined.js -### @notes +#### @notes * eslint-disable-next-line no-self-compare && x !== x -### @extends +#### @extends -#### Since + +#### @Since 3.0.0 #### Arguments @@ -85,4 +88,4 @@ isReal(1) - [1]: #is.prototype "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/regexp.md b/docs/docdown/deps/is/regexp.md index 1b09546..2b54e08 100644 --- a/docs/docdown/deps/is/regexp.md +++ b/docs/docdown/deps/is/regexp.md @@ -5,7 +5,7 @@ ## `exports` -* `exports` +* `exports` @@ -19,16 +19,19 @@ -

# exports(value=undefined)

+

exports(x=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/regexp.js#L21 "View in source") [Ⓣ][1] (Function): Checks if `value` is classified as a `RegExp` object. -#### Since + +#### @Since 0.1.0 #### Arguments -1. `value=undefined` *(*)*: The value to check. +1. `x=undefined` *(*)*: The value to check. #### Returns *(boolean)*: Returns `true` if `value` is a regexp, else `false`. diff --git a/docs/docdown/deps/is/set.md b/docs/docdown/deps/is/set.md index f728c58..342b130 100644 --- a/docs/docdown/deps/is/set.md +++ b/docs/docdown/deps/is/set.md @@ -5,7 +5,7 @@ ## `exports` -* `exports` +* `exports` @@ -19,12 +19,15 @@ -

# exports(x=undefined)

+

exports(x=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/set.js#L20 "View in source") [Ⓣ][1] (Function): Checks if `value` is classified as a `Set` object. -#### Since + +#### @Since 4.3.0 #### Arguments diff --git a/docs/docdown/deps/is/string.md b/docs/docdown/deps/is/string.md index e9e6ea8..63b8253 100644 --- a/docs/docdown/deps/is/string.md +++ b/docs/docdown/deps/is/string.md @@ -4,8 +4,8 @@ -## `is.prototype` -* `is.prototype.exports` +## `is` +* `is.exports` @@ -15,21 +15,24 @@ -## `is.prototype` +## `is` -

# is.prototype.exports(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/string.js#L31 "View in source") [Ⓣ][1] +

is.exports(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/string.js#L32 "View in source") [Ⓣ][1] (Function): Checks if `value` is classified as a `String` primitive or object. -### @extends +#### @extends -#### Since + +#### @Since 3.0.0 #### Arguments @@ -58,4 +61,4 @@ isString(1) - [1]: #is.prototype "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/stringOrNumber.md b/docs/docdown/deps/is/stringOrNumber.md index bd79c8f..5aafc5f 100644 --- a/docs/docdown/deps/is/stringOrNumber.md +++ b/docs/docdown/deps/is/stringOrNumber.md @@ -4,8 +4,8 @@ -## `is.prototype` -* `is.prototype.exports` +## `is` +* `is.exports` @@ -15,16 +15,19 @@ -## `is.prototype` +## `is` -

# is.prototype.exports(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/stringOrNumber.js#L24 "View in source") [Ⓣ][1] +

is.exports(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/stringOrNumber.js#L25 "View in source") [Ⓣ][1] (Function): Checks if `value` is classified as a `String` primitive or object. -#### Since + +#### @Since 3.0.0 #### Arguments @@ -50,4 +53,4 @@ isString(1) - [1]: #is.prototype "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/stringPrimitive.md b/docs/docdown/deps/is/stringPrimitive.md index 6c08a0f..14ec87d 100644 --- a/docs/docdown/deps/is/stringPrimitive.md +++ b/docs/docdown/deps/is/stringPrimitive.md @@ -4,8 +4,8 @@ -## `is.prototype` -* `is.prototype.exports` +## `is` +* `is.exports` @@ -15,20 +15,23 @@ -## `is.prototype` +## `is` -

# is.prototype.exports(x=undefined)

+

is.exports(x=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/stringPrimitive.js#L27 "View in source") [Ⓣ][1] (Function): Checks if `value` is classified as a `String` **primitive**. -### @see +#### @see -* fluents/chain able/blob/master/src/deps/is/string.js -#### Since +* fluents/chain able/blob/master/src/deps/is/string.js + +#### @Since 3.0.0 #### Arguments @@ -57,4 +60,4 @@ isString(1) - [1]: #is.prototype "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/symbol.md b/docs/docdown/deps/is/symbol.md index dbe801c..ae6faad 100644 --- a/docs/docdown/deps/is/symbol.md +++ b/docs/docdown/deps/is/symbol.md @@ -4,8 +4,8 @@ -## `is.prototype` -* `is.prototype.exports` +## `is` +* `is.exports` @@ -15,16 +15,19 @@ -## `is.prototype` +## `is` -

# is.prototype.exports(value=undefined)

+

is.exports(value=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/symbol.js#L22 "View in source") [Ⓣ][1] (Function): Checks if `value` is classified as a `Symbol` primitive or object. -#### Since + +#### @Since 4.0.0 #### Arguments @@ -50,4 +53,4 @@ isSymbol('abc') - [1]: #is.prototype "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/toS.md b/docs/docdown/deps/is/toS.md index bc51b80..17f978e 100644 --- a/docs/docdown/deps/is/toS.md +++ b/docs/docdown/deps/is/toS.md @@ -4,8 +4,8 @@ -## `is.prototype` -* `is.prototype.exports` +## `is` +* `is.exports` @@ -15,21 +15,25 @@ -## `is.prototype` +## `is` -

# is.prototype.exports(obj=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/toS.js#L25 "View in source") [Ⓣ][1] +

is.exports(obj=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/toS.js#L34 "View in source") [Ⓣ][1] (Function): The base implementation of `getTag` without fallbacks for buggy environments. -### @todos +#### @todos - [ ] obj[Symbol.toStringTag] +- [ ] run deopt check on this invoking see how many invocations... are needed to inline -#### Since + +#### @Since 3.0.0 #### Arguments @@ -41,10 +45,13 @@ #### Example ```js toS({}) -//=> '[Object object]' +//=> '[object Object]' toS(function() {}) -//=> '[Object function]' +//=> '[Object Function]' + +getTag([]) +//=> '[object Array]' ``` --- @@ -55,4 +62,4 @@ toS(function() {}) - [1]: #is.prototype "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/true.md b/docs/docdown/deps/is/true.md index 80c05fc..c49ab82 100644 --- a/docs/docdown/deps/is/true.md +++ b/docs/docdown/deps/is/true.md @@ -4,8 +4,8 @@ -## `is.prototype` -* `is.prototype.isTrue` +## `is` +* `is.isTrue` @@ -15,16 +15,19 @@ -## `is.prototype` +## `is` -

# is.prototype.exports(x=undefined)

+

is.exports(x=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/true.js#L21 "View in source") [Ⓣ][1] Function -#### Since + +#### @Since 4.0.0-alpha.1 #### Arguments @@ -53,4 +56,4 @@ isTrue('') - [1]: #is.prototype "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/undefined.md b/docs/docdown/deps/is/undefined.md index c36fad1..e09bee8 100644 --- a/docs/docdown/deps/is/undefined.md +++ b/docs/docdown/deps/is/undefined.md @@ -4,8 +4,8 @@ -## `is.prototype` -* `is.prototype.isUndefined` +## `is` +* `is.isUndefined` @@ -15,25 +15,23 @@ -## `is.prototype` +## `is` -

# is.prototype.exports(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/undefined.js#L38 "View in source") [Ⓣ][1] +

is.exports(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/undefined.js#L36 "View in source") [Ⓣ][1] (Function): Checks if `value` is `undefined`. -### @see +#### @see -* fluents/chain able/blob/master/src/deps/is/null or undefined.js +* fluents/chain able/blob/master/src/deps/is/null or undefined.js -### @notes - -* || typeof x === 'undefined' - -#### Since +#### @Since 4.0.0-alpha.1 #### Arguments @@ -71,4 +69,4 @@ isUndefined(false) - [1]: #is.prototype "Jump back to the TOC." + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/undefinedLike.md b/docs/docdown/deps/is/undefinedLike.md new file mode 100644 index 0000000..352e1b3 --- /dev/null +++ b/docs/docdown/deps/is/undefinedLike.md @@ -0,0 +1,65 @@ +# undefinedLike.js API documentation + + + + + +## `is` +* `is.isUndefinedLike` + + + + + + + + + +## `is` + + + +

is.exports(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/undefinedLike.js#L26 "View in source") [Ⓣ][1] + +(Function): Checks if `value` is `undefined` OR `"undefined"` + + +#### @see + +* fluents/chain able/blob/master/src/deps/is/null or undefined.js + +#### @extends + + + + +#### @Since +5.0.0-beta.4 + +#### Arguments +1. `x=undefined` *(*)*: value + +#### Returns +*(boolean)*: x isUndefinedLike + +#### Example +```js +isUndefined(void 0) //=> true +isUndefined(undefined) //=> true +isUndefined('undefined') //=> true +isUndefined(NaN) //=> false +isUndefined({}) //=> false + +``` +--- + + + + + + + + [1]: #is "Jump back to the TOC." diff --git a/docs/docdown/deps/is/weakMap.md b/docs/docdown/deps/is/weakMap.md new file mode 100644 index 0000000..03a3ec4 --- /dev/null +++ b/docs/docdown/deps/is/weakMap.md @@ -0,0 +1,56 @@ +# weakMap.js API documentation + + + + + +## `isWeakMap` +* `isWeakMap` + + + + + + + + + +## `isWeakMap` + + + +

isWeakMap(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/weakMap.js#L21 "View in source") [Ⓣ][1] + +(Function): Checks if `value` is classified as a `WeakMap` object. + + +#### @Since +5.0.0-beta.4 + +#### Arguments +1. `x=undefined` *(*)*: The value to check. + +#### Returns +*(boolean)*: Returns `true` if `value` is a weak map, else `false`. + +#### Example +```js +isWeakMap(new WeakMap()) +// => true + +isWeakMap(new Map()) +// => false + +``` +--- + + + + + + + + [1]: #isweakmap "Jump back to the TOC." diff --git a/docs/docdown/deps/is/weakSet.md b/docs/docdown/deps/is/weakSet.md new file mode 100644 index 0000000..538033c --- /dev/null +++ b/docs/docdown/deps/is/weakSet.md @@ -0,0 +1,56 @@ +# weakSet.js API documentation + + + + + +## `isWeakSet` +* `isWeakSet` + + + + + + + + + +## `isWeakSet` + + + +

isWeakSet(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/is/weakSet.js#L21 "View in source") [Ⓣ][1] + +(Function): Checks if `value` is classified as a `isWeakSet` object. + + +#### @Since +5.0.0-beta.4 + +#### Arguments +1. `x=undefined` *(*)*: The value to check. + +#### Returns +*(boolean)*: Returns `true` if `value` is a weak map, else `false`. + +#### Example +```js +isWeakSet(new WeakSet()) +// => true + +isWeakSet(new Set()) +// => false + +``` +--- + + + + + + + + [1]: #isweakset "Jump back to the TOC." diff --git a/docs/docdown/deps/matcher.md b/docs/docdown/deps/matcher.md deleted file mode 100644 index 81cfcc6..0000000 --- a/docs/docdown/deps/matcher.md +++ /dev/null @@ -1,94 +0,0 @@ -# matcher.js API documentation - - - - - -## `matcher` -* `matcher.make` -* `matcher.matcher` -* `matcher.toarr` - - - - - - - - - -## `matcher` - - - -

# matcher.make(pattern, shouldNegate, alphaOmega)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/matcher.js#L60 "View in source") [Ⓣ][1] - - - -#### Since -3.0.0 - -#### Arguments -1. `pattern` *(Function|RegExp|string|string[])*: a matchable pattern -2. `shouldNegate` *(|boolean)*: turn into a negated regex -3. `alphaOmega` *(|boolean)*: should have regex start at the beginning and the end - -#### Returns -*(*)*: matchable - -#### Example -```js -matcher.make('*') - //=> RegExp('.*', 'i') -``` ---- - - - - - -

# matcher.matcher(inputs, patterns, shouldNegate, alphaOmega)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/matcher.js#L132 "View in source") [Ⓣ][1] - - - -#### Since -3.0.0 - -#### Arguments -1. `inputs` *(string|string[])*: input to use patterns as predicates on -2. `patterns` *(Function|RegExp|string|string[])*: predicates to match with, transformed to Matcher -3. `shouldNegate` *(|boolean)*: should negate, passed to matcher.make -4. `alphaOmega` *(|boolean)*: should enforce regex @beginning and end, passed to .matcher - -#### Returns -*(*)*: - -#### Example -```js -matcher(['foo', 'bar', 'moo'], ['*oo', '!foo']); - //=> ['moo'] - - matcher(['foo', 'bar', 'moo'], ['!*oo']); -``` ---- - - - - - -

# matcher.toarr

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/matcher.js#L6 "View in source") [Ⓣ][1] - - - ---- - - - - - - - - [1]: #matcher "Jump back to the TOC." diff --git a/docs/docdown/deps/matcher/any-key-val.md b/docs/docdown/deps/matcher/any-key-val.md index 5265b1b..063f82b 100644 --- a/docs/docdown/deps/matcher/any-key-val.md +++ b/docs/docdown/deps/matcher/any-key-val.md @@ -5,7 +5,7 @@ ## `exports` -* `exports` +* `exports` @@ -21,19 +21,22 @@ 🌊 Types: matcher.d  -

# exports(keys=undefined, vals=undefined)

+

exports(keys=undefined, vals=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/matcher/any-key-val.js#L27 "View in source") [Ⓣ][1] (Function): the original simple to-test matcher for traversable, will be merged into, or simplified as simplified into matcher -### @todos +#### @todos - [ ] should use matcher, - [ ] should inprove the callback data... -#### Since + +#### @Since 2.0.0 #### Arguments diff --git a/docs/docdown/deps/matcher/escape-string-regex.md b/docs/docdown/deps/matcher/escape-string-regex.md index 16fe1d0..af99f8d 100644 --- a/docs/docdown/deps/matcher/escape-string-regex.md +++ b/docs/docdown/deps/matcher/escape-string-regex.md @@ -4,8 +4,8 @@ -## `matcher.prototype` -* `matcher.prototype.escapeStringRegExp` +## `matcher` +* `matcher.escapeStringRegExp` @@ -15,21 +15,28 @@ -## `matcher.prototype` +## `matcher` -

# matcher.prototype.exports(str=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/matcher/escape-string-regex.js#L19 "View in source") [Ⓣ][1] +

matcher.exports(str=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/matcher/escape-string-regex.js#L21 "View in source") [Ⓣ][1] Function -### @notes +#### @see + +* fluents/chain able/blob/master/src/deps/fp/replace.js + +#### @notes * also as const escapeStringRegexp = require('escape-string-regexp'); -#### Since + +#### @Since 3.0.0 #### Arguments @@ -53,4 +60,4 @@ new RegExp(escaped) - [1]: #matcher.prototype "Jump back to the TOC." + [1]: #matcher "Jump back to the TOC." diff --git a/docs/docdown/deps/matcher/matcher.md b/docs/docdown/deps/matcher/matcher.md index 28e92d5..447d774 100644 --- a/docs/docdown/deps/matcher/matcher.md +++ b/docs/docdown/deps/matcher/matcher.md @@ -4,17 +4,17 @@ -## `matcher.prototype` -* `matcher.prototype.make` -* `matcher.prototype.match` -* `matcher.prototype.matcher` +## `matcher` +* `matcher.make` +* `matcher.match` +* `matcher.matcher` ## `test` -* `test` +* `test` @@ -24,16 +24,19 @@ -## `matcher.prototype` +## `matcher` -

# matcher.prototype.make(pattern=undefined, shouldNegate=undefined, alphaOmega=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/matcher/matcher.js#L64 "View in source") [Ⓣ][1] +

matcher.make(pattern=undefined, shouldNegate=undefined, alphaOmega=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/matcher/matcher.js#L65 "View in source") [Ⓣ][1] (Function): turn any string[], function[], or RegExp[] into a matcher -#### Since + +#### @Since 3.0.0 #### Arguments @@ -91,12 +94,15 @@ matcher.make(noName, true, true) -

# matcher.prototype.matcher(inputs=undefined, patterns=undefined, shouldNegate=undefined, alphaOmega=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/matcher/matcher.js#L140 "View in source") [Ⓣ][1] +

matcher.matcher(inputs=undefined, patterns=undefined, shouldNegate=undefined, alphaOmega=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/matcher/matcher.js#L141 "View in source") [Ⓣ][1] (Function): same as .make but also accepts inputs, and returns an array -#### Since + +#### @Since 3.0.0 #### Arguments @@ -151,13 +157,15 @@ matcher({ test: x => x === 'kinga' }, 'nope') 🔬 Tests: matcher  -

# matcher.prototype.matcher

+

matcher.matcher

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/matcher/matcher.js#L9 "View in source") [Ⓣ][1] unknown -### @symb +#### @symb 🎯 --- @@ -172,13 +180,15 @@ unknown -

# test

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/matcher/matcher.js#L166 "View in source") [Ⓣ][1] +

test

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/matcher/matcher.js#L167 "View in source") [Ⓣ][1] unknown -### @todos +#### @todos - [ ] replace to-test @@ -190,4 +200,4 @@ unknown - [1]: #matcher.prototype "Jump back to the TOC." + [1]: #matcher "Jump back to the TOC." diff --git a/docs/docdown/deps/matcher/to-regexp.md b/docs/docdown/deps/matcher/to-regexp.md index d94b674..6fde861 100644 --- a/docs/docdown/deps/matcher/to-regexp.md +++ b/docs/docdown/deps/matcher/to-regexp.md @@ -4,8 +4,8 @@ -## `matcher.prototype` -* `matcher.prototype.toRegExp` +## `matcher` +* `matcher.toRegExp` @@ -15,17 +15,19 @@ -## `matcher.prototype` +## `matcher` -

# matcher.prototype.exports(str=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/matcher/to-regexp.js#L21 "View in source") [Ⓣ][1] +

matcher.exports(str=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/matcher/to-regexp.js#L23 "View in source") [Ⓣ][1] Function -### @extends +#### @extends @@ -51,4 +53,4 @@ toRegExp('*') - [1]: #matcher.prototype "Jump back to the TOC." + [1]: #matcher "Jump back to the TOC." diff --git a/docs/docdown/deps/matcher/to-test.md b/docs/docdown/deps/matcher/to-test.md index 254115a..92a7f41 100644 --- a/docs/docdown/deps/matcher/to-test.md +++ b/docs/docdown/deps/matcher/to-test.md @@ -4,8 +4,8 @@ -## `exports` -* `exports` +## `toTest` +* `toTest` @@ -15,21 +15,24 @@ -## `exports` +## `toTest` -

# exports(matchable=undefined, [arg1=undefined], [arg2=undefined])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/matcher/to-test.js#L41 "View in source") [Ⓣ][1] +

toTest(matchable=undefined, [arg1=undefined], [arg2=undefined])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/matcher/to-test.js#L47 "View in source") [Ⓣ][1] (Function): like matcher, but .isMatch -### @notes +#### @notes * as else-if for easier ternary uglification -#### Since + +#### @Since 3.0.0 #### Arguments @@ -73,4 +76,4 @@ matcher({ test: x => x === 'kinga' }, 'nope') - [1]: #exports "Jump back to the TOC." + [1]: #totest "Jump back to the TOC." diff --git a/docs/docdown/deps/meta/ignored.md b/docs/docdown/deps/meta/ignored.md new file mode 100644 index 0000000..ab06c0b --- /dev/null +++ b/docs/docdown/deps/meta/ignored.md @@ -0,0 +1,11 @@ +# ignored.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/meta/keymap.md b/docs/docdown/deps/meta/keymap.md index 45df404..3af8644 100644 --- a/docs/docdown/deps/meta/keymap.md +++ b/docs/docdown/deps/meta/keymap.md @@ -5,7 +5,7 @@ ## `access` -* `access` +* `access` @@ -19,7 +19,9 @@ -

# access([index=Number], [obj=undefined], [val=undefined])

+

access([index=Number], [obj=undefined], [val=undefined])

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/meta/keymap.js#L34 "View in source") [Ⓣ][1] Function diff --git a/docs/docdown/deps/meta/meta.md b/docs/docdown/deps/meta/meta.md index 2204d24..529ff70 100644 --- a/docs/docdown/deps/meta/meta.md +++ b/docs/docdown/deps/meta/meta.md @@ -5,36 +5,36 @@ ## `get` -* `get` +* `get` ## `getMeta` -* `getMeta` +* `getMeta` ## `has` -* `has` +* `has` ## `meta` -* `` -* `meta` +* `` +* `meta` ## `set` -* `set` +* `set` @@ -48,12 +48,15 @@ -

# get(key=undefined, [prop=undefined])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/meta/meta.js#L73 "View in source") [Ⓣ][1] +

get(key=undefined, [prop=undefined])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/meta/meta.js#L75 "View in source") [Ⓣ][1] Function -#### Since + +#### @Since 4.0.0 #### Arguments @@ -75,12 +78,15 @@ Function -

# getMeta(_this=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/meta/meta.js#L26 "View in source") [Ⓣ][1] +

getMeta(_this=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/meta/meta.js#L28 "View in source") [Ⓣ][1] Function -#### Since + +#### @Since 4.0.0 #### Arguments @@ -101,12 +107,15 @@ Function -

# has(key=undefined, [prop=undefined])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/meta/meta.js#L63 "View in source") [Ⓣ][1] +

has(key=undefined, [prop=undefined])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/meta/meta.js#L65 "View in source") [Ⓣ][1] Function -#### Since + +#### @Since 4.0.0 #### Arguments @@ -128,8 +137,10 @@ Function -

# 

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/meta/meta.js#L37 "View in source") [Ⓣ][1] +

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/meta/meta.js#L39 "View in source") [Ⓣ][1] unknown @@ -139,12 +150,15 @@ unknown -

# meta(key=undefined, [prop=undefined], [value=undefined])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/meta/meta.js#L110 "View in source") [Ⓣ][1] +

meta(key=undefined, [prop=undefined], [value=undefined])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/meta/meta.js#L112 "View in source") [Ⓣ][1] (Function): a single easily minifiable function, dynamically setting & getting depending on arguments to avoid nested property accessing only instantiating when values are **addded** -#### Since + +#### @Since 4.0.0 #### Arguments @@ -167,12 +181,15 @@ unknown -

# set(key=undefined, [prop=undefined], [value=undefined])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/meta/meta.js#L82 "View in source") [Ⓣ][1] +

set(key=undefined, [prop=undefined], [value=undefined])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/meta/meta.js#L84 "View in source") [Ⓣ][1] Function -#### Since + +#### @Since 4.0.0 #### Arguments diff --git a/docs/docdown/deps/native/arraySlice.md b/docs/docdown/deps/native/arraySlice.md new file mode 100644 index 0000000..6d389b9 --- /dev/null +++ b/docs/docdown/deps/native/arraySlice.md @@ -0,0 +1,11 @@ +# arraySlice.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/array/insert-at-index.md b/docs/docdown/deps/native/functionToString.md similarity index 77% rename from docs/docdown/deps/array/insert-at-index.md rename to docs/docdown/deps/native/functionToString.md index 3b28de7..2a49ef7 100644 --- a/docs/docdown/deps/array/insert-at-index.md +++ b/docs/docdown/deps/native/functionToString.md @@ -1,4 +1,4 @@ -# insert-at-index.js API documentation +# functionToString.js API documentation diff --git a/docs/docdown/deps/native/hasOwnProperty.md b/docs/docdown/deps/native/hasOwnProperty.md new file mode 100644 index 0000000..54559bc --- /dev/null +++ b/docs/docdown/deps/native/hasOwnProperty.md @@ -0,0 +1,11 @@ +# hasOwnProperty.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/native/objectToString.md b/docs/docdown/deps/native/objectToString.md new file mode 100644 index 0000000..b6b5835 --- /dev/null +++ b/docs/docdown/deps/native/objectToString.md @@ -0,0 +1,11 @@ +# objectToString.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/native/propertyIsEnumerable.md b/docs/docdown/deps/native/propertyIsEnumerable.md new file mode 100644 index 0000000..0e0c416 --- /dev/null +++ b/docs/docdown/deps/native/propertyIsEnumerable.md @@ -0,0 +1,11 @@ +# propertyIsEnumerable.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/primitives/undefined.md b/docs/docdown/deps/primitives/undefined.md deleted file mode 100644 index a9f445e..0000000 --- a/docs/docdown/deps/primitives/undefined.md +++ /dev/null @@ -1,11 +0,0 @@ -# undefined.js API documentation - - - - - - - - - - [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/reduce/clean.md b/docs/docdown/deps/reduce/clean.md index 745a920..15e42eb 100644 --- a/docs/docdown/deps/reduce/clean.md +++ b/docs/docdown/deps/reduce/clean.md @@ -4,8 +4,8 @@ -## `reduce.prototype` -* `reduce.prototype.exports` +## `reduce` +* `reduce.exports` @@ -15,19 +15,26 @@ -## `reduce.prototype` +## `reduce` -

# reduce.prototype.exports(obj=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/reduce/clean.js#L39 "View in source") [Ⓣ][1] +

reduce.exports(obj=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/reduce/clean.js#L47 "View in source") [Ⓣ][1] (Function): goes through the maps, and the map values, reduces them to array then to an object using the reduced values -### @see +#### @see -* fluents/chain able/blob/master/src/deps/reduce/clean.js +* fluents/chain able/blob/master/src/deps/reduce/clean.js + +#### @todos + +- [ ] seems to be overkill with reducing mapping just copy & ignore or delete? + #### Arguments 1. `obj=undefined` *(Object): object to clean, usually .entries()* @@ -57,4 +64,4 @@ clean(map.entries()) - [1]: #reduce.prototype "Jump back to the TOC." + [1]: #reduce "Jump back to the TOC." diff --git a/docs/docdown/deps/reduce/entries.md b/docs/docdown/deps/reduce/entries.md index d0d4a46..020a4a5 100644 --- a/docs/docdown/deps/reduce/entries.md +++ b/docs/docdown/deps/reduce/entries.md @@ -5,7 +5,7 @@ ## `exports` -* `exports` +* `exports` @@ -19,20 +19,28 @@ -

# exports(reduced=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/reduce/entries.js#L63 "View in source") [Ⓣ][1] +

exports(reduced=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/reduce/entries.js#L66 "View in source") [Ⓣ][1] (Function): recursively reduce maps and objects that include reducable data -### @see +#### @see -* fluents/chain able/blob/master/src/chained map.js +* fluents/chain able/blob/master/src/chained map.js -### @sig +#### @notes + +* could curry, but this is super hot function + + +#### @sig reduced => object => isMap(object) -> reduced; merge(object, reduced) -#### Since + +#### @Since 4.0.0 #### Arguments diff --git a/docs/docdown/deps/reduce/objects.md b/docs/docdown/deps/reduce/objects.md deleted file mode 100644 index 6313720..0000000 --- a/docs/docdown/deps/reduce/objects.md +++ /dev/null @@ -1,11 +0,0 @@ -# objects.js API documentation - - - - - - - - - - [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/reduce/reduce.md b/docs/docdown/deps/reduce/reduce.md index c73a1de..e8c9ef8 100644 --- a/docs/docdown/deps/reduce/reduce.md +++ b/docs/docdown/deps/reduce/reduce.md @@ -5,7 +5,7 @@ ## `exports` -* `exports` +* `exports` @@ -19,12 +19,15 @@ -

# exports(map=undefined)

+

exports(map=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/reduce/reduce.js#L26 "View in source") [Ⓣ][1] (Function): Map -> Object -#### Since + +#### @Since 4.0.0 #### Arguments diff --git a/docs/docdown/deps/reduce/toObj.md b/docs/docdown/deps/reduce/toObj.md new file mode 100644 index 0000000..45ad4a2 --- /dev/null +++ b/docs/docdown/deps/reduce/toObj.md @@ -0,0 +1,11 @@ +# toObj.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/string/camelCase.md b/docs/docdown/deps/string/camelCase.md new file mode 100644 index 0000000..05ae298 --- /dev/null +++ b/docs/docdown/deps/string/camelCase.md @@ -0,0 +1,68 @@ +# camelCase.js API documentation + + + + + +## `exports` +* `exports` + + + + + + + + + +## `exports` + + + +* 🌊 Types: deps.d  +* 🌊 Types: deps.encase.d  +* 🌊 Types: deps.reduce.d  + +🔬 Tests: camelCase  + +

exports(str=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/string/camelCase.js#L26 "View in source") [Ⓣ][1] + +(Function): camelCase + + +#### @todos + +- [ ] s.charAt(0).toLowerCase() + string.slice(1) + + +#### @symb + +🐫 + +#### @Since +0.2.0 + +#### Arguments +1. `str=undefined` *(string)*: string to turn into camelCase + +#### Returns +*(string)*: camelCased string + +#### Example +```js +camelCase('snake_case') +//=> 'snakeCase' + +``` +--- + + + + + + + + [1]: #exports "Jump back to the TOC." diff --git a/docs/docdown/deps/string/class-names.md b/docs/docdown/deps/string/class-names.md index 5823b4b..a312ea6 100644 --- a/docs/docdown/deps/string/class-names.md +++ b/docs/docdown/deps/string/class-names.md @@ -5,7 +5,7 @@ ## `exports` -* `exports` +* `exports` @@ -19,7 +19,9 @@ -

# exports(_c=undefined)

+

exports(_c=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/string/class-names.js#L6 "View in source") [Ⓣ][1] Function diff --git a/docs/docdown/deps/string/firstToUpperCase.md b/docs/docdown/deps/string/firstToUpperCase.md new file mode 100644 index 0000000..3ada6a3 --- /dev/null +++ b/docs/docdown/deps/string/firstToUpperCase.md @@ -0,0 +1,11 @@ +# firstToUpperCase.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/to-arr.md b/docs/docdown/deps/to-arr.md index 9e5395c..b984730 100644 --- a/docs/docdown/deps/to-arr.md +++ b/docs/docdown/deps/to-arr.md @@ -5,14 +5,14 @@ ## `exports` -* `exports` +* `exports` ## `to-arr` -* `` +* `` @@ -26,18 +26,23 @@ -🌊 Types: deps.d  +* 🌊 Types: deps.d  +* 🌊 Types: deps.encase.d  +* 🌊 Types: deps.reduce.d  -

# exports(ar=undefined)

+

exports(ar=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/to-arr.js#L48 "View in source") [Ⓣ][1] (Function): anything into an array -### @sig +#### @sig * => Array -#### Since + +#### @Since 0.0.1 #### Arguments @@ -87,7 +92,9 @@ toarr('').concat(toarr(false)).concat(toarr(null)) -

# 

+

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/to-arr.js#L58 "View in source") [Ⓣ][1] unknown diff --git a/docs/docdown/deps/to-regexp.md b/docs/docdown/deps/to-regexp.md deleted file mode 100644 index 42b7125..0000000 --- a/docs/docdown/deps/to-regexp.md +++ /dev/null @@ -1,11 +0,0 @@ -# to-regexp.js API documentation - - - - - - - - - - [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/to-test.md b/docs/docdown/deps/to-test.md deleted file mode 100644 index 051f415..0000000 --- a/docs/docdown/deps/to-test.md +++ /dev/null @@ -1,70 +0,0 @@ -# to-test.js API documentation - - - - - -## `exports` -* `exports` - - - - - - - - - -## `exports` - - - -

# exports(matchable, [arg1=undefined], [arg2=undefined])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/to-test.js#L41 "View in source") [Ⓣ][1] - - - -#### Since -3.0.0 - -#### Arguments -1. `matchable` *(Matchable)*: any matchable -2. `[arg1=undefined]` *(any)*: arg to match with -3. `[arg2=undefined]` *(any)*: optional second arg to pass into tester - -#### Returns -*(boolean)*: is a match, passes the test - -#### Example -```js -matcher('kinga', 'kinga') - //=> true - matcher('k*nga', 'kinga') - //=> true - matcher('kinga', 'nope') - //=> false - - matcher(new RegExp(/kinga/), 'kinga') - //=> true - matcher(new RegExp(/kinga/), 'nope') - //=> false - - matcher(x => x === 'kinga', 'kinga') - //=> true - matcher(x => x === 'kinga', 'nope') - //=> false - - matcher({test: x => x === 'kinga'}, 'kinga') - //=> true - matcher({test: x => x === 'kinga'}, 'nope') - //=> false -``` ---- - - - - - - - - [1]: #exports "Jump back to the TOC." diff --git a/docs/docdown/deps/to/array.md b/docs/docdown/deps/to/array.md new file mode 100644 index 0000000..09c2c71 --- /dev/null +++ b/docs/docdown/deps/to/array.md @@ -0,0 +1,11 @@ +# array.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/to/boolean.md b/docs/docdown/deps/to/boolean.md new file mode 100644 index 0000000..25f967e --- /dev/null +++ b/docs/docdown/deps/to/boolean.md @@ -0,0 +1,11 @@ +# boolean.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/to/coerce.md b/docs/docdown/deps/to/coerce.md new file mode 100644 index 0000000..487cdaf --- /dev/null +++ b/docs/docdown/deps/to/coerce.md @@ -0,0 +1,11 @@ +# coerce.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/to/index.md b/docs/docdown/deps/to/index.md new file mode 100644 index 0000000..5ac127d --- /dev/null +++ b/docs/docdown/deps/to/index.md @@ -0,0 +1,11 @@ +# index.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/to/integer.md b/docs/docdown/deps/to/integer.md new file mode 100644 index 0000000..b34f07f --- /dev/null +++ b/docs/docdown/deps/to/integer.md @@ -0,0 +1,11 @@ +# integer.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/primitives/null.md b/docs/docdown/deps/to/map.md similarity index 82% rename from docs/docdown/deps/primitives/null.md rename to docs/docdown/deps/to/map.md index d39738f..2bf4eff 100644 --- a/docs/docdown/deps/primitives/null.md +++ b/docs/docdown/deps/to/map.md @@ -1,4 +1,4 @@ -# null.js API documentation +# map.js API documentation diff --git a/docs/docdown/deps/to/number.md b/docs/docdown/deps/to/number.md new file mode 100644 index 0000000..abdca98 --- /dev/null +++ b/docs/docdown/deps/to/number.md @@ -0,0 +1,11 @@ +# number.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/to/object.md b/docs/docdown/deps/to/object.md new file mode 100644 index 0000000..daec193 --- /dev/null +++ b/docs/docdown/deps/to/object.md @@ -0,0 +1,11 @@ +# object.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/to/set.md b/docs/docdown/deps/to/set.md new file mode 100644 index 0000000..e2a6d32 --- /dev/null +++ b/docs/docdown/deps/to/set.md @@ -0,0 +1,11 @@ +# set.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/to/setToArray.md b/docs/docdown/deps/to/setToArray.md new file mode 100644 index 0000000..e2d82b7 --- /dev/null +++ b/docs/docdown/deps/to/setToArray.md @@ -0,0 +1,11 @@ +# setToArray.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/to/string.md b/docs/docdown/deps/to/string.md new file mode 100644 index 0000000..b37889c --- /dev/null +++ b/docs/docdown/deps/to/string.md @@ -0,0 +1,11 @@ +# string.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/to/to.md b/docs/docdown/deps/to/to.md new file mode 100644 index 0000000..d5f2edb --- /dev/null +++ b/docs/docdown/deps/to/to.md @@ -0,0 +1,37 @@ +# to.js API documentation + + + + + +## `to.exports` +* `to.exports` + + + + + + + + + +## `to.exports` + + + +

to.exports

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/to/to.js#L13 "View in source") [Ⓣ][1] + +Object + +--- + + + + + + + + [1]: #to.exports "Jump back to the TOC." diff --git a/docs/docdown/deps/traverse.md b/docs/docdown/deps/traverse.md index 3e444cf..75285ef 100644 --- a/docs/docdown/deps/traverse.md +++ b/docs/docdown/deps/traverse.md @@ -4,173 +4,36 @@ -## `Traverse.prototype` -* `Traverse.prototype.` -* `Traverse.prototype.` -* `Traverse.prototype.clone` -* `Traverse.prototype.forEach` -* `Traverse.prototype.get` -* `Traverse.prototype.has` -* `Traverse.prototype.nodes` -* `Traverse.prototype.paths` -* `Traverse.prototype.reduce` -* `Traverse.prototype.set` +## `Traverse` +* `Traverse.checkIteratable` +* `Traverse.clone` +* `Traverse.forEach` +* `Traverse.iterate` +* `Traverse.remove` +* `Traverse.skip` +* `Traverse.stop` +* `Traverse.update` -## `after` -* `after` +## `clone` +* `clone` -## `before` -* `before` - - - - - -## `block` -* `block` - - - - - -## `circular` -* `circular` - - - - - -## `delete` -* `delete` - - - - - -## `forEach` -* `forEach` - - - - - -## `isRoot` -* `isRoot` - - - - - -## `key` -* `key` - - - - - -## `level` -* `level` - - - - - -## `node` -* `node` - - - - - -## `node_` -* `node_` - - - - - -## `parent` -* `parent` - - - - - -## `path` -* `path` - - - - - -## `post` -* `post` - - - - - -## `pre` -* `pre` - - - - - -## `remove` -* `remove` - - - - - -## `return` -* `return` - - - - - -## `state` -* `state` - - - - - -## `stop` -* `stop` +## `copy` +* `copy` ## `traverse` -* `` -* `` -* `traverse` - - - - - -## `update` -* `update` - - - - - -## `updateState` -* `updateState` +* `` @@ -180,56 +43,46 @@ -## `Traverse.prototype` +## `Traverse` -* 🌊 Types: TraverseChain.d  -* 🌊 Types: traverse.d  - -* 🔬 Tests: circular  -* 🔬 Tests: date  -* 🔬 Tests: equal  -* 🔬 Tests: error  -* 🔬 Tests: has  -* 🔬 Tests: index  -* 🔬 Tests: instance  -* 🔬 Tests: interface  -* 🔬 Tests: json  -* 🔬 Tests: keys  -* 🔬 Tests: leaves  -* 🔬 Tests: negative  -* 🔬 Tests: obj  -* 🔬 Tests: set-map  -* 🔬 Tests: siblings  -* 🔬 Tests: stop  -* 🔬 Tests: stringify  -* 🔬 Tests: subexpr  -* 🔬 Tests: superDeep  - -

# Traverse.prototype.Traverse(obj=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L91 "View in source") [Ⓣ][1] +

Traverse.checkIteratable(node=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L337 "View in source") [Ⓣ][1] -Function +(Function): checks whether a node is iteratable -### @todos +#### @todos -- [ ] : symbol, map, set - - -### @classProps - -* {value} the data passed in as an argument to traverse on +- [ ] move into the wrapper? if perf allows? #### Arguments -1. `obj=undefined` *(Traversable)*: any traversable value +1. `node=undefined` *(*)*: value to check + +#### Returns +*(void)*: #### Example ```js -traverse({}) -//=> Traverser - +.checkIteratable({eh: true}) + //=> this.isLeaf = false + //=> this.isCircular = false + //=> this.isIteratable = true + + .checkIteratable({} || []) + //=> this.isLeaf = true + //=> this.isCircular = false + //=> this.isIteratable = false + + var circular = {} + circular.circular = circular + .checkIteratable(circular) + //=> this.isLeaf = false + //=> this.isCircular = true + //=> this.isIteratable = true ``` --- @@ -237,54 +90,43 @@ traverse({}) -

# Traverse.prototype.map(cb=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L199 "View in source") [Ⓣ][1] +

Traverse.clone(arg=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L833 "View in source") [Ⓣ][1] -(Function): Execute fn for each node in the object and return a new object with the results of the walk. To update nodes in the result use this.update(value). +(Function): clone any value -#### Arguments -1. `cb=undefined` *(Function)*: fn for each node in the object -#### Returns -*(any)*: +#### @see -#### Example -```js -var { traverse } = require('chain-able') +* fluents/chain able/blob/master/src/deps/dopemerge/dopemerge.js -var obj = { a: 1, b: 2, c: [3, 4] } -obj.c.push(obj) +#### @extends -var scrubbed = traverse(obj).map(function(x) { - if (this.circular) this.remove() -}) -console.dir(scrubbed) -//=> { a: 1, b: 2, c: [ 3, 4 ] } - -``` ---- +* undefined +* undefined - - -

# Traverse.prototype.clone()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L319 "View in source") [Ⓣ][1] +#### @Since +4.0.0 -(Function): Create a deep clone of the object. +#### Arguments +1. `arg=undefined` *(*)*: argument to clone #### Returns -*(any)*: +*(*)*: cloned value #### Example ```js -const { traverse, eq } = require('chain-able') +var obj = { eh: true } +clone(obj) === obj //=> false -const obj = { eh: true, canada: [1] } -const cloned = traverse(obj).clone() -cloned.eh = false -eq(cloned, obj) -//=> false +var obj = { eh: true } +var obj2 = clone(obj) +obj.eh = false +console.log(obj2.eh) //=> true ``` --- @@ -293,28 +135,29 @@ eq(cloned, obj) -

# Traverse.prototype.forEach(callback=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L226 "View in source") [Ⓣ][1] +

Traverse.forEach(cb=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L250 "View in source") [Ⓣ][1] + +(Function): this is the main usage of Traverse + -(Function): Execute fn for each node in the object but unlike .map(), when this.update() is called it updates the object in-place. executes a provided function once for each traversed element. +#### @Since +3.0.0 #### Arguments -1. `callback=undefined` *(Function)*: provided callback function +1. `cb=undefined` *(Function)*: callback for each iteration #### Returns -*(any)*: this.value +*(*)*: mapped result or original value, depends how it is used #### Example ```js -var { traverse } = require('chain-able') - -var obj = [5, 6, -3, [7, 8, -2, 1], { f: 10, g: -13 }] -traverse(obj).forEach(function(x) { - if (x < 0) this.update(x + 128) -}) - -console.dir(obj) -//=> [ 5, 6, 125, [ 7, 8, 126, 1 ], { f: 10, g: 115 } ] +traverse([1, 2, 3]).forEach((key, value) => console.log({ [key]: value })) +//=> {'0': 1} +//=> {'1': 2} +//=> {'2': 3} ``` --- @@ -323,123 +166,67 @@ console.dir(obj) -

# Traverse.prototype.get(ps=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L105 "View in source") [Ⓣ][1] +

Traverse.iterate(on=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L518 "View in source") [Ⓣ][1] -(Function): Get the element at the array path. +Function -### @todos +#### @todos -- [ ] hasOwnProperty +- [ ] handler for Set & Map so they can be skipped or traversed, for example when cloning... +- [ ] add hook to add custom checking if isIteratable +- [ ] deal with .isRoot if needed +- [ ] examples with clone and stop -#### Arguments -1. `ps=undefined` *(string[])*: paths - -#### Returns -*(any)*: value at dot-prop ---- - - - - - -

# Traverse.prototype.has(pathsArray=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L144 "View in source") [Ⓣ][1] - -(Function): Return whether the element at the array path exists. +#### @sig +on(key: null | Primitive, val: any, instance: Traverse): any #### Arguments -1. `pathsArray=undefined` *(string[])*: paths +1. `on=undefined` *(Function)*: callback fn for each iteration #### Returns -*(boolean)*: has element at path +*(*)*: this.node #### Example ```js -traverse({ eh: true }).has(['eh']) -//=> true +iterate([]) +//=> [] +//=> on(null, []) ``` #### Example ```js -traverse({ eh: true }).has(['canada']) -//=> false +iterate([1]) +//=> [1] +//=> on(null, [1]) +//=> on('1', 1) ``` #### Example ```js -traverse([0]).has([2]) -//=> false +//primitive - same for any number, string, symbol, null, undefined +iterate(Symbol('eh')) +//=> Symbol('eh') +//=> on(Symbol('eh')) ``` ---- - - - - - -

# Traverse.prototype.nodes()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L294 "View in source") [Ⓣ][1] - -(Function): Return an Array of every node in the object. - -#### Returns -*(*)*: - ---- - - - - - -🔬 Tests: keys  - -

# Traverse.prototype.paths()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L281 "View in source") [Ⓣ][1] - -(Function): Return an Array of every possible non-cyclic path in the object. Paths are Arrays of string keys. - -#### Returns -*(*)*: - ---- - - - - - -

# Traverse.prototype.reduce(cb=undefined, init=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L264 "View in source") [Ⓣ][1] - -(Function): applies a function against an accumulator and each element in the array *(from left to right)* to reduce it to a single value. calls cb for each loop that is .notRoot defaults initial value to `this.value` - -#### Arguments -1. `cb=undefined` *(Function)*: callback forEach -2. `init=undefined` *(Array|Object|any)*: initial value - -#### Returns -*(*)*: - #### Example ```js -var { traverse } = require('chain-able') +var deeper = { eh: 'canada', arr: [{ moose: true }, 0] } +iterate(deeper) +//=> deeper // returns +//=> on(null, deeper, this) // root -var obj = { - a: [1, 2, 3], - b: 4, - c: [5, 6], - d: { e: [7, 8], f: 9 }, -} +//=> on('eh', 'canada', this) // 1st branch -var leaves = traverse(obj).reduce(function(acc, x) { - if (this.isLeaf) acc.push(x) - return acc -}, []) - -console.dir(leaves) -//=> [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ] +//=> on('arr', [{moose: true}, 0], this) +//=> on('arr.0', [{moose: true}], this) +//=> on('arr.0.moose', true, this) +//=> on('arr.1', [0], this) ``` --- @@ -448,395 +235,126 @@ console.dir(leaves) -

# Traverse.prototype.set(arrayPath=undefined, value=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L166 "View in source") [Ⓣ][1] - -(Function): Set the element at the array path to value. - -#### Arguments -1. `arrayPath=undefined` *(string[])*: paths -2. `value=undefined` *(any)*: any value to assign to the element @ the path +

Traverse.remove([arg=undefined])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L397 "View in source") [Ⓣ][1] -#### Returns -*(any)*: value passed in +(Function): Remove the current element from the output. +If the node is in an Array it will be spliced off. +Otherwise it will be deleted from its parent. ---- - - - - - - -## `after` - - - -

# after(fn=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L485 "View in source") [Ⓣ][1] - -(Function): Call this function after any of the children are traversed. +#### @Since +2.0.0 #### Arguments -1. `fn=undefined` *(Function)*: +1. `[arg=undefined]` *(|Object)*: optional obj to use, defaults to this.node #### Returns -*(any)*: - ---- - - - - - - - -## `before` - - - -

# before(fn=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L477 "View in source") [Ⓣ][1] +*(void)*: -(Function): Call this function before any of the children are traversed. -You can assign into this.keys here to traverse in a custom order. +#### Example +```js +traverse([0]).forEach((key, val, it) => it.remove()) +//=> [] -#### Arguments -1. `fn=undefined` *(Function)*: +traverse({ eh: true }).forEach((key, val, it) => it.remove()) +//=> {} -#### Returns -*(any)*: +traverse({ eh: true, str: 'stringy' }).forEach((key, val, it) => { + if (!isString(val)) it.remove() +}) +//=> {str: 'stringy'} +``` --- - - - - -## `block` - -

# block()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L517 "View in source") [Ⓣ][1] +

Traverse.skip()

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L298 "View in source") [Ⓣ][1] Function -#### Returns -*(void)*: - ---- - - - +#### @todos - - -## `circular` - - - -

# circular

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L427 "View in source") [Ⓣ][1] - -unknown - ---- - - - - - - - -## `delete` - - - -

# delete(stopHere=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L448 "View in source") [Ⓣ][1] - -(Function): Delete the current element from its parent in the output. Calls delete even on Arrays. +- [ ] skip 1 branch + -#### Arguments -1. `stopHere=undefined` *(boolean)*: +#### @Since +3.0.0 #### Returns *(void)*: ---- - - - - - - - -## `forEach` - - - -

# forEach()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L673 "View in source") [Ⓣ][1] - -(Function): adds methods to Traverser - ---- - - - - - - - -## `isRoot` - - - -

# isRoot

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L417 "View in source") [Ⓣ][1] - -(Boolean): Whether the present node is the root node - ---- - - - - - - - -## `key` - - - -

# key

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L412 "View in source") [Ⓣ][1] - -unknown - ---- - - - - - - - -## `level` - - - -

# level

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L422 "View in source") [Ⓣ][1] - -(number): Depth of the node within the traversal - ---- - - - - - - - -## `node` - - - -

# node

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L390 "View in source") [Ⓣ][1] - -(Array): The present node on the recursive walk - ---- - - - - - - - -## `node_` - - - -

# node_

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L396 "View in source") [Ⓣ][1] - -Array - ---- - - - - - - - -## `parent` - - - -

# parent

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L406 "View in source") [Ⓣ][1] - -unknown - ---- - - - - - - - -## `path` - - - -

# path

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L401 "View in source") [Ⓣ][1] - -(Array): An array of string keys from the root to the present node +#### Example +```js +traverse([1, 2, 3, [4]]).forEach((key, val, t) => { + if (isArray(val)) t.skip() +}) +``` --- - - -## `post` - - +

Traverse.stop()

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L278 "View in source") [Ⓣ][1] -

# post(fn=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L501 "View in source") [Ⓣ][1] - -(Function): Call this function after each of the children are traversed. - -#### Arguments -1. `fn=undefined` *(Function)*: +(Function): stop the iteration #### Returns -*(any)*: - ---- - - - - - - - -## `pre` - - - -

# pre(fn=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L493 "View in source") [Ⓣ][1] - -(Function): Call this function before each of the children are traversed. - -#### Arguments -1. `fn=undefined` *(Function)*: +*(void)*: -#### Returns -*(any)*: +#### Example +```js +traverse({ eh: true, arr: [] }).forEach((key, val, t) => { + if (isArray(val)) this.stop() +}) +``` --- - - -## `remove` +

Traverse.update(value=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L440 "View in source") [Ⓣ][1] - +(Function): update the value for the current key -

# remove(stopHere=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L457 "View in source") [Ⓣ][1] -(Function): Remove the current element from the output. If the node is in an Array it will be spliced off. Otherwise it will be deleted from its parent. +#### @Since +2.0.0 #### Arguments -1. `stopHere=undefined` *(boolean)*: +1. `value=undefined` *(*)*: this.node[this.key] = value #### Returns *(void)*: ---- - - - - - - - -## `return` - - - -

# return(node_=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L374 "View in source") [Ⓣ][1] - -Function - -#### Arguments -1. `node_=undefined` *(any)*: - -#### Returns -*(State)*: see types - ---- - - - - - - - -## `state` - - - -

# state

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L385 "View in source") [Ⓣ][1] - -(Object): Each method that takes a callback has a context *(its this object)* with these attributes: - - -### @classProps - -* {isRoot} @alias isNotRoot Whether or not the present node is a leaf node (has no children) - ---- - - - - - - - -## `stop` - - - -

# stop()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L509 "View in source") [Ⓣ][1] - -Function - -#### Returns -*(void)*: +#### Example +```js +traverse({ eh: true }).forEach((key, val, traverser) => { + if (this.isRoot) return + traverser.update(false) +}) +//=> {eh: false} +``` --- @@ -845,68 +363,36 @@ Function -## `traverse` - - - -

# walk(root=undefined, cb=undefined, immutable=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L360 "View in source") [Ⓣ][1] - -Function - -#### Arguments -1. `root=undefined` *(any)*: root node -2. `cb=undefined` *(Function)*: callback for each -3. `immutable=undefined` *(boolean)*: should mutate or not - -#### Returns -*(any)*: - ---- - - +## `clone` -

# copy(src=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L610 "View in source") [Ⓣ][1] +

clone(arg=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L801 "View in source") [Ⓣ][1] Function -### @notes +#### @todos -* wicked ternary - - -### @todos - -- [ ] does not respect ObjectDescriptors +- [ ] merge with dopemerge? +- [ ] needs tests converted back for this (observe tests do cover somewhat) #### Arguments -1. `src=undefined` *(any)*: +1. `arg=undefined` *(*)*: defaults to this.node #### Returns -*(any)*: - ---- - - - - - -

# traverse(obj=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L7 "View in source") [Ⓣ][1] - -Function - -#### Arguments -1. `obj=undefined` *(Traversable)*: object to traverse +*(*)*: cloned #### Example ```js -traverse({}) -//=> new Traverse(obj) +var obj = {} +var cloned = traverse().clone(obj) +obj.eh = true +eq(obj, cloned) +//=> false ``` --- @@ -917,22 +403,27 @@ traverse({}) -## `update` +## `copy` -

# update(x=undefined, stopHere=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L436 "View in source") [Ⓣ][1] +

copy(src=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L808 "View in source") [Ⓣ][1] + +Function + -(Function): Set a new value for the present node. -All the elements in value will be recursively traversed unless stopHere is true. +#### @todos +- [ ] ugh, how to clone better with *recursive* objects? + #### Arguments -1. `x=undefined` *(Function)*: -2. `stopHere=undefined` *(boolean)*: +1. `src=undefined` *(any)*: wip #### Returns -*(void)*: +*(any)*: wip --- @@ -942,17 +433,16 @@ All the elements in value will be recursively traversed unless stopHere is true. -## `updateState` +## `traverse` -

# updateState()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L533 "View in source") [Ⓣ][1] - -(Function): updates if needed: +

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traverse.js#L22 "View in source") [Ⓣ][1] -#### Returns -*(void)*: +unknown --- @@ -962,4 +452,4 @@ All the elements in value will be recursively traversed unless stopHere is true. - [1]: #traverse.prototype "Jump back to the TOC." + [1]: #traverse "Jump back to the TOC." diff --git a/docs/docdown/deps/traversers/_eq.md b/docs/docdown/deps/traversers/_eq.md new file mode 100644 index 0000000..6fe15bf --- /dev/null +++ b/docs/docdown/deps/traversers/_eq.md @@ -0,0 +1,74 @@ +# _eq.js API documentation + + + + + +## `Traverse` +* `Traverse.eq` + + + + + + + + + +## `Traverse` + + + +

Traverse.eq(traverse=undefined, a=undefined, b=undefined, [loose=undefined])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traversers/_eq.js#L24 "View in source") [Ⓣ][1] + +Function + + +#### @see + +* facebook/immutable js/blob/master/src/utils/deep equal.js +* substack/node deep equal +* docs +* docs/4.17.4 +* angular/angular.js/blob/master/src/angular.js +* jashkenas/underscore/blob/master/underscore.js +* substack/js traverse/blob/master/test/lib/deep equal.js +* facebook/react/blob/master/src/ mocks /deep differ.js + +#### @extends + + + + +#### @Since +3.0.0 + +#### Arguments +1. `traverse=undefined` *(Traverse): traversejs *(scoped, @FIXME @HACK)** +2. `a=undefined` *(*)*: compare to b +3. `b=undefined` *(*)*: compare to a +4. `[loose=undefined]` *(boolean)*: compare loosely + +#### Returns +*(boolean)*: isEqual: a === b + +#### Example +```js +eq(1, 1) //=> true +eq(1, '1') //=> false +eq(1, '1', true) //=> true +eq([1], [1]) //=> true + +``` +--- + + + + + + + + [1]: #traverse "Jump back to the TOC." diff --git a/docs/docdown/deps/traversers/copy.md b/docs/docdown/deps/traversers/copy.md new file mode 100644 index 0000000..45be507 --- /dev/null +++ b/docs/docdown/deps/traversers/copy.md @@ -0,0 +1,55 @@ +# copy.js API documentation + + + + + +## `Traverse` +* `Traverse.copy` + + + + + + + + + +## `Traverse` + + + +

Traverse.copy(src=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traversers/copy.js#L29 "View in source") [Ⓣ][1] + +(Function): copy any primitive value, part of clone + + +#### @Since +3.0.0 + +#### Arguments +1. `src=undefined` *(*)*: value to copy + +#### Returns +*(*)*: copied + +#### Example +```js +copy(/eh/gim) //=> new RegExp('eh', 'gmi') +copy(new Error('eh')) // => new Error with copied stack + msg +copy([1]) // => [1] +copy({}) // => {} + +``` +--- + + + + + + + + [1]: #traverse "Jump back to the TOC." diff --git a/docs/docdown/deps/traversers/eq.md b/docs/docdown/deps/traversers/eq.md index ba308e0..a25ed62 100644 --- a/docs/docdown/deps/traversers/eq.md +++ b/docs/docdown/deps/traversers/eq.md @@ -2,106 +2,10 @@ - - -## `traverse.prototype` -* `traverse.prototype.exports` - - - - - -## `traverse.prototype` - - - -* 🌊 Types: TraverseChain.d  -* 🌊 Types: traverse.d  - -

# traverse.prototype.exports(a=undefined, b=undefined, [loose=false])

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traversers/eq.js#L94 "View in source") [Ⓣ][1] - -(Function): deep traversal of nodes to compare any data types does not check reference, only value equality - - -### @see - -* fluents/chain able/blob/master/src/traverse chain.js - -### @symb - -⚖️ -#### Since -3.0.0 - -#### Arguments -1. `a=undefined` *(any)*: compare a with b -2. `b=undefined` *(any)*: compare b with a -3. `[loose=false]` *(boolean)*: whether to do looser equals check - -#### Returns -*(boolean)*: isEqual - -#### Example -```js -eq(1, 1) -//=> true - -eq(true, false) -//=> false - -eq({}, {}) -//=> true - -``` -#### Example -```js -eq( - { d: new Date(0, 0, 0, 0), x: [1, 2, 3] }, - { d: new Date(0, 0, 0, 0), x: [1, 2, 3] } -) -//=> true - -eq([new RegExp('x')], [/x/]) -//=> true - -eq([new String('x')], ['x']) -//=> true - -eq([new Boolean(false)], [false]) -//=> true - -eq([undefined], [null]) || eq(undefined, null) -//=> false - -``` -#### Example -```js -var xs = [1, 2, 3, 4] -delete xs[2] - -var ys = Object.create(Array.prototype) -ys[0] = 1 -ys[1] = 2 -ys[3] = 4 - -eq(xs, ys) -//=> true - -eq(xs, [1, 2, undefined, 4]) -//=> false - -``` ---- - - - - - - [1]: #traverse.prototype "Jump back to the TOC." + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/traversers/eqValue.md b/docs/docdown/deps/traversers/eqValue.md new file mode 100644 index 0000000..9ddfe76 --- /dev/null +++ b/docs/docdown/deps/traversers/eqValue.md @@ -0,0 +1,62 @@ +# eqValue.js API documentation + + + + + +## `Traverse` +* `Traverse.exports` + + + + + + + + + +## `Traverse` + + + +

Traverse.exports(x=undefined, y=undefined, [loose=false])

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/traversers/eqValue.js#L48 "View in source") [Ⓣ][1] + +(Function): checks value equality, used by eq which compares all types + + +#### @todos + +- [ ] !!!!!! USE ENUM FLAGS ON LOOSE TO ALLOW MORE CONFIG FOR ==, COMPARATOR, VALUEOF, walk proto (check ownProps...)... + + +#### @Since +4.1.0 + +#### Arguments +1. `x=undefined` *(*)*: compare to y +2. `y=undefined` *(*)*: compare to x +3. `[loose=false]` *(boolean|number)*: use == checks when typof != + +#### Returns +*(boolean)*: + +#### Example +```js +eqValue(1, 1) //=> true +eqValue('1', 1) //=> false +eqValue('1', 1, true) //=> true +eqValue({}, {}) //=> true + +``` +--- + + + + + + + + [1]: #traverse "Jump back to the TOC." diff --git a/docs/docdown/deps/traversers/eqdeep.md b/docs/docdown/deps/traversers/eqdeep.md new file mode 100644 index 0000000..c190fc9 --- /dev/null +++ b/docs/docdown/deps/traversers/eqdeep.md @@ -0,0 +1,11 @@ +# eqdeep.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/traversers/stringify.md b/docs/docdown/deps/traversers/stringify.md new file mode 100644 index 0000000..79afae4 --- /dev/null +++ b/docs/docdown/deps/traversers/stringify.md @@ -0,0 +1,11 @@ +# stringify.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/traversers/traverse-comments.md b/docs/docdown/deps/traversers/traverse-comments.md new file mode 100644 index 0000000..df93d90 --- /dev/null +++ b/docs/docdown/deps/traversers/traverse-comments.md @@ -0,0 +1,11 @@ +# traverse-comments.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/util/assign.md b/docs/docdown/deps/util/assign.md index 495aba2..529a9fd 100644 --- a/docs/docdown/deps/util/assign.md +++ b/docs/docdown/deps/util/assign.md @@ -2,10 +2,44 @@ + + +## `util` +* `util.exports` + + + + + +## `util` + + + +

util.exports

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/util/assign.js#L5 "View in source") [Ⓣ][1] + +Function + + +#### @see + +* facebook/react/blob/4b2eac3de7e1dbf5c2dd742fd9989974a83972cb/scripts/babel/transform object assign require.js +* ramda/ramda/blob/master/src/internal/ object assign.js +* lodash/lodash/blob/master/.internal/assign value.js +* Esdiscuss.org/topic/object assign with several source objects +* Developer.mozilla.org/en/docs/web/java script/reference/global objects/object/assign +--- + + + + + - [1]: # "Jump back to the TOC." + [1]: #util "Jump back to the TOC." diff --git a/docs/docdown/deps/util/flatten.md b/docs/docdown/deps/util/flatten.md index a5ab7a0..0e50ae3 100644 --- a/docs/docdown/deps/util/flatten.md +++ b/docs/docdown/deps/util/flatten.md @@ -2,10 +2,56 @@ + + +## `util` +* `util.exports` + + + + + +## `util` + + + +

util.exports(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/util/flatten.js#L20 "View in source") [Ⓣ][1] + +(Function): flatten multi-dimensional arrays in `1` line + + +#### @Since +4.0.0 + +#### Arguments +1. `x=undefined` *(Array|any)[]): array(s)* to flatten + +#### Returns +*(*)*: flattened arrays + +#### Example +```js +flatten([[1], [2]]) +//=> [1, 2] +flatten([[1], 2]) +//=> [1, 2] +flatten(1) +//=> [1] + +``` +--- + + + + + - [1]: # "Jump back to the TOC." + [1]: #util "Jump back to the TOC." diff --git a/docs/docdown/deps/util/from.md b/docs/docdown/deps/util/from.md index 7a92f07..c32336e 100644 --- a/docs/docdown/deps/util/from.md +++ b/docs/docdown/deps/util/from.md @@ -5,7 +5,7 @@ ## `exports` -* `exports` +* `exports` @@ -19,7 +19,9 @@ -

# exports

+

exports

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/util/from.js#L6 "View in source") [Ⓣ][1] unknown diff --git a/docs/docdown/deps/util/index.md b/docs/docdown/deps/util/index.md new file mode 100644 index 0000000..5ac127d --- /dev/null +++ b/docs/docdown/deps/util/index.md @@ -0,0 +1,11 @@ +# index.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/util/keysObjOrArray.md b/docs/docdown/deps/util/keysObjOrArray.md new file mode 100644 index 0000000..4e0ac93 --- /dev/null +++ b/docs/docdown/deps/util/keysObjOrArray.md @@ -0,0 +1,78 @@ +# keysObjOrArray.js API documentation + + + + + +## `keysObjOrArray` +* `keysObjOrArray` + + + + + + + + + +## `keysObjOrArray` + + + +

keysObjOrArray(obj=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/util/keysObjOrArray.js#L27 "View in source") [Ⓣ][1] + +(Function): Creates an array of the own enumerable property names of `object`. +**Note:** Non-object values are coerced to objects. See the +[ES spec](http://ecma-international.org/ecma-262/7.0/#sec-object.keys) +for more details. + + +#### @see + +* fluents/chain able/blob/master/src/deps/util/length from zero.js +* fluents/chain able/blob/master/src/deps/util/props.js +* lodash/lodash/blob/master/keys.js +* lodash/lodash/blob/master/.internal/get all keys.js + +#### @todos + +- [ ] https://github.com/lodash/lodash/blob/master/.internal/arrayLikeKeys.js + + +#### @Since +0.1.0 + +#### Arguments +1. `obj=undefined` *(Object)*: The object to query. + +#### Returns +*(Array)*: Returns the array of property names. + +#### Example +```js +function Foo() { + this.a = 1 + this.b = 2 +} + +Foo.prototype.c = 3 + +keys(new Foo()) +// => ['a', 'b'] (iteration order is not guaranteed) + +keys('hi') +// => ['0', '1'] + +``` +--- + + + + + + + + [1]: #keysobjorarray "Jump back to the TOC." diff --git a/docs/docdown/deps/util/keywords.md b/docs/docdown/deps/util/keywords.md new file mode 100644 index 0000000..eb8e102 --- /dev/null +++ b/docs/docdown/deps/util/keywords.md @@ -0,0 +1,11 @@ +# keywords.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/util/lengthFromZero.md b/docs/docdown/deps/util/lengthFromZero.md new file mode 100644 index 0000000..fc78eca --- /dev/null +++ b/docs/docdown/deps/util/lengthFromZero.md @@ -0,0 +1,69 @@ +# lengthFromZero.js API documentation + + + + + +## `util` +* `util.lengthFromZero` + + + + + + + + + +## `util` + + + +

util.lengthFromZero(obj=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/util/lengthFromZero.js#L28 "View in source") [Ⓣ][1] + +(Function): when length > `1`, use length-1 +otherwise, when length == `1`, use `0` +default, use length + + +#### @see + +* fluents/chain able/blob/master/src/deps/util/length.js +* fluents/chain able/blob/master/src/deps/util/length minus one.js + +#### @todos + +- [ ] lense to use an object, or transform it to one with .length? + const len = prop('length') + // when isObj, use len, otherwise, value + const coerceLength = lense([isObj, len]) + + +#### @Since +5.0.0-beta.2 + +#### Arguments +1. `obj=undefined` *(Array|Object|number)*: with length + +#### Returns +*(number)*: obj length from `0` + +#### Example +```js +lengthFromZero([1]) //=> 1 +lengthFromZero([]) //=> 0 +lengthFromZero([1, 2, 3]) //=> 2 + +``` +--- + + + + + + + + [1]: #util "Jump back to the TOC." diff --git a/docs/docdown/deps/util/localGlobal.md b/docs/docdown/deps/util/localGlobal.md new file mode 100644 index 0000000..03b9580 --- /dev/null +++ b/docs/docdown/deps/util/localGlobal.md @@ -0,0 +1,11 @@ +# localGlobal.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/deps/util/noop.md b/docs/docdown/deps/util/noop.md new file mode 100644 index 0000000..0ca4009 --- /dev/null +++ b/docs/docdown/deps/util/noop.md @@ -0,0 +1,58 @@ +# noop.js API documentation + + + + + +## `noop` +* `noop` + + + + + + + + + +## `noop` + + + +

noop()

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/util/noop.js#L17 "View in source") [Ⓣ][1] + +Function + + +#### @see + +* sindresorhus/noop3 + +#### @Since +5.0.0 + +#### Returns +*(void)*: + +#### Example +```js +noop + +``` +#### Example +```js +noop() + +``` +--- + + + + + + + + [1]: #noop "Jump back to the TOC." diff --git a/docs/docdown/deps/util/props.md b/docs/docdown/deps/util/props.md index b92ba6e..c675699 100644 --- a/docs/docdown/deps/util/props.md +++ b/docs/docdown/deps/util/props.md @@ -5,7 +5,7 @@ ## `allProperties` -* `allProperties` +* `allProperties` @@ -19,16 +19,35 @@ -

# allProperties(obj=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/util/props.js#L30 "View in source") [Ⓣ][1] +

allProperties(obj=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/util/props.js#L38 "View in source") [Ⓣ][1] (Function): properties, property symbols, object keys ^ all again for prototype + +#### @see + +* fluents/chain able/blob/master/src/deps/gc.js + +#### @todos + +- [ ] https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/getOwnPropertyDescriptors +`const getOwnPropertyDescriptors = Object.getOwnPropertyDescriptors` + + +#### @Since +3.0.0 + #### Arguments 1. `obj=undefined` *(Object)*: object to get properties & symbols from #### Returns *(*)*: properties +
+
+only used in gc *(as of 5.0.0-beta.4)* #### Example ```js diff --git a/docs/docdown/deps/util/simpleKindOf.md b/docs/docdown/deps/util/simpleKindOf.md index 60f3240..6c988fe 100644 --- a/docs/docdown/deps/util/simpleKindOf.md +++ b/docs/docdown/deps/util/simpleKindOf.md @@ -5,7 +5,7 @@ ## `exports` -* `exports` +* `exports` @@ -19,17 +19,38 @@ -

# exports(x=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/util/simpleKindOf.js#L12 "View in source") [Ⓣ][1] +

exports(x=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/util/simpleKindOf.js#L24 "View in source") [Ⓣ][1] (Function): when Array -> 'array' when null -> 'null' else `typeof x` + +#### @todos + +- [ ] `type.split(' ').pop().replace(/\s\[\]/g, '').toLowerCase()` + + +#### @Since +4.0.0 + #### Arguments -1. `x=undefined` *(any)*: +1. `x=undefined` *(any)*: value for type #### Returns *(string)*: type +
+
+split at space, replace brackets and space, lowercase + +#### Example +```js +simpleKindOf([]) //=> 'array' +simpleKindOf(null) //=> 'null' +simpleKindOf({}) //=> 'object' +``` --- diff --git a/docs/docdown/deps/util/util.md b/docs/docdown/deps/util/util.md new file mode 100644 index 0000000..5920e90 --- /dev/null +++ b/docs/docdown/deps/util/util.md @@ -0,0 +1,37 @@ +# util.js API documentation + + + + + +## `util.exports` +* `util.exports` + + + + + + + + + +## `util.exports` + + + +

util.exports

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/util/util.js#L25 "View in source") [Ⓣ][1] + +Object + +--- + + + + + + + + [1]: #util.exports "Jump back to the TOC." diff --git a/docs/docdown/deps/validators/error.md b/docs/docdown/deps/validators/error.md index 436e68d..4b3bf0f 100644 --- a/docs/docdown/deps/validators/error.md +++ b/docs/docdown/deps/validators/error.md @@ -4,8 +4,8 @@ -## `encase.prototype` -* `encase.prototype.exports` +## `encase` +* `encase.exports` @@ -15,28 +15,31 @@ -## `encase.prototype` +## `encase` -

# encase.prototype.exports(method=undefined, type=undefined)

+

encase.exports(method=undefined, type=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/validators/error.js#L54 "View in source") [Ⓣ][1] (Function): enhance an Error, enable rethrowing & better inspection -### @see +#### @see -* fluents/chain able/blob/master/src/method chain.js -* fluents/chain able/blob/master/src/deps/validators/schema builder.js -* fluents/chain able/blob/master/src/deps/validators/validator builder.js -* fluents/chain able/blob/master/src/plugins/encase.js +* fluents/chain able/blob/master/src/method chain.js +* fluents/chain able/blob/master/src/deps/validators/schema builder.js +* fluents/chain able/blob/master/src/deps/validators/validator builder.js +* fluents/chain able/blob/master/src/plugins/encase.js -### @todos +#### @todos - [ ] js stringify if development -#### Since + +#### @Since 4.0.0-alpha.1 #### Arguments @@ -77,4 +80,4 @@ console.log(error) - [1]: #encase.prototype "Jump back to the TOC." + [1]: #encase "Jump back to the TOC." diff --git a/docs/docdown/deps/validators/schemaBuilder.md b/docs/docdown/deps/validators/schemaBuilder.md index 7ac5ed7..6e53353 100644 --- a/docs/docdown/deps/validators/schemaBuilder.md +++ b/docs/docdown/deps/validators/schemaBuilder.md @@ -4,15 +4,15 @@ -## `schema.prototype` -* `schema.prototype.typeValidator` +## `schema` +* `schema.typeValidator` ## `schemaFactory` -* `schemaFactory` +* `schemaFactory` @@ -22,24 +22,27 @@ -## `schema.prototype` +## `schema` -

# schema.prototype.typeValidator(input=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/validators/schemaBuilder.js#L102 "View in source") [Ⓣ][1] +

schema.typeValidator(input=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/validators/schemaBuilder.js#L91 "View in source") [Ⓣ][1] (Function): build a recursive schema for all around runtime type safety -### @see +#### @see -* fluents/chain able/blob/master/src/deps/is/array.js +* fluents/chain able/blob/master/src/deps/expressions/bitwise math operator.js -### @symb +#### @symb 🛂 -#### Since + +#### @Since 4.0.0-beta.1 #### Arguments @@ -89,12 +92,15 @@ var isValid = typeValidator(1) -

# schemaFactory(property=undefined, nestedSchema=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/validators/schemaBuilder.js#L60 "View in source") [Ⓣ][1] +

schemaFactory(property=undefined, nestedSchema=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/validators/schemaBuilder.js#L49 "View in source") [Ⓣ][1] (Function): pass the property & schema in, get a nestable typeValidator out -#### Since + +#### @Since 4.0.0-alpha.1 #### Arguments @@ -139,4 +145,4 @@ input = { - [1]: #schema.prototype "Jump back to the TOC." + [1]: #schema "Jump back to the TOC." diff --git a/docs/docdown/deps/validators/validatorBuilder.md b/docs/docdown/deps/validators/validatorBuilder.md index 008d2f8..1870fbe 100644 --- a/docs/docdown/deps/validators/validatorBuilder.md +++ b/docs/docdown/deps/validators/validatorBuilder.md @@ -5,35 +5,35 @@ ## `ChainedMap` -* `ChainedMap` +* `ChainedMap` ## `addTypes` -* `addTypes` +* `addTypes` ## `arithmeticTypeFactory` -* `arithmeticTypeFactory` +* `arithmeticTypeFactory` ## `builder` -* `builder` +* `builder` -## `schema.prototype` -* `schema.prototype.typeListFactory` +## `schema` +* `schema.typeListFactory` @@ -47,7 +47,9 @@ -

# ChainedMap(validators=undefined)

+

ChainedMap(validators=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/validators/validatorBuilder.js#L8 "View in source") [Ⓣ][1] (Function): library of validators to use by name @@ -69,8 +71,10 @@ 🌊 Types: schema.d  -

# addTypes(types=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/validators/validatorBuilder.js#L75 "View in source") [Ⓣ][1] +

addTypes(types=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/validators/validatorBuilder.js#L74 "View in source") [Ⓣ][1] (Function): add custom types for validation @@ -116,17 +120,20 @@ new Chain().methods('eh').type('*').build().eh 🌊 Types: schema.d  -

# arithmeticTypeFactory(fullKey=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/validators/validatorBuilder.js#L182 "View in source") [Ⓣ][1] +

arithmeticTypeFactory(fullKey=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/validators/validatorBuilder.js#L172 "View in source") [Ⓣ][1] (Function): transform arithmetic strings into types -### @todos +#### @todos - [ ] coercing values to certain types: arithmeticTypeFactory('') -#### Since + +#### @Since 4.0.0-alpha.1 #### Arguments @@ -178,18 +185,21 @@ arithmeticTypeFactory('===') -

# builder(fullKey=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/validators/validatorBuilder.js#L247 "View in source") [Ⓣ][1] +

builder(fullKey=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/validators/validatorBuilder.js#L237 "View in source") [Ⓣ][1] (Function): @pattern @builder -> builds using multiple factories depending on conditons or abstractFactory whatever opinionated: if it's a function, it's a validator... -### @notes +#### @notes * if/else is for uglifying ternaries, even though else if is not needed * if key is number, iterating the array -#### Since + +#### @Since 4.0.0 #### Arguments @@ -231,12 +241,14 @@ builder('string|string[]') -## `schema.prototype` +## `schema` -

# schema.prototype.typeListFactory(fullKey=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/validators/validatorBuilder.js#L110 "View in source") [Ⓣ][1] +

schema.typeListFactory(fullKey=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/deps/validators/validatorBuilder.js#L100 "View in source") [Ⓣ][1] Function diff --git a/docs/docdown/dists/dev/index.md b/docs/docdown/dists/dev/index.md deleted file mode 100644 index 47b12e4..0000000 --- a/docs/docdown/dists/dev/index.md +++ /dev/null @@ -1,7812 +0,0 @@ -# index.js API documentation - - - - - -## `/* istanbul ignore next` -* `/* istanbul ignore next` - - - - - -## `CM` -* `CM` - - - - - -## `Chainable.prototype` -* `Chainable.prototype.Chainable` - - - - - -## `ChainedMapBase.prototype` -* `ChainedMapBase.prototype.CMC` -* `ChainedMapBase.prototype.compose` -* `ChainedMapBase.prototype.entries` -* `ChainedMapBase.prototype.extend` -* `ChainedMapBase.prototype.from` -* `ChainedMapBase.prototype.get` -* `ChainedMapBase.prototype.set` -* `ChainedMapBase.prototype.tap` - - - - - -## `ChainedSet` -* `ChainedSet` - - - - - -## `DotProp.prototype` -* `DotProp.prototype.get` -* `DotProp.prototype.set` - - - - - -## `FactoryChain.prototype` -* `FactoryChain.prototype.FactoryChain` -* `FactoryChain.prototype.chainUpDowns` -* `FactoryChain.prototype.factory` -* `FactoryChain.prototype.getData` -* `FactoryChain.prototype.prop` -* `FactoryChain.prototype.props` - - - - - -## `MergeChain.prototype` -* `MergeChain.prototype.MergeChain` -* `MergeChain.prototype.init` -* `MergeChain.prototype.onExisting` - - - - - -## `MethodChain.prototype` -* `MethodChain.prototype.MethodChain` -* `MethodChain.prototype._build` -* `MethodChain.prototype._defaults` -* `MethodChain.prototype.autoGetSet` -* `MethodChain.prototype.autoIncrement` -* `MethodChain.prototype.build` -* `MethodChain.prototype.decorate` -* `MethodChain.prototype.decorate` -* `MethodChain.prototype.name` -* `MethodChain.prototype.schema` - - - - - -## `Observe.prototype` -* `Observe.prototype.` -* `Observe.prototype.DotProp` -* `Observe.prototype.Observe` - - - - - -## `ShorthandChain.prototype` -* `ShorthandChain.prototype.return` -* `ShorthandChain.prototype.setIfEmpty` -* `ShorthandChain.prototype.wrap` - - - - - -## `Transform` -* `Transform` - - - - - -## `TransformChain.prototype` -* `TransformChain.prototype.` -* `TransformChain.prototype.remap` -* `TransformChain.prototype.set` -* `TransformChain.prototype.transform` - - - - - -## `Traverse.prototype` -* `Traverse.prototype.` -* `Traverse.prototype.` -* `Traverse.prototype.TraverseChain` -* `Traverse.prototype.clone` -* `Traverse.prototype.forEach` -* `Traverse.prototype.get` -* `Traverse.prototype.has` -* `Traverse.prototype.nodes` -* `Traverse.prototype.paths` -* `Traverse.prototype.reduce` -* `Traverse.prototype.set` - - - - - -## `TraverseChain.prototype` -* `TraverseChain.prototype.traverse` - - - - - -## `add` -* `add` -* `add` - - - - - -## `addTypes` -* `addTypes` - - - - - -## `after` -* `after` - - - - - -## `alias` -* `alias` - - - - - -## `allProperties` -* `allProperties` - - - - - -## `anyKeyVal` -* `anyKeyVal` - - - - - -## `argumentor` -* `argumentor` - - - - - -## `arithmeticTypeFactory` -* `arithmeticTypeFactory` - - - - - -## `autoIncrement` -* `autoIncrement` - - - - - -## `before` -* `before` - - - - - -## `block` -* `block` - - - - - -## `builder` -* `builder` - - - - - -## `camelCase` -* `camelCase` - - - - - -## `circular` -* `circular` - - - - - -## `clear` -* `clear` - - - - - -## `compose.prototype` -* `compose.prototype.compose` - - - - - -## `conditional.prototype` -* `conditional.prototype.all` -* `conditional.prototype.and` -* `conditional.prototype.not` -* `conditional.prototype.or` - - - - - -## `debug` -* `debug` - - - - - -## `define` -* `define` -* `define` - - - - - -## `delete` -* `delete` -* `delete` -* `delete` - - - - - -## `dopemerge.prototype` -* `dopemerge.prototype.cloneIfNeeded` -* `dopemerge.prototype.defaultArrayMerge` -* `dopemerge.prototype.dopemerge` -* `dopemerge.prototype.emptyTarget` -* `dopemerge.prototype.isMergeableObj` - - - - - -## `dot` -* `dot` - - - - - -## `encase` -* `encase` - - - - - -## `encase.prototype` -* `encase.prototype.error$3` - - - - - -## `end` -* `end` - - - - - -## `entries` -* `entries` - - - - - -## `fn.call` -* `fn.call` - - - - - -## `forEach` -* `forEach` -* `forEach` - - - - - -## `from` -* `from` - - - - - -## `get` -* `get` - - - - - -## `getMeta` -* `getMeta` - - - - - -## `handleExisting` -* `handleExisting` - - - - - -## `has` -* `has` -* `has` -* `has` - - - - - -## `if` -* `if` -* `if` -* `if` -* `if` -* `if` - - - - - -## `index` -* `` -* `` -* `` -* `` -* `` -* `` -* `` -* `` - - - - - -## `is.prototype` -* `is.prototype.isBoolean` -* `is.prototype.isDate` -* `is.prototype.isError` -* `is.prototype.isFalse` -* `is.prototype.isFunction` -* `is.prototype.isIterator` -* `is.prototype.isMap` -* `is.prototype.isMapish` -* `is.prototype.isMatcher` -* `is.prototype.isNotEmptyArray` -* `is.prototype.isNull` -* `is.prototype.isNullOrUndefined` -* `is.prototype.isNumber` -* `is.prototype.isObj` -* `is.prototype.isObjLoose` -* `is.prototype.isObjStrict` -* `is.prototype.isObjWithKeys` -* `is.prototype.isReal` -* `is.prototype.isTrue` -* `is.prototype.isUndefined` -* `is.prototype.string` -* `is.prototype.stringOrNumber` -* `is.prototype.stringPrimitive` -* `is.prototype.symbol` -* `is.prototype.toS` - - - - - -## `is.prototype.index$12` -* `is.prototype.index$12` - - - - - -## `isArray` -* `isArray` - - - - - -## `isRoot` -* `isRoot` - - - - - -## `key` -* `key` - - - - - -## `level` -* `level` - - - - - -## `m` -* `m` - - - - - -## `markForGarbageCollection` -* `markForGarbageCollection` - - - - - -## `matcher.prototype` -* `matcher.prototype.escapeStringRegExp` -* `matcher.prototype.make` -* `matcher.prototype.match` -* `matcher.prototype.matcher` -* `matcher.prototype.toRegExp` - - - - - -## `merge` -* `merge` -* `merge` -* `merge` - - - - - -## `meta` -* `meta` - - - - - -## `method` -* `method` - - - - - -## `methodEncasingFactory` -* `methodEncasingFactory` - - - - - -## `node` -* `node` - - - - - -## `node_` -* `node_` - - - - - -## `objs` -* `objs` - - - - - -## `objs.set` -* `objs.set` - - - - - -## `parent` -* `parent` - - - - - -## `path` -* `path` - - - - - -## `paths` -* `paths` - - - - - -## `post` -* `post` - - - - - -## `pre` -* `pre` - - - - - -## `prepend` -* `prepend` - - - - - -## `prototype[iterator]` -* `prototype[iterator]` - - - - - -## `prototype[primitive]` -* `prototype[primitive]` - - - - - -## `reduce` -* `reduce` - - - - - -## `reduce.prototype` -* `reduce.prototype.clean` - - - - - -## `regexp` -* `regexp` - - - - - -## `remove` -* `remove` - - - - - -## `return` -* `return` - - - - - -## `schema` -* `schema` - - - - - -## `schema.prototype` -* `schema.prototype.typeListFactory` -* `schema.prototype.typeValidator` - - - - - -## `schemaFactory` -* `schemaFactory` - - - - - -## `scopedEncase` -* `scopedEncase` - - - - - -## `set` -* `set` - - - - - -## `set$$2` -* `set$$2` - - - - - -## `setChosen` -* `setChosen` -* `setChosen` - - - - - -## `simpleKindOf` -* `simpleKindOf` - - - - - -## `state` -* `state` - - - - - -## `stop` -* `stop` - - - - - -## `test` -* `test` - - - - - -## `this.extend` -* `this.extend` - - - - - -## `toArr` -* `toArr` - - - - - -## `toTest` -* `toTest` - - - - - -## `traverse` -* `traverse` -* `traverse` - - - - - -## `traverse.prototype` -* `traverse.prototype.eq` - - - - - -## `traversed` -* `traversed` - - - - - -## `tryCatch` -* `tryCatch` - - - - - -## `typedOnCall` -* `typedOnCall` - - - - - -## `types` -* `types` - - - - - -## `update` -* `update` - - - - - -## `updateState` -* `updateState` - - - - - -## `validators` -* `validators` - - - - - -## `values` -* `values` - - - - - -## `when` -* `when` - - - - - -## `while` -* `while` - - - - - - - - - -## `/* istanbul ignore next` - - - -

# /* istanbul ignore next

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4875 "View in source") [Ⓣ][1] - -unknown - ---- - - - - - - - -## `CM` - - - -* 🌊 Types: ChainedMap.d  -* 🌊 Types: ChainedMapBase.d  - -🔬 Tests: ChainedMap  - -

# CM()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5479 "View in source") [Ⓣ][1] - -(Function): ChainedMap composer - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @extends -ChainedMapBase - - -#### Since -0.0.1 - -#### Returns -*(Class)*: ChainedMap - -#### Example -```js -const heh = class {} -const composed = ChainedMap.compose(heh) -const hehchain = new Composed() -hehchain instanceof heh -//=> true - -``` ---- - - - - - - - -## `Chainable.prototype` - - - -🌊 Types: Chainable.d  - -🔬 Tests: Chainable  - -

# Chainable.prototype.Chainable

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L336 "View in source") [Ⓣ][1] - -(Chainable): Trait class that can inherit any class passed into compose, extended by ChainedMap & ChainedSet - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @classProps - -* {parent} -* {className} {@link https://github.com/iluwatar/java-design-patterns/tree/master/chain chain-pattern} - ---- - - - - - - - -## `ChainedMapBase.prototype` - - - -🌊 Types: ChainedMapBase.d  - -🔬 Tests: ChainedMap  - -

# ChainedMapBase.prototype.CMC

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1726 "View in source") [Ⓣ][1] - -(Chainable): this is to avoid circular requires -because MergeChain & MethodChain extend this -yet .method & .merge use those chains - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @classProps - -* {meta} meta fn -* {store} main store - -{@link https://ponyfoo.com/articles/es6-maps-in-depth pony-map} -{@link https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Map mozilla-map} - - -### @extends -Chainable - - -#### Since -4.0.0-alpha.1 - ---- - - - - - -

# ChainedMapBase.prototype.cmc()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1972 "View in source") [Ⓣ][1] - -(Composer): ChainedMapBase composer - -#### Returns -*(Class)*: ChainedMapBase - -#### Example -```js -const heh = class {} -const composed = ChainedMapBase.compose(heh) -const hehchain = new Composed() -hehchain instanceof heh -//=> true - -``` ---- - - - - - -

# ChainedMapBase.prototype.entries()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1879 "View in source") [Ⓣ][1] - -(Function): spreads the entries from ChainedMapBase.store *(Map)* return store.entries, plus all chain properties if they exist - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -0.4.0 - -#### Returns -*(Object)*: reduced object containing all properties from the store, and when `chains` is true, all instance properties, and recursive chains -
-
-// -
-
-{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/entries mozilla-map-entries} - -#### Example -```js -map.set('a', 'alpha').set('b', 'beta').entries() -//=> {a: 'alpha', b: 'beta'} - -``` ---- - - - - - -

# ChainedMapBase.prototype.extend()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1847 "View in source") [Ⓣ][1] - -(Function): shorthand methods, from strings to functions that call .set - -#### Since -0.4.0 - -#### Returns -*(ChainedMapBase)*: @chainable - -#### Example -```js -const chain1 = new Chain() -chain1.extend(['eh']) - -const chain2 = new Chain() -chain2.eh = val => this.set('eh', val) - -eq(chain2.eh, chain1.eh) -//=> true - -``` ---- - - - - - -

# ChainedMapBase.prototype.from()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1803 "View in source") [Ⓣ][1] - -(Function): checks each property of the object calls the chains accordingly - - -### @todos - -- [ ] could also add parsing stringified - -#### Since -0.5.0 - -#### Returns -*(Chainable)*: @chainable - -#### Example -```js -const from = new Chain().from({ eh: true }) -const eh = new Chain().set('eh', true) -eq(from, eh) -// => true - -``` ---- - - - - - -

# ChainedMapBase.prototype.get()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1915 "View in source") [Ⓣ][1] - -(Function): get value for key path in the Map store ❗ `debug` is a special key and is *not* included into .store it goes onto .meta - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -0.4.0 - -#### Returns -*(any)*: value in .store at key -
-
-{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/get mozilla-map-get} - -#### Example -```js -const chain = new Chain() -chain.set('eh', true) -chain.get('eh') -//=> true - -chain.get('nope') -//=> undefined - -``` ---- - - - - - -

# ChainedMapBase.prototype.set()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1944 "View in source") [Ⓣ][1] - -(Function): sets the value using the key on store adds or updates an element with a specified key and value - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -0.4.0 - -#### Returns -*(ChainedMapBase)*: @chainable -
-
-{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/set mozilla-map-set} - -#### Example -```js -const chain = new Chain() -chain.set('eh', true) -chain.get('eh') -//=> true - -``` ---- - - - - - -

# ChainedMapBase.prototype.tap()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1779 "View in source") [Ⓣ][1] - -(Function): tap a value with a function - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -4.0.0-alpha.1 <- moved from transform & shorthands - -#### Returns -*(Chain)*: @chainable -
-
-{@link https://github.com/sindresorhus/awesome-tap awesome-tap} -{@link https://github.com/midknight41/map-factory map-factory} -{@link https://github.com/webpack/tapable tapable} - -#### Example -```js -chain - .set('moose', { eh: true }) - .tap('moose', moose => { - moose.eh = false - return moose - }) - .get('moose') - -// => {eh: false} - -``` -#### Example -```js -const entries = new Chain() - .set('str', 'emptyish') - .tap('str', str => str + '+') - .set('arr', [1]) - .tap('arr', arr => arr.concat([2])) - .entries() - -//=> {str: 'emptyish+', arr: [1, 2]} - -``` ---- - - - - - - - -## `ChainedSet` - - - -🌊 Types: ChainedSet.d  - -🔬 Tests: ChainedSet  - -

# ChainedSet

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5593 "View in source") [Ⓣ][1] - -Set - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @notes - -* had Symbol.isConcatSpreadable but it was not useful - - -### @todos - -- [ ] could add .first .last ? - - -### @classProps - -* {store} - - -### @extends -Chainable - - ---- - - - - - - - -## `DotProp.prototype` - - - -

# DotProp.prototype.get()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7478 "View in source") [Ⓣ][1] - -(Function): dot-prop enabled get - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @todos - -- [ ] dot-prop on non-store instance.property when using nested chains... - -#### Since -3.0.1 - -#### Returns -*(any)*: value for path, or fallback value if provided - -#### Example -```js -chain.set('moose.simple', 1) -//=> Chain - -chain.get('moose.simple') -//=>1 - -chain.get('moose') -//=> {simple: 1} - -``` -#### Example -```js -//also works with an array (moose.simple) -chain.get(['moose', 'simple']) -//=> 1 - -``` ---- - - - - - -

# DotProp.prototype.set

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7420 "View in source") [Ⓣ][1] - -unknown - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -3.0.1 - -#### Example -```js -const chain = new Target() - -chain.set('moose.simple', 1) -//=> Target store:Map: { moose: { simple: 1 } } - -``` ---- - - - - - - - -## `FactoryChain.prototype` - - - -🌊 Types: FactoryChain.d  - -🔬 Tests: FactoryChain  - -

# FactoryChain.prototype.FactoryChain

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5697 "View in source") [Ⓣ][1] - -Map - - -### @classProps - -* {data} -* {_calls} - - -### @extends -ChainedMapBase - - ---- - - - - - -

# FactoryChain.prototype.chainUpDowns()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5758 "View in source") [Ⓣ][1] - -(Function): chain back up to parent for any of these - - -### @todos - -- [ ] should have a debug log for this - -#### Since -2.0.0 - -#### Returns -*(FactoryChain)*: @chainable - -#### Example -```js -const { Chain, FactoryChain, ChainedSet } = require('chain-able') - -class Things extends Chain { - constructor(parent) { - super(parent) - this.people = new ChainedSet(this) - } - person() { - const person = new FactoryChain(this) - person - .props(['name', 'age', 'email']) - .onChainUpDown(this.person) - .chainUpDowns(['person']) - .onDone(personChain => { - this.people.add(personChain) - return this - }) - - return person - } -} - -const things = new Things() -const returned = things - .person() - .name('sue') - .person() - .age(100) - .name('john') - .email('@') - -``` ---- - - - - - -

# FactoryChain.prototype.factory()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5908 "View in source") [Ⓣ][1] - -(Function): creates/add the `.end` method, which checks how many methods have been called, and decides whether to return parent or not - -#### Since -2.0.0 - -#### Returns -*(FactoryChain)*: @chainable - ---- - - - - - -

# FactoryChain.prototype.getData()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5889 "View in source") [Ⓣ][1] - -(Function): access data being built when stepping through a factory - -#### Since -2.0.0 - -#### Returns -*(any)*: this.data - -#### Example -```js -.data['prop'] = 'eh' - .getData('prop') - //=> 'eh' - .getData() - //=> {prop: 'eh'} -``` -#### Example -```js -const person = new FactoryChain(this) -const age = person.props(['name', 'age']).age(10).getData('age') -expect(age).toBe(10) - -``` ---- - - - - - -

# FactoryChain.prototype.prop()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5829 "View in source") [Ⓣ][1] - -(Function): add property that are counted towards the call count for easy auto-ending chaining - -#### Since -2.0.0 - -#### Returns -*(FactoryChain)*: @chainable - -#### Example -```js -person - //.prop also accepts an optional callback, - //for nestable nestable chains - .prop('name') - .prop('age') - .prop('email') - -``` ---- - - - - - -

# FactoryChain.prototype.props()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5801 "View in source") [Ⓣ][1] - -(Function): adds an *array* of properties, using FactoryChain.prop - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -2.0.0 - -#### Returns -*(FactoryChain)*: @chainable - -#### Example -```js -person.props(['name', 'age', 'email']) - -typeof person.name -//=> 'function' - -person.name().age() -//=> FactoryChain - -person.name().age().email() -//=> ParentChain - -// person.name().age().person() -//=> FactoryChain -//^ because .person is `chainUpDowns` -//^ so it finishes the old chain, and begins a new one - -``` ---- - - - - - - - -## `MergeChain.prototype` - - - -🔬 Tests: MergeChain  - -

# MergeChain.prototype.MergeChain

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5162 "View in source") [Ⓣ][1] - -Map - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @todos - -- [ ] consider just making this a function, - because 80/20 onValue merger & onExisting - are rarely used & are easily overridable with .merge - - -### @extends -ChainedMapBase - - -#### Since -1.0.0 - ---- - - - - - -

# MergeChain.prototype.init()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5199 "View in source") [Ⓣ][1] - -(Function): options for merging with dopemerge - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -1.0.2 - -#### Returns -*(MergeChain)*: @chainable - -#### Example -```js -{ - stringToArray: true, - boolToArray: false, - boolAsRight: true, - ignoreTypes: ['null', 'undefined', 'NaN'], - debug: false, - } -``` -#### Example -```js -.merger(require('lodash.mergewith')()) -``` ---- - - - - - -

# MergeChain.prototype.MergeChain_1

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5447 "View in source") [Ⓣ][1] - -unknown - -#### Since -0.9.0 - -#### Example -```js -const { Chain, MergeChain } = require('chain-able') - -const chain = new Chain().set('str', 'stringy') - -MergeChain.init(chain).onExisting((a, b) => a + b).merge({ str: '+' }) - -chain.get('str') -//=> 'stringy+' - -``` ---- - - - - - - - -## `MethodChain.prototype` - - - -🌊 Types: MethodChain.d  - -🔬 Tests: MethodChain  - -

# MethodChain.prototype.MethodChain

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4410 "View in source") [Ⓣ][1] - -(Map): ❗ using `+` will call `.build()` in a shorthand fashion - - -### @todos - -- [ ] maybe abstract the most re-usable core as a protected class - so the shorthands could be used, and more functionality made external -- [ ] need to separate schema from here as external functionality & add .add -- [ ] .prop - for things on the instance, not in the store? - !!! .sponge - absorn properties into the store - - -### @extends -ChainedMap - - -#### Since -4.0.0 - ---- - - - - - -

# MethodChain.prototype._build()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4748 "View in source") [Ⓣ][1] - -Function - - -### @notes - -* scoping here adding default functions have to rescope arguments - - -### @todos - -- [ ] allow config of method var in plugins since it is scoped... -- [ ] add to .meta(shorthands) -- [ ] reduce complexity if perf allows - -#### Since -4.0.0-alpha.1 - -#### Returns -*(void)*: - ---- - - - - - -

# MethodChain.prototype._defaults()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4708 "View in source") [Ⓣ][1] - -Function - - -### @todos - -- [ ] optimize the size of this - with some bitwise operators - hashing the things that have been defaulted - also could be plugin - -#### Since -4.0.0 - -#### Returns -*(void)*: - -#### Example -```js -._defaults('', {}, {}) -``` -#### Example -```js -let methodFactories - - ### `onSet` - - > defaults to `this.set(key, value)` - - ```ts - public onSet(fn: Fn): MethodChain - ``` - - ### `onCall` - - > defaults to .onSet ^ - - ```ts - public onCall(fn: Fn): MethodChain - ``` - - ### `onGet` - - > defaults to `this.get(key)` - - ```ts - public onGet(fn: Fn): MethodChain - ``` -``` ---- - - - - - -

# MethodChain.prototype.autoGetSet()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4183 "View in source") [Ⓣ][1] - -Function - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Returns -*(MethodChain)*: @chainable - -#### Example -```js -const chain = new Chain() -chain.methods('eh').plugin(autoGetSet).build() - -chain.eh(1) -//=> Chain -chain.eh() -//=> 1 - -``` ---- - - - - - -

# MethodChain.prototype.autoIncrement()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5054 "View in source") [Ⓣ][1] - -(Function): adds a plugin to increment the value on every call - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -0.4.0 - -#### Returns -*(MethodChain)*: @chainable - -#### Example -```js -chain.methods(['index']).autoIncrement().build().index().index(+1).index() -chain.get('index') -//=> 3 - -``` ---- - - - - - -

# MethodChain.prototype.build()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4634 "View in source") [Ⓣ][1] - -(Function): set the actual method, also need .context - use .parent - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @todos - -- [ ] if passing in a name that already exists, operations are decorations... (partially done) - -#### Since -4.0.0 - -#### Returns -*(MethodChain)*: @chainable - -#### Example -```js -var obj = {} -const one = new MethodChain(obj).methods('eh').getSet().build(1) -//=> 1 - -typeof obj.getEh -//=> 'function' - -``` ---- - - - - - -

# MethodChain.prototype.decorate()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4128 "View in source") [Ⓣ][1] - -(Function): decorates a parent when the argument is provided -BUT THE FUNCTIONS WILL STILL BE SCOPED TO CURRENT PARENT -for easy factory chaining - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @todos - -- [ ] this is more like a preset since it *adds* plugins? - more of methodFactory now - -#### Since -4.0.0-alpha.1 - -#### Returns -*(MethodChain)*: @chainable - -#### Example -```js -const chain = new Chain() -const obj = {} -chain.method('ehOh').decorate(obj).build() -typeof obj.ehOh -//=> 'function' - -``` ---- - - - - - -

# MethodChain.prototype.decorate()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5023 "View in source") [Ⓣ][1] - -(Function): add methods to the parent for easier chaining - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Returns -*(ChainedMap)*: @chainable - -#### Example -```js -var obj = {} -new MethodChain({}).name('eh').decorate(obj).build() -typeof obj.eh -//=> 'function' - -``` -#### Example -```js -class Decorator extends Chain { - constructor(parent) { - super(parent) - this.methods(['easy']).decorate(parent).build() - this.methods('advanced') - .onCall(this.advanced.bind(this)) - .decorate(parent) - .build() - } - advanced(arg) { - this.set('advanced', arg) - return this.parent - } - easy(arg) { - this.parent.set('easy-peasy', arg) - } -} - -class Master extends Chain { - constructor(parent) { - super(parent) - this.eh = new Decorator(this) - } -} - -const master = new Master() - -master.get('easy-peasy') -//=> true - -master.eh.get('advanced') -//=> 'a+' - -``` -#### Example -```js -;+chain.method('ehOh').decorate(null) -//=> @throws Error('must provide parent argument') - -``` ---- - - - - - -

# MethodChain.prototype.name()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4526 "View in source") [Ⓣ][1] - -(Function): setup methods to build - -#### Returns -*(MethodChain)*: @chainable - -#### Example -```js -var obj = {} -new MethodChain(obj).name('eh').build() -typeof obj.eh -//=> 'function' - -``` ---- - - - - - -

# MethodChain.prototype.schema()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4609 "View in source") [Ⓣ][1] - -(Function): an object that contains nestable `.type`s -they are recursively *(using an optimized traversal cache)* mapped to validators -❗ this method auto-calls .build, all other method config calls should be done before it - - -### @todos - -- [ ] link to `deps/is` docs -- [ ] move out into a plugin to show how easy it is to use a plugin - and make it able to be split out for size when needed -- [ ] inherit properties (in plugin, for each key) - from this for say, dotProp, getSet -- [ ] very @important - that we setup schema validation at the highest root for validation - and then have some demo for how to validate on set using say mobx - observables for all the way down... - -#### Since -4.0.0 - -#### Returns -*(MethodChain)*: @chainable - -#### Example -```js -chain - .methods() - .define() - .getSet() - .onInvalid((error, arg, instance) => console.log(error)) - .schema({ - id: '?number', - users: '?object|array', - topic: '?string[]', - roles: '?array', - creator: { - name: 'string', - email: 'email', - id: 'uuid', - }, - created_at: 'date', - updated_at: 'date|date[]', - summary: 'string', - }) - -//--- valid -chain.created_at = new Date() -chain.setCreatedAt(new Date()) - -isDate(chain.created_at) === true - -//--- nestable validation 👍 -chain.merge({ creator: { name: 'string' } }) - -//--- invalid -chain.updated_at = false - -``` ---- - - - - - - - -## `Observe.prototype` - - - -

# Observe.prototype.observe()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6564 "View in source") [Ⓣ][1] - -(Function): observe properties when they change - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @todos - -- [ ] gotta update `data` if `deleting` too... -- [ ] un-observe -- [ ] should hash these callback properties -- [ ] just throttle the `.set` to allow easier version of .commit - -#### Returns -*(Target)*: @chainable - -#### Example -```js -const Target = require('chain-able') - -const chain = new Target() -const log = arg => console.log(arg) - -chain.extend(['eh']).observe('eh', data => log(data)).eh(true) -//=> {eh: true} - -``` -#### Example -```js -chain - .extend(['canada', 'timbuck']) - .observe(['canad*'], data => console.log(data.canada)) - .canada(true) - .canada(true) - .timbuck(false) - -//=> true -//=> false - -// only called when changed, -// otherwise it would be 2 `true` & 1 `false` - -``` ---- - - - - - -🔬 Tests: DotProp  - -

# Observe.prototype.DotProp()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7367 "View in source") [Ⓣ][1] - -Function - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @extends -ChainedMap - - -#### Returns -*(DotProp)*: class - -#### Example -```js -const { compose } = require('chain-able') -const { DotProp } = compose -new DotProp() -//=> DotProp - -``` -#### Example -```js -const chain = new Chain() - -chain.set('moose.simple', 1) -//=> Chain - -chain.get('moose.simple') -//=>1 - -chain.get('moose') -//=> {simple: 1} - -chain.set('moose.canada.eh', true).set('moose.canada.igloo', true) -//=> Chain - -//set, has, get, delete :-) -chain.delete('moose.canada.eh') -//=> Chain - -//also works with an array (moose.canada.igloo) -chain.get(['moose', 'canada', 'igloo']) -//=> true - -``` ---- - - - - - -🔬 Tests: observe  - -

# Observe.prototype.Observe()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6508 "View in source") [Ⓣ][1] - -(Function): > subscribe to changes ❗ called only on **change** observers are only called when data they subscribe to changes - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @extends - -* ChainedMap -* DotProp - - -#### Since -3.0.1 - -#### Returns -*(Observe)*: class - -#### Example -```js -const { compose } = require('chain-able') -const { DotProp } = compose -new DotProp() -//=> DotProp - -``` ---- - - - - - - - -## `ShorthandChain.prototype` - - - -

# ShorthandChain.prototype.return()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6790 "View in source") [Ⓣ][1] - -(Function): returns any value passed in return a value at the end of a chain regardless - -#### Since -3.0.0 - -#### Returns -*(any)*: value - -#### Example -```js -const chain = new Chain() - -const saveAndDebug = env => - chain.from({ env: env.NODE_ENV }).return(JSON.stringify(env)) - -console.log(saveAndDebug(process.env)) -//=> value of process.env - -``` ---- - - - - - -

# ShorthandChain.prototype.setIfEmpty()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6764 "View in source") [Ⓣ][1] - -(Function): sets a value **only** when .has is false aka set if the value has not been set - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -1.0.2 - -#### Returns -*(ShorthandChain)*: @chainable - -#### Example -```js -const chain = new Chain() - -chain.set('eh', true) - -// eh is already set ^, ignored -chain.setIfEmpty('eh', false) - -chain.get('eh') -//=> true - -``` -#### Example -```js -new Chain().setIfEmpty('canada', true).entries() -//=> {canada: true} - -``` -#### Example -```js -// longhand way to do the same thing -if (chain.has('eh') === false) { - chain.set('eh', false) -} - -// or using .when -chain.when(!chain.has('eh'), instance => instance.set('eh', false)) - -``` ---- - - - - - -

# ShorthandChain.prototype.wrap()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6823 "View in source") [Ⓣ][1] - -(Function): wrap a value, if it's a Function call it, return this aka execute something and return this - -#### Since -2.0.0 - -#### Returns -*(ShorthandChain)*: @chainable - -#### Example -```js -const { eh } = chain.wrap(chain => (chain.eh = true)) -//=> true - -``` -#### Example -```js -new Chain() - .wrap( - encased => - (encased.fn = arg => { - throw new Error('encased yo') - }) - ) - .method('fn') - .encase() - .catch(error => { - //=> Error('encasedYo') - }) - .build() - .fn(true) - -``` ---- - - - - - - - -## `Transform` - - - -

# Transform()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7089 "View in source") [Ⓣ][1] - -Function - -#### Returns -*(TransformChain)*: class - -#### Example -```js -compose(class {}) -//=> TransformChain - -``` ---- - - - - - - - -## `TransformChain.prototype` - - - -🔬 Tests: TransformChain  - -

# TransformChain.prototype.

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7111 "View in source") [Ⓣ][1] - -Map - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @symb - -🤖 - -### @extends -ChainedMap - - ---- - - - - - -

# TransformChain.prototype.remap()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7258 "View in source") [Ⓣ][1] - -(Function): remap properties from `1` to another, for example, apis with inconsistent naming - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @symb - -🗺 -#### Since -1.0.0 - -#### Returns -*(Chain)*: @chainable - -#### Example -```js -chain.remap('dis', 'dat').from({ dis: true }) - -chain.entries() -//=> {dat: true} - -``` -#### Example -```js -chain - .remap({dis: 'dat'}) - .from({dis: 1, other: true}} - - chain.entries() - //=> {dist: 1, other: true} -``` ---- - - - - - -

# TransformChain.prototype.set()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7197 "View in source") [Ⓣ][1] - -Function - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -1.0.0 - -#### Returns -*(Chainable)*: @chainable - ---- - - - - - -

# TransformChain.prototype.transform()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7179 "View in source") [Ⓣ][1] - -Function - - -### @todos - -- [ ] dot-prop here - -#### Since -1.0.2 - -#### Returns -*(TransformChain)*: @chainable - -#### Example -```js -// coerce values with .id into the value they hold -chain.transform('dis', val => (typeof val === 'string' ? val : val.id)) - -chain.set('dis', 'eh') -chain.get('dis') -//=> 'eh' - -chain.set('dis', { id: 'eh' }) -chain.get('dis') -//=> 'eh' - -``` -#### Example -```js -import { format } from 'date-fns/esm' -import { Chain } from 'chain-able' - -const chain = new Chain() -chain.transform('created_at', date => format(date, 'MM/DD/YYYY')) -chain.set('created_at', new Date()) - -// is formatted human-readable pretty! -const { created_at } = chain.entries() -//=> '02/11/2014' - -``` ---- - - - - - - - -## `Traverse.prototype` - - - -* 🌊 Types: TraverseChain.d  -* 🌊 Types: traverse.d  - -* 🔬 Tests: circular  -* 🔬 Tests: date  -* 🔬 Tests: equal  -* 🔬 Tests: error  -* 🔬 Tests: has  -* 🔬 Tests: index  -* 🔬 Tests: instance  -* 🔬 Tests: interface  -* 🔬 Tests: json  -* 🔬 Tests: keys  -* 🔬 Tests: leaves  -* 🔬 Tests: negative  -* 🔬 Tests: obj  -* 🔬 Tests: set-map  -* 🔬 Tests: siblings  -* 🔬 Tests: stop  -* 🔬 Tests: stringify  -* 🔬 Tests: subexpr  -* 🔬 Tests: superDeep  - -

# Traverse.prototype.Traverse()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2211 "View in source") [Ⓣ][1] - -Function - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @todos - -- [ ] : symbol, map, set - - -### @classProps - -* {value} the data passed in as an argument to traverse on - -#### Example -```js -traverse({}) -//=> Traverser - -``` ---- - - - - - -

# Traverse.prototype.map()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2319 "View in source") [Ⓣ][1] - -(Function): Execute fn for each node in the object and return a new object with the results of the walk. To update nodes in the result use this.update(value). - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Returns -*(any)*: - -#### Example -```js -var { traverse } = require('chain-able') - -var obj = { a: 1, b: 2, c: [3, 4] } -obj.c.push(obj) - -var scrubbed = traverse(obj).map(function(x) { - if (this.circular) this.remove() -}) -console.dir(scrubbed) -//=> { a: 1, b: 2, c: [ 3, 4 ] } - -``` ---- - - - - - -🌊 Types: TraverseChain.d  - -🔬 Tests: TraverseChain  - -

# Traverse.prototype.TraverseChain

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6931 "View in source") [Ⓣ][1] - -Map - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @symb - -👣 - -### @classProps - -* {obj} -* {keys} -* {vals} -* {onMatch} -* {onNonMatch} -* {clone} - - -### @extends -ChainedMapBase - - -#### Since -1.0.0 - ---- - - - - - -

# Traverse.prototype.clone()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2439 "View in source") [Ⓣ][1] - -(Function): Create a deep clone of the object. - -#### Returns -*(any)*: - -#### Example -```js -const { traverse, eq } = require('chain-able') - -const obj = { eh: true, canada: [1] } -const cloned = traverse(obj).clone() -cloned.eh = false -eq(cloned, obj) -//=> false - -``` ---- - - - - - -

# Traverse.prototype.forEach()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2346 "View in source") [Ⓣ][1] - -(Function): Execute fn for each node in the object but unlike .map(), when this.update() is called it updates the object in-place. executes a provided function once for each traversed element. - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Returns -*(any)*: this.value - -#### Example -```js -var { traverse } = require('chain-able') - -var obj = [5, 6, -3, [7, 8, -2, 1], { f: 10, g: -13 }] -traverse(obj).forEach(function(x) { - if (x < 0) this.update(x + 128) -}) - -console.dir(obj) -//=> [ 5, 6, 125, [ 7, 8, 126, 1 ], { f: 10, g: 115 } ] - -``` ---- - - - - - -

# Traverse.prototype.get()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2225 "View in source") [Ⓣ][1] - -(Function): Get the element at the array path. - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @todos - -- [ ] hasOwnProperty - -#### Returns -*(any)*: value at dot-prop - ---- - - - - - -

# Traverse.prototype.has()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2264 "View in source") [Ⓣ][1] - -(Function): Return whether the element at the array path exists. - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Returns -*(boolean)*: has element at path - -#### Example -```js -traverse({ eh: true }).has(['eh']) -//=> true - -``` -#### Example -```js -traverse({ eh: true }).has(['canada']) -//=> false - -``` -#### Example -```js -traverse([0]).has([2]) -//=> false - -``` ---- - - - - - -

# Traverse.prototype.nodes()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2414 "View in source") [Ⓣ][1] - -(Function): Return an Array of every node in the object. - -#### Returns -*(*)*: - ---- - - - - - -🔬 Tests: keys  - -

# Traverse.prototype.paths()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2401 "View in source") [Ⓣ][1] - -(Function): Return an Array of every possible non-cyclic path in the object. Paths are Arrays of string keys. - -#### Returns -*(*)*: - ---- - - - - - -

# Traverse.prototype.reduce()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2384 "View in source") [Ⓣ][1] - -(Function): applies a function against an accumulator and each element in the array *(from left to right)* to reduce it to a single value. calls cb for each loop that is .notRoot defaults initial value to `this.value` - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Returns -*(*)*: - -#### Example -```js -var { traverse } = require('chain-able') - -var obj = { - a: [1, 2, 3], - b: 4, - c: [5, 6], - d: { e: [7, 8], f: 9 }, -} - -var leaves = traverse(obj).reduce(function(acc, x) { - if (this.isLeaf) acc.push(x) - return acc -}, []) - -console.dir(leaves) -//=> [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ] - -``` ---- - - - - - -

# Traverse.prototype.set()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2286 "View in source") [Ⓣ][1] - -(Function): Set the element at the array path to value. - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Returns -*(any)*: value passed in - ---- - - - - - - - -## `TraverseChain.prototype` - - - -

# TraverseChain.prototype.traverse()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6987 "View in source") [Ⓣ][1] - -(Function): runs traverser, checks the tests, calls the onMatch - -#### Since -1.0.0 - -#### Returns -*(any)*: this.obj/data cleaned - -#### Example -```js -const traversed = new Chain() - .merge({ flat: 0, one: { two: true } }) - .traverse(false) - .vals([/true/]) - .onMatch((current, traverser) => { - traverser.path.join('.') - //=> 'one.two' - - current - //=> true - - typeof traverser.update === typeof traverser.remove - typeof traverser.update === 'function' - //=> true - - traverser.remove() - //=> void - }) - .onNonMatch(val => { - // ignore - }) - .call(true) - -traversed -//=> {flat: 0} - -``` ---- - - - - - - - -## `add` - - - -

# add()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5091 "View in source") [Ⓣ][1] - -(Function): add methodFactories easily - -#### Since -4.0.0-beta.2 - -#### Returns -*(void)*: - -#### Example -```js -function autoGetSet(name, parent) { - const auto = arg => - isUndefined(arg) ? parent.get(name) : parent.set(name, arg) - - //so we know if we defaulted them - auto.autoGetSet = true - return this.onSet(auto).onGet(auto).onCall(auto) -} -MethodChain.addPlugin({ autoGetSet }) - -const chain = new Chain() -chain.methods('eh').autoGetSet().build() - -chain.eh(1) -//=> chain -chain.eh() -//=> 1 * - -``` ---- - - - - - -

# add()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5620 "View in source") [Ⓣ][1] - -(Function): appends a new element with a specified value to the end of the .store - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -0.4.0 - -#### Returns -*(ChainedSet)*: @chainable - -#### Example -```js -const people = new ChainedSet() -people.add('sam').add('sue') - -for (let name of people) console.log(name) -//=> sam, sue - -``` ---- - - - - - - - -## `addTypes` - - - -🌊 Types: schema.d  - -

# addTypes

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3323 "View in source") [Ⓣ][1] - -unknown - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Example -```js -addTypes({ yaya: x => typeof x === 'string' }) - -const chain = new Chain().methods('eh').type('yaya').build() - -chain.eh('good') -//=> chain - -chain.eh(!!'throws') -//=> TypeError(false != {yaya: x => typeof x === 'string'}) - -``` -#### Example -```js -const custom = {} -custom.enums = enums => x => enums.includes(x) -custom['*'] = x => true -addTypes(custom) -//-> void - -new Chain().methods('eh').type('*').build().eh -//=> validateType(custom['*']) - -``` ---- - - - - - - - -## `after` - - - -

# after()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2605 "View in source") [Ⓣ][1] - -(Function): Call this function after any of the children are traversed. - -#### Returns -*(any)*: - ---- - - - - - - - -## `alias` - - - -

# alias()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4476 "View in source") [Ⓣ][1] - -(Function): alias methods - - -### @notes - -* these would be .transform - -#### Since -2.0.0 - -#### Returns -*(MethodChain)*: @chainable - -#### Example -```js -const chain = new Chain() -chain.methods(['canada']).alias(['eh']).build() -chain.eh('actually...canada o.o') -chain.get('canada') -//=> 'actually...canada o.o') - -``` ---- - - - - - - - -## `allProperties` - - - -

# allProperties()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4221 "View in source") [Ⓣ][1] - -(Function): properties, property symbols, object keys ^ all again for prototype - -#### Returns -*(*)*: properties - -#### Example -```js -var obj = { key: true } -allProperties(obj) -//=> ['key'] - -``` -#### Example -```js -class One { - method() {} -} -class Two extends One { - eh() {} -} -allProperties(new Two()) -//=> ['eh', 'method'] - -``` ---- - - - - - - - -## `anyKeyVal` - - - -🌊 Types: matcher.d  - -

# anyKeyVal()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6898 "View in source") [Ⓣ][1] - -(Function): the original simple to-test matcher for traversable, -will be merged into, or simplified as simplified into matcher - - -### @todos - -- [ ] should use matcher, -- [ ] should inprove the callback data... - -#### Since -2.0.0 - -#### Returns -*(boolean)*: matched or not - -#### Example -```js -anyKeyVal([], [])(0, 0) -//=> false - -anyKeyVal([() => true], [])(0, 0) -//=> true - -``` ---- - - - - - - - -## `argumentor` - - - -

# argumentor()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2108 "View in source") [Ⓣ][1] - -(Function): turns arguments into an array, used as a util, for opt - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -3.0.0 - -#### Returns -*(*)*: - -#### Example -```js -function eh() { - const args = argumentor.apply(null, arguments).slice(1) - - console.log(args) - //=> [1, 10, 100] -} -eh(0, 1, 10, 100) - -``` ---- - - - - - - - -## `arithmeticTypeFactory` - - - -🌊 Types: schema.d  - -

# arithmeticTypeFactory()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3429 "View in source") [Ⓣ][1] - -(Function): transform arithmetic strings into types - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @todos - -- [ ] coercing values to certain types: arithmeticTypeFactory('') - -#### Since -4.0.0-alpha.1 - -#### Returns -*(Matchable)*: function to match with, with .inspect for easy debugging - -#### Example -```js -arithmeticTypeFactory('?string') -//=> x => !isReal(x) || isString(x) - -``` -#### Example -```js -arithmeticTypeFactory('?string|string[]') -//=> x => isString(x) || isArrayOf(isString)(x) - -``` -#### Example -```js -arithmeticTypeFactory('!string') -//=> x => not(isString)(x) - -``` -#### Example -```js -types.addTypes({ star: x => true }) -arithmeticTypeFactory('object|function|star') -//=> x => isObj(x) || isFunction(x) || isStar(x) - -``` -#### Example -```js -arithmeticTypeFactory('===') -//=> x => (['===']).includes(x) - -``` ---- - - - - - - - -## `autoIncrement` - - - -

# autoIncrement()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4158 "View in source") [Ⓣ][1] - -Function - -#### Returns -*(MethodChain)*: @chainable - ---- - - - - - - - -## `before` - - - -

# before()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2597 "View in source") [Ⓣ][1] - -(Function): Call this function before any of the children are traversed. -You can assign into this.keys here to traverse in a custom order. - -#### Returns -*(any)*: - ---- - - - - - - - -## `block` - - - -

# block()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2637 "View in source") [Ⓣ][1] - -Function - -#### Returns -*(void)*: - ---- - - - - - - - -## `builder` - - - -

# builder()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3494 "View in source") [Ⓣ][1] - -(Function): @pattern @builder -> builds using multiple factories depending on conditons or abstractFactory whatever opinionated: if it's a function, it's a validator... - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @notes - -* if/else is for uglifying ternaries, even though else if is not needed -* if key is number, iterating the array - -#### Since -4.0.0 - -#### Returns -*(Function)*: validator - -#### Example -```js -// functionType -const isString = x => typeof x === 'string' -builder(isString) -// => isString - -``` -#### Example -```js -// stringType (built in, or custom-keyed validator, or eqeqeq) -builder('string') -// => isString - -const enummy = builder('enum') -// => x => ['enum'].includes(x) - -``` -#### Example -```js -// arithmeticType -builder('string|string[]') -// => isString || isArrayOf(isString) - -``` ---- - - - - - - - -## `camelCase` - - - -

# camelCase()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3147 "View in source") [Ⓣ][1] - -(Function): camelCase - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @todos - -- [ ] s.charAt(0).toLowerCase() + string.slice(1) - -#### Since -0.2.0 - -#### Returns -*(string)*: camelCased string - -#### Example -```js -camelCase('snake_case') -//=> 'snakeCase' - -``` ---- - - - - - - - -## `circular` - - - -

# circular

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2547 "View in source") [Ⓣ][1] - -unknown - ---- - - - - - - - -## `clear` - - - -

# clear()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L505 "View in source") [Ⓣ][1] - -(Function): clears the map, goes through this properties, calls .clear if they are instanceof Chainable or Map - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Returns -*(Chainable)*: @chainable - -#### Example -```js -const chain = new Chain() -chain.set('eh', 1) -chain.entries() -//=> {eh: 1} -chain.clear() -chain.entries() -//=> {} - -``` ---- - - - - - - - -## `compose.prototype` - - - -🌊 Types: compose.d  - -🔬 Tests: compose  - -

# compose.prototype.compose()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7603 "View in source") [Ⓣ][1] - -(Function): compose chains all the way up from Chainable - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @symb - -🎼 -#### Since -3.0.0 - -#### Returns -*(*)*: composed - -#### Example -```js -class Eh extends compose() {} -new Eh() instanceof Chainable -//=> true - -``` -#### Example -```js -class Target {} -class Eh extends compose(Target) {} -new Eh() instanceof Target -//=> true - -``` -#### Example -```js -class Target {} -const mixin = SuperClass => class extends SuperClass {} -class Eh extends compose(Target) {} -new Eh() instanceof Chainable -//=> true - -``` -#### Example -```js -class Winning {} -class Yes extends compose(Winning) { - get winning() { - return true - } -} -const yes = new Yes() -yes instanceof Winning && yes.winning -//=> true - -``` ---- - - - - - - - -## `conditional.prototype` - - - -

# conditional.prototype.all()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3241 "View in source") [Ⓣ][1] - -(Function): map all values in an array to see if all match - -#### Since -4.0.1 - -#### Returns -*(boolean)*: all match predicate - -#### Example -```js -const allBoolean = all(x => typeof x === 'boolean'q) - - allBoolean([true]) - //=> true - - allBoolean([1]) - //=> false -``` ---- - - - - - -

# conditional.prototype.and()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3197 "View in source") [Ⓣ][1] - -(Function): first fn & second fn - -#### Since -4.0.1 - -#### Returns -*(boolean)*: both functions return truthy - -#### Example -```js -const both = and(x => typeof x === 'boolean', x => x === true) - -both([true]) -//=> true - -both([false]) -//=> false - -both([1]) -//=> false - -``` ---- - - - - - -

# conditional.prototype.not()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3173 "View in source") [Ⓣ][1] - -(Function): return a negated function - -#### Since -4.0.1 - -#### Returns -*(Function)*: !Function - -#### Example -```js -const falsed = not(x => true) -const trued = not(x => false) - -trued() -//=> true - -falsed() -//=> false - -``` ---- - - - - - -

# conditional.prototype.or()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3221 "View in source") [Ⓣ][1] - -(Function): first fn || second fn - -#### Since -4.0.1 - -#### Returns -*(boolean)*: one of the functions return truthy - -#### Example -```js -const either = or(x => x === false, x => x === true) - -either([true]) -//=> true - -either([new Boolean(true)]) -//=> false - -either([1]) -//=> false - -``` ---- - - - - - - - -## `debug` - - - -

# debug()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6718 "View in source") [Ⓣ][1] - -(Function): sets on store not this.set for easier extension - - -### @notes - -* is inherited by any chain with a parent with .meta.debug - -#### Returns -*(Chainable)*: @chainable - -#### Example -```js -const Chain = require('chain-able') -const chain = new Chain() -chain.debug() - -chain.get('debug') -//=> true - -// not in entries -chain.entries() -//=> {} - -``` ---- - - - - - - - -## `define` - - - -

# define()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L281 "View in source") [Ⓣ][1] - -(Function): default to configurable and enumerable, unless configured otherwise - -#### Since -4.0.0 - -#### Returns -*(void)*: - -#### Example -```js -var desc = Object.getOwnPropertyDescriptor(obj, 'eh', { - get: () => console.log('eh'), -}) - -``` ---- - - - - - -

# define()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L679 "View in source") [Ⓣ][1] - -Function - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -0.5.0 - -#### Returns -*(number)*: - -#### Example -```js -for (var i = 0; i < chain.length; i++) -``` ---- - - - - - - - -## `delete` - - - -

# delete()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L545 "View in source") [Ⓣ][1] - -(Function): calls .delete on this.store.map - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -0.3.0 - -#### Returns -*(Chainable)*: - -#### Example -```js -const chain = new Chain() -chain.set('eh', 1) -chain.get('eh') -// => 1 -chain.delete('eh', 1) -chain.get('eh') -// => undefined - -``` ---- - - - - - -

# delete()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2568 "View in source") [Ⓣ][1] - -(Function): Delete the current element from its parent in the output. Calls delete even on Arrays. - -#### Returns -*(void)*: - ---- - - - - - -

# delete

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7534 "View in source") [Ⓣ][1] - -unknown - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -3.0.1 - -#### Example -```js -chain.set('moose.canada.eh', true) -chain.set('moose.canada.igloo', true) -//=> Chain - -chain.delete('moose.canada.eh') -//=> Chain - -chain.has('moose.canada.eh') -//=> true - -//still has moose.canada.igloo -chain.has('moose.canada') -//=> true - -``` ---- - - - - - - - -## `dopemerge.prototype` - - - -

# dopemerge.prototype.cloneIfNeeded()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1085 "View in source") [Ⓣ][1] - -(Function): Defaults to `false`. -If `clone` is `true` then both `x` and `y` are recursively cloned as part of the merge. - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -2.0.0 - -#### Returns -*(*)*: cloned or original value - -#### Example -```js -var obj = { eh: true } - -cloneIfNeeded(obj, { clone: true }) === obj -//=> false - -cloneIfNeeded(obj, { clone: false }) === obj -//=> true - -``` ---- - - - - - -

# dopemerge.prototype.defaultArrayMerge()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1124 "View in source") [Ⓣ][1] - -(Function): The merge will also merge arrays and array values by default. -However, there are nigh-infinite valid ways to merge arrays, -and you may want to supply your own. -You can do this by passing an `arrayMerge` function as an option. - -#### Since -2.0.0 - -#### Returns -*(*)*: merged array - -#### Example -```js -function concatMerge(destinationArray, sourceArray, options) { - destinationArray - //=> [1, 2, 3] - - sourceArray - //=> [3, 2, 1] - - options - //=> { arrayMerge: concatMerge } - - return destinationArray.concat(sourceArray) -} -merge([1, 2, 3], [3, 2, 1], { arrayMerge: concatMerge }) -//=> [1, 2, 3, 3, 2, 1] - -``` ---- - - - - - -🌊 Types: _dopemergelater.d  - -

# dopemerge.prototype.dopemerge()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1250 "View in source") [Ⓣ][1] - -(Function): Merge the enumerable attributes of two objects deeply. Merge two objects `x` and `y` deeply, returning a new merged object with the elements from both `x` and `y`. If an element at the same key is present for both `x` and `y`, the value from -`y` will appear in the result. Merging creates a new object, so that neither `x` or `y` are be modified. However, child objects on `x` or `y` are copied over - if you want to copy all values, you must pass `true` to the clone option. - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Returns -*(*)*: merged -
-
-{@link https://github.com/KyleAMathews/deepmerge deepmerge} - -#### Example -```js -var x = { - foo: { bar: 3 }, - array: [ - { - does: 'work', - too: [1, 2, 3], - }, - ], -} - -var y = { - foo: { baz: 4 }, - quux: 5, - array: [ - { - does: 'work', - too: [4, 5, 6], - }, - { - really: 'yes', - }, - ], -} - -var expected = { - foo: { - bar: 3, - baz: 4, - }, - array: [ - { - does: 'work', - too: [1, 2, 3, 4, 5, 6], - }, - { - really: 'yes', - }, - ], - quux: 5, -} - -merge(x, y) -//=> expected - -``` ---- - - - - - -

# dopemerge.prototype.emptyTarget()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1056 "View in source") [Ⓣ][1] - -(Function): make a new empty Array or Object for cloning - -#### Since -2.0.0 - -#### Returns -*(*)*: depending on the data type of val - -#### Example -```js -emptyTarget({ eh: true }) -//=> {} - -emptyTarget([1]) -//=> [] - -``` ---- - - - - - -

# dopemerge.prototype.isMergeableObj()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1036 "View in source") [Ⓣ][1] - -(Function): 1: not null object `2`: object toString is not a date or regex - -#### Since -2.0.0 - -#### Returns -*(boolean)*: - -#### Example -```js -isMergeableObj({}) -//=> true - -isMergeableObj(Object.create(null)) -// => true - -isMergeableObj(new Date()) -//=> false - -isMergeableObj(/eh/) -//=> false - -``` ---- - - - - - - - -## `dot` - - - -

# dot()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7395 "View in source") [Ⓣ][1] - -Function - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -3.0.1 - -#### Returns -*(DotProp)*: @chainable - -#### Example -```js -const chain = new Target() -chain.dot(false) -chain.set('moose.simple', 1) - -toArr(chain.store.keys()) -//=> ['moose.simple'] - -``` ---- - - - - - - - -## `encase` - - - -

# encase()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3907 "View in source") [Ⓣ][1] - -Function - -#### Since -4.0.0 - -#### Returns -*(Function)*: -> FunctionObject{onInvalid, onValid, rethrow, call} - -#### Example -```js -const throws = x => { - if (x === false) { - throw new Error('invalid - cannot be false') - } - return true -} -const api = encase(throws) - -api.onValid(console.log) -api.onInvalid(console.error) - -//--- invalid -api.call(false) -//=> 'invalid - cannot be false' - -//--- valid -api.call(true) -//=> 'true' - -``` ---- - - - - - - - -## `encase.prototype` - - - -

# encase.prototype.error$3()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3805 "View in source") [Ⓣ][1] - -(Function): enhance an Error, enable rethrowing & better inspection - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @todos - -- [ ] js stringify if development - -#### Since -4.0.0-alpha.1 - -#### Returns -*(Function): function that returns a decorated TypeError with .inspect & metadata (arg, thrown, meta)* - -#### Example -```js -const badValidator = x => { - if (x === 'bad') { - throw new Error('bad!') - } -} -const enhancer = enhanceError('eh', badValidator) - -// called by plugins/encase when throws or invalid -let error -let arg = 'bad' -try { - error = badValidator(arg) -} catch (e) { - error = enhancer(arg, e, { metadata: true }) -} - -console.log(error) -//=> {[eh]: { type: badValidator, arg: 'bad', json, str, rethrow }} -//=> console.log on DEVELOPMENT - -``` ---- - - - - - - - -## `end` - - - -

# end()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L433 "View in source") [Ⓣ][1] - -(Function): for ending nested chains - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -0.4.0 - -#### Returns -*(*)*: - -#### Example -```js -const parent = 'eh' -const child = newChain(parent) -child.end() -//=> 'eh' - -``` ---- - - - - - - - -## `entries` - - - -

# entries()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1413 "View in source") [Ⓣ][1] - -(Function): recursively reduce maps and objects that include reducable data - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @sig - -reduced => object => isMap(object) -> reduced; merge(object, reduced) -#### Since -4.0.0 - -#### Returns -*(Function): Function(values: Object)* - -#### Example -```js -const map = new Map() - map.set('eh', true) - const nested = new Map() - nested.set('reduced', true) - - const chain = { - entries() { - return { - nested: reduce(nested), - key: true, - } - }, - } - const reduced = reduce(map) - reduceEntries(reduced)({chain}) - // => { - eh: true, - chain: { - nested: { - reduced: true, - key: true, - }, - }, - } -``` -#### Example -```js -const reducedIgnored = { - canada: { - store: chain, - }, - } - const ignored = reduceEntries(reduced)(reducedIgnored) - //=> { - eh: true, - chain: { - nested: { - reduced: true, - }, - key: true, - }, - } -``` ---- - - - - - - - -## `fn.call` - - - -

# fn.call()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6607 "View in source") [Ⓣ][1] - -(Function): call the observer - it matched & data changed - ---- - - - - - - - -## `forEach` - - - -

# forEach

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2164 "View in source") [Ⓣ][1] - -unknown - - -### @notes - -* if there is .forEach on the obj already, use it -otherwise, call function for each - - -### @todos - -- [ ] unexpectedly breaks things iterating -if you are relying on internal functionality -(such as .path, .get, .value...) with map & set - -#### Since -3.0.0 - -#### Example -```js -forEach([1], console.log) -//=> 1 - -``` ---- - - - - - -

# forEach()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2793 "View in source") [Ⓣ][1] - -(Function): adds methods to Traverser - ---- - - - - - - - -## `from` - - - -

# from

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1312 "View in source") [Ⓣ][1] - -unknown - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js ---- - - - - - - - -## `get` - - - -

# get()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1611 "View in source") [Ⓣ][1] - -Function - -#### Since -4.0.0 - -#### Returns -*(any)*: - ---- - - - - - - - -## `getMeta` - - - -

# getMeta()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1564 "View in source") [Ⓣ][1] - -Function - -#### Since -4.0.0 - -#### Returns -*(Chain)*: - ---- - - - - - - - -## `handleExisting` - - - -

# handleExisting()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5285 "View in source") [Ⓣ][1] - -Function - - -### @todos - -- [ ] could use .eq here -- [ ] if (isMapish(obj)) obj = obj.entries() - -#### Returns -*(void)*: - -#### Example -```js -var obj = { key: 1 } - -MergeChain.init(obj).merge({ key: ['value'] }) - -// goes to this internal scoped function -handleExisting('key', ['value']) -// if there is .onValue or .onExisting, use them, default deepmerge - -obj -//=> {key: [1, 'value']} - -``` ---- - - - - - - - -## `has` - - - -

# has()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L565 "View in source") [Ⓣ][1] - -Function - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -0.3.0 - -#### Returns -*(boolean)*: - -#### Example -```js -const chain = new Chain() -chain.set('eh', 1).has('eh') -//=> true -chain.has('canada') -//=> false - -``` ---- - - - - - -

# has()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1601 "View in source") [Ⓣ][1] - -Function - -#### Since -4.0.0 - -#### Returns -*(boolean)*: - ---- - - - - - -

# has

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7501 "View in source") [Ⓣ][1] - -unknown - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -3.0.1 - -#### Example -```js -chain.set('one.two', 3) -chain.has('one.two') -//=> true - -``` ---- - - - - - - - -## `if` - - - -

# if()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L658 "View in source") [Ⓣ][1] - -(Function): hint === 'number' -`s`tring is `115` -`n`umber is `110` -110 & `4` = `1` -115 & `4` = `0` -
-
-if *(hint === 'string' && this.toJSON) return this.toJSON()* -else if *(hint === 'number' && this.toNumber) return this.toNumber()* - ---- - - - - - -

# if()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4536 "View in source") [Ⓣ][1] - -(Function): this is a plugin for building methods schema defaults value to `.type` this defaults values to `.onCall` - ---- - - - - - -

# if()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5319 "View in source") [Ⓣ][1] - -(Function): check if it's shorthanded --> check if it has a value already - ---- - - - - - -

# if()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5327 "View in source") [Ⓣ][1] - -(Function): if we have onExisting, call it -else default to dopemerge - ---- - - - - - -

# if()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6592 "View in source") [Ⓣ][1] - -(Function): if we have called it at least once... and it has not changed, leave it -else clone it call the observer - ---- - - - - - - - -## `index` - - - -

# compose

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L711 "View in source") [Ⓣ][1] - -unknown - -#### Since -3.0.0 - -#### Example -```js -class Target {} -const TargetChain = Chainable.compose(Target) -const chain = new TargetChain() -chain instanceof Target -//=> true - -``` ---- - - - - - -

# 

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1524 "View in source") [Ⓣ][1] - -unknown - ---- - - - - - -

# 

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1575 "View in source") [Ⓣ][1] - -unknown - ---- - - - - - -

# walk()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2480 "View in source") [Ⓣ][1] - -Function - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Returns -*(any)*: - ---- - - - - - -

# copy()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2730 "View in source") [Ⓣ][1] - -Function - - -### @notes - -* wicked ternary - - -### @todos - -- [ ] does not respect ObjectDescriptors - -#### Returns -*(any)*: - ---- - - - - - -

# 

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4315 "View in source") [Ⓣ][1] - -unknown - - -### @todos - -- [ ] clarify .set vs .call -{@link https://github.com/iluwatar/java-design-patterns/tree/master/property property-pattern} -{@link https://github.com/iluwatar/java-design-patterns/tree/master/prototype prototype-pattern} -{@link https://github.com/iluwatar/java-design-patterns/tree/master/step-builder step-builder-pattern} -{@link https://github.com/iluwatar/java-design-patterns/tree/master/builder builder-pattern} -{@link https://github.com/addyosmani/essential-js-design-patterns/blob/master/diagrams/mixins.png mixin-png} -{@link https://sourcemaking.com/design_patterns/creational_patterns creational-patterns} -{@link https://sourcemaking.com/design_patterns/factory_method factory-method} -{@link https://medium.com/javascript-scene/javascript-factory-functions-vs-constructor-functions-vs-classes-2f22ceddf33e constructors} -{@link https://www.sitepoint.com/factory-functions-javascript/ js-factory-functions} - ---- - - - - - -

# 

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6620 "View in source") [Ⓣ][1] - -unknown - -#### Since -2.0.0 - ---- - - - - - -

# 

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7286 "View in source") [Ⓣ][1] - -unknown - -#### Since -2.0.0 - ---- - - - - - - - -## `is.prototype` - - - -

# is.prototype.boolean_1()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L972 "View in source") [Ⓣ][1] - -(Function): Checks if `value` is classified as a boolean primitive or object. - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @notes - -* could also have typeof x === 'boolean' || (/true|false/).test(x) - - -### @extends - -* undefined -* undefined - - -#### Since -3.0.0 - -#### Returns -*(boolean)*: isBoolean - -#### Example -```js -isBoolean(false) -//=> true -isBoolean(new Boolean(1)) -//=> true -isBoolean(1) -//=> false -isBoolean('') -//=> false - -``` ---- - - - - - -

# is.prototype.date()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L940 "View in source") [Ⓣ][1] - -Function - -#### Since -3.0.0 - -#### Returns -*(boolean)*: isDate - -#### Example -```js -isDate(new Date()) -//=> true -isDate(Date.now()) -//=> false -isDate(1) -//=> false -isDate('') -//=> false - -``` -#### Example -```js -const e = {} -eh[Symbol.toStringTag] = '[Object Date]' -isDate(eh) -//=> true - -``` -#### Example -```js -class Eh extends Date() - isDate(new Eh()) - //=> true -``` ---- - - - - - -

# is.prototype.error$1()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2043 "View in source") [Ⓣ][1] - -Function - -#### Returns -*(boolean)*: isError - -#### Example -```js -isError(new Error()) -//=> true -isError(new Error().stack) -//=> false -isError(1) -//=> false -isError('') -//=> false - -``` -#### Example -```js -const e = {} -eh[Symbol.toStringTag] = '[Object Error]' -isError(eh) -//=> true - -``` -#### Example -```js -class Eh extends Error() - isError(new Eh()) - //=> true -``` ---- - - - - - -

# is.prototype._false()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L257 "View in source") [Ⓣ][1] - -Function - -#### Since -4.0.0-alpha.1 - -#### Returns -*(boolean)*: isFalse - -#### Example -```js -isFalse(false) -//=> true -isFalse(true) -//=> false -isFalse(0) -//=> false -isFalse('') -//=> false - -``` ---- - - - - - -

# is.prototype._function()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L178 "View in source") [Ⓣ][1] - -(Function): Checks if `value` is classified as a `Function` object. - - -### @notes - -* || x instanceof Function - -#### Since -3.0.0 - -#### Returns -*(boolean)*: x isFunction - -#### Example -```js -isFunction(function() {}) -//=> true -isFunction(() => {}) -//=> true -isFunction(new Function()) -//=> true - -isFunction(1) -//=> false -isFunction('') -//=> false -isFunction(/abc/) -// => false - -``` ---- - - - - - -

# is.prototype.()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1471 "View in source") [Ⓣ][1] - -Function - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -3.0.0 - -#### Returns -*(boolean)*: isIterator - -#### Example -```js -isIterator(new Set().values()) -//=> true -isIterator(new Map.entries()) -//=> true -isIterator(new Map()) -//=> false -isIterator('') -//=> false -isIterator(1) -//=> false - -``` -#### Example -```js -const e = {} -eh[Symbol.toStringTag] = '[Map Iterator]' -isIterator(eh) -//=> true -eh[Symbol.toStringTag] = '[Set Iterator]' -isIterator(eh) -//=> true - -``` -#### Example -```js -class Eh extends Set() - isIterator(new Eh().values()) - //=> true -``` ---- - - - - - -

# is.prototype.map()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L119 "View in source") [Ⓣ][1] - -(Function): Checks if `value` is classified as a `Map` object. - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -3.0.0 - -#### Returns -*(boolean)*: isMap - -#### Example -```js -isMap(new Map()) -//=> true -isMap(new Map.entries()) -//=> false -isMap(new Set()) -//=> false -isMap({}) -//=> false -isMap('') -//=> false -isMap(1) -//=> false -isMap(new WeakMap()) -// => false - -``` -#### Example -```js -const e = {} -eh[Symbol.toStringTag] = '[object Map]' -isMap(eh) - -``` -#### Example -```js -class Eh extends Map() - isMap(new Eh()) - //=> true -``` ---- - - - - - -

# is.prototype.mapish()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5124 "View in source") [Ⓣ][1] - -Function - - -### @extends - - - -#### Since -3.0.0 - -#### Returns -*(boolean)*: isMapish - -#### Example -```js -isMapish(new Map()) -//=> true - -isMapish(new Chain()) -//=> true - -isMapish({}) -//=> false - -isMapish(1) -//=> false - -``` ---- - - - - - -

# is.prototype.matcher()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3083 "View in source") [Ⓣ][1] - -Function - -#### Since -3.0.0 - -#### Returns -*(boolean)*: isFunction || isRegExp - -#### Example -```js -isMatcher(/(.*)/) -//=> true - -isMatcher(x => true) -//=> true - -isMatcher(1) -//=> false -isMatcher('.*') -//=> false - -``` ---- - - - - - -

# is.prototype.notEmptyArray()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7657 "View in source") [Ⓣ][1] - -(Function): value is an Array, with at least `1` value - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @extends - - - -#### Since -4.0.0-alpha.1 - -#### Returns -*(boolean)*: isNotEmptyArray - -#### Example -```js -isNotEmptyArray(new Array(3)) -//=> true -isNotEmptyArray([1, 2, 3]) -//=> true - -isNotEmptyArray(new Array()) -//=> false -isNotEmptyArray([]) -//=> false -isNotEmptyArray(new Map()) -//=> false - -``` ---- - - - - - -

# is.prototype._null()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L775 "View in source") [Ⓣ][1] - -Function - -#### Since -3.0.0 - -#### Returns -*(boolean)*: isNull - -#### Example -```js -isNull(null) -//=> true - -isNull(undefined) -//=> false -isNull(void 0) -//=> false -isNull({}) -//=> false -isNull('') -//=> false -isNull(1) -//=> false - -``` ---- - - - - - -

# is.prototype.nullOrUndefined()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L814 "View in source") [Ⓣ][1] - -(Function): Checks if `value` is `null` or `undefined`. - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -4.0.0-alpha.1 - -#### Returns -*(boolean)*: isNullOrUndefined - -#### Example -```js -isNullOrUndefined(null) -//=> true -isNullOrUndefined(undefined) -//=> true -isNullOrUndefined(void 0) -//=> true - -isNullOrUndefined(NaN) -//=> false -isNullOrUndefined({}) -//=> false -isNullOrUndefined('') -//=> false -isNullOrUndefined(1) -//=> false -isNullOrUndefined(false) -//=> false - -``` ---- - - - - - -

# is.prototype.number()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2086 "View in source") [Ⓣ][1] - -Function - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @notes - -* was not needed except for abstract == - const isObj = require('./obj') - const isSymbol = require('./symbol') - (isObj(x) || isSymbol(x) - ? false - : (/^0x[0-9a-f]+$/i).test(x) || - (/^[-+]?(?:\d+(?:\.\d*)?|\.\d+)(e[-+]?\d+)?$/).test(x)) - -#### Since -3.0.0 - -#### Returns -*(boolean)*: isNumber - -#### Example -```js -isNumber(1) -//=> true -isNumber(Number(1)) -//=> true -isNumber(NaN) -//=> true - -isNumber(null) -//=> false -isNumber(undefined) -//=> false -isNumber(void 0) -//=> false -isNumber({}) -//=> false -isNumber('') -//=> false -isNumber(false) -//=> false - -``` ---- - - - - - -

# is.prototype.obj()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2009 "View in source") [Ⓣ][1] - -Function - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @notes - -* Object.prototype.toString.call(val) === '[object Object]' - -#### Since -3.0.0 - -#### Returns -*(boolean)*: Returns `true` if `value` is an object, else `false`. - -#### Example -```js -isObject({}) -// => true - -isObject([1, 2, 3]) -// => true - -isObject(Function) -// => true - -isObject(null) -// => false - -``` ---- - - - - - -

# is.prototype.objLoose()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L748 "View in source") [Ⓣ][1] - -Function - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -3.0.0 - -#### Returns -*(boolean)*: isObjLoose - -#### Example -```js -isObjLoose(new Object()) -//=> true -isObjLoose({}) -//=> true -isObjLoose(Object.create(null)) -//=> true -isObjLoose(null) -//=> true - -isObjLoose(new Set()) -//=> false -isObjLoose(function() {}) -//=> false -isObjLoose('') -//=> false -isObjLoose(1) -//=> false - -``` ---- - - - - - -

# is.prototype.objStrict()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L856 "View in source") [Ⓣ][1] - -Function - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @todos - -- [ ] !Array.isArray - - -### @extends - - - -#### Since -3.0.0 - -#### Returns -*(boolean)*: isObjStrict - -#### Example -```js -isObjStrict(new Object()) -//=> true -isObjStrict({}) -//=> true -isObjStrict(Object.create(null)) -//=> true -isObjStrict(null) -//=> false - -isObjStrict(new Set()) -//=> false -isObjStrict(function() {}) -//=> false -isObjStrict('') -//=> false -isObjStrict(1) -//=> false - -``` ---- - - - - - -

# is.prototype.objWithKeys()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3038 "View in source") [Ⓣ][1] - -Function - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @extends - - - -#### Since -3.0.0 - -#### Returns -*(boolean)*: isObjWithKeys - -#### Example -```js -isObjWithKeys({ eh: true }) -//=> true -isObjWithKeys({}) -//=> false -isObjWithKeys(new Object()) -//=> false -isObjWithKeys(Object.create(null)) -//=> false -isObjWithKeys(null) -//=> false -isObjWithKeys(new Set()) -//=> false -isObjWithKeys(function() {}) -//=> false -isObjWithKeys('') -//=> false -isObjWithKeys(1) -//=> false - -``` ---- - - - - - -

# is.prototype.real()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2999 "View in source") [Ⓣ][1] - -Function - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @notes - -* eslint-disable-next-line no-self-compare - && x !== x - - -### @extends - - - -#### Since -3.0.0 - -#### Returns -*(boolean)*: isReal - -#### Example -```js -isReal(null) -//=> false -isReal(void 0) -//=> false -const nan = Number(undefined) -isReal(nan) -//=> false - -isReal({ eh: true }) -//=> true -isReal({}) -//=> true -isReal(Object) -//=> true -isReal([]) -//=> true -isReal(new Set()) -//=> true -isReal(function() {}) -//=> true -isReal('') -//=> true -isReal(1) -//=> true - -``` ---- - - - - - -

# is.prototype._true()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L886 "View in source") [Ⓣ][1] - -Function - -#### Since -4.0.0-alpha.1 - -#### Returns -*(boolean)*: isTrue - -#### Example -```js -isTrue(true) -//=> true -isTrue(false) -//=> false -isTrue(1) -//=> false -isTrue('') -//=> false - -``` ---- - - - - - -

# is.prototype._undefined()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L52 "View in source") [Ⓣ][1] - -(Function): Checks if `value` is `undefined`. - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @notes - -* || typeof x === 'undefined' - -#### Since -4.0.0-alpha.1 - -#### Returns -*(boolean)*: isUndefined - -#### Example -```js -isUndefined(undefined) -//=> true -isUndefined(void 0) -//=> true - -isUndefined(null) -//=> false -isUndefined(NaN) -//=> false -isUndefined({}) -//=> false -isUndefined('') -//=> false -isUndefined(1) -//=> false -isUndefined(false) -//=> false - -``` ---- - - - - - -

# is.prototype.string()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L235 "View in source") [Ⓣ][1] - -(Function): Checks if `value` is classified as a `String` primitive or object. - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @extends - - - -#### Since -3.0.0 - -#### Returns -*(boolean)*: Returns `true` if `value` is a string, else `false`. - -#### Example -```js -isString('abc') -// => true - -isString(new String('abc')) -// => true - -isString(1) -// => false - -``` ---- - - - - - -

# is.prototype.stringOrNumber()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2949 "View in source") [Ⓣ][1] - -(Function): Checks if `value` is classified as a `String` primitive or object. - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -3.0.0 - -#### Returns -*(boolean)*: Returns `true` if `value` is a string, else `false`. - -#### Example -```js -isString('abc') -// => true - -isString(1) -// => false - -``` ---- - - - - - -

# is.prototype.stringPrimitive()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L206 "View in source") [Ⓣ][1] - -(Function): Checks if `value` is classified as a `String` **primitive**. - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -3.0.0 - -#### Returns -*(boolean)*: Returns `true` if `value` is a string, else `false`. - -#### Example -```js -isString('abc') -// => true - -isString(new String('abc')) -// => false - -isString(1) -// => false - -``` ---- - - - - - -

# is.prototype.symbol()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3059 "View in source") [Ⓣ][1] - -(Function): Checks if `value` is classified as a `Symbol` primitive or object. - -#### Since -4.0.0 - -#### Returns -*(boolean)*: Returns `true` if `value` is a symbol, else `false`. - -#### Example -```js -isSymbol(Symbol.iterator) -// => true - -isSymbol('abc') -// => false - -``` ---- - - - - - -

# is.prototype.toS()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L77 "View in source") [Ⓣ][1] - -(Function): The base implementation of `getTag` without fallbacks for buggy environments. - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @todos - -- [ ] obj[Symbol.toStringTag] - -#### Returns -*(string)*: Returns the `toStringTag`. - ---- - - - - - - - -## `is.prototype.index$12` - - - -🌊 Types: is.d  - -* 🔬 Tests: index  -* 🔬 Tests: is  -* 🔬 Tests: primitives  -* 🔬 Tests: simple  - -

# is.prototype.index$12

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3100 "View in source") [Ⓣ][1] - -Object - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js ---- - - - - - - - -## `isArray` - - - -

# array

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L864 "View in source") [Ⓣ][1] - -Function - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -3.0.0 - ---- - - - - - - - -## `isRoot` - - - -

# isRoot

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2537 "View in source") [Ⓣ][1] - -(Boolean): Whether the present node is the root node - ---- - - - - - - - -## `key` - - - -

# key

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2532 "View in source") [Ⓣ][1] - -unknown - ---- - - - - - - - -## `level` - - - -

# level

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2542 "View in source") [Ⓣ][1] - -(number): Depth of the node within the traversal - ---- - - - - - - - -## `m` - - - -

# m

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6576 "View in source") [Ⓣ][1] - -unknown - ---- - - - - - - - -## `markForGarbageCollection` - - - -

# markForGarbageCollection()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4268 "View in source") [Ⓣ][1] - -(Function): remove all methods, mark for garbage collection - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @todos - -- [ ] blacklist = [] param -- [ ] put all GC events into a cached map and debounce the operation - -#### Since -4.0.0 - -#### Returns -*(void)*: - -#### Example -```js -var scoped = {} -var ref = () => scoped -var obj = { scoped, ref, eh: true } - -markForGarbageCollection(obj) -//=> void - -obj -//=> undefined|{} - -``` ---- - - - - - - - -## `matcher.prototype` - - - -

# matcher.prototype.escapeStringRegex()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6183 "View in source") [Ⓣ][1] - -Function - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @notes - -* also as const escapeStringRegexp = require('escape-string-regexp'); - -#### Since -3.0.0 - -#### Returns -*(string)*: escaped string -
-
-{@link https://github.com/sindresorhus/escape-string-regexp escape-string-regexp} - -#### Example -```js -const escaped = escapeStringRegexp('how much $ for a unicorn?') -//=> 'how much \$ for a unicorn\?' -new RegExp(escaped) - -``` ---- - - - - - -

# matcher.prototype.make()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6268 "View in source") [Ⓣ][1] - -(Function): turn any string[], function[], or RegExp[] into a matcher - -#### Since -3.0.0 - -#### Returns -*(*)*: matchable - -#### Example -```js -matcher.make('*') -//=> RegExp('.*', 'i') - -``` -#### Example -```js -var any = new RgExp('.*', 'i') -matcher.make(any) -//=> any - -``` -#### Example -```js -var strings = x => typeof x === 'string' -matcher.make(strings) -// {test: strings} - -``` -#### Example -```js -var tester = { test: x => x === true } -matcher.make(tester) -// tester - -``` -#### Example -```js -var noName = '!name' -matcher.make(noName, true) -// new RegExp('(?:name)', 'i') - -``` -#### Example -```js -var noName = '!name' -matcher.make(noName, true, true) -// new RegExp('^(?:name)$', 'i') - -``` ---- - - - - - -

# matcher.prototype.matcher()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6344 "View in source") [Ⓣ][1] - -(Function): same as .make but also accepts inputs, and returns an array - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -3.0.0 - -#### Returns -*(*)*: - -#### Example -```js -matcher(['foo', 'bar', 'moo'], ['*oo', '!foo']) -//=> ['moo'] - -matcher(['foo', 'bar', 'moo'], ['!*oo']) - -``` -#### Example -```js -matcher('kinga', 'kinga') -//=> ['kinga'] -matcher('k*nga', 'kinga') -//=> ['kinga'] -matcher('kinga', 'nope') -//=> [] - -matcher(new RegExp(/kinga/), 'kinga') -//=> ['kinga'] -matcher(new RegExp(/kinga/), 'nope') -//=> ['nope'] - -matcher(x => x === 'kinga', 'kinga') -//=> ['kinga'] -matcher(x => x === 'kinga', 'nope') -//=> [] - -matcher({ test: x => x === 'kinga' }, 'kinga') -//=> ['kinga'] -matcher({ test: x => x === 'kinga' }, 'nope') -//=> [] - -``` ---- - - - - - -🌊 Types: matcher.d  - -🔬 Tests: matcher  - -

# matcher.prototype.matcher

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6219 "View in source") [Ⓣ][1] - -unknown - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @symb - -🎯 ---- - - - - - -

# matcher.prototype.toRegexp()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6203 "View in source") [Ⓣ][1] - -Function - - -### @extends - - - -#### Returns -*(string)*: escaped str - -#### Example -```js -toRegExp('*') - => '.*' - - toRegExp('eh') - => 'eh' -``` ---- - - - - - - - -## `merge` - - - -

# merge()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5232 "View in source") [Ⓣ][1] - -(Function): merges object in, goes through all keys, checks cbs, dopemerges - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @todos - -- [ ] issue here if we extend without shorthands & - we want to merge existing values... :s - -#### Since -1.0.0 - -#### Returns -*(MergeChain)*: @chainable - -#### Example -```js -const chain = new Chain() -chain.merge({ canada: { eh: true } }) -chain.merge({ canada: { arr: [0, { '1': 2 }], eh: { again: true } } }) -chain.entries() -//=> {canada:{ eh: {again: true}, arr: [0, {'1': 2}] }} - -``` ---- - - - - - -

# merge()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5553 "View in source") [Ⓣ][1] - -(Function): merges an object with the current store - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @todos - -- [ ] needs to pass in additional opts somehow... - -#### Since -0.4.0 - -#### Returns -*(ChainedMap)*: @chainable - -#### Example -```js -const chain = new Chain() -chain.set('eh', [1]) -chain.merge({ eh: [2] }) -chain.get('eh') -// => [1, 2] - -``` -#### Example -```js -const chain = new Chain() - chain.set('emptyArr', []) - chain.merge({emptyArr: []}, mergeChain => - mergeChain.onExisting((a, b) => []).merger((a, b) => []).merge() - ) - chain.get('emptyArr').length) - //=> 0 -``` ---- - - - - - -

# merge()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5665 "View in source") [Ⓣ][1] - -(Function): merge any Array/Set/Iteratable/Concatables into the array, at the end - -#### Since -0.4.0 - -#### Returns -*(ChainedSet)*: @chainable - -#### Example -```js -const people = new ChainedSet() -people.add('sam').add('sue').prepend('first').merge(['merged']) - -for (let name of people) console.log(name) -//=> first, sam, sue, merged - -``` ---- - - - - - - - -## `meta` - - - -

# meta()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1648 "View in source") [Ⓣ][1] - -(Function): a single easily minifiable function, dynamically setting & getting depending on arguments to avoid nested property accessing only instantiating when values are **addded** - -#### Since -4.0.0 - -#### Returns -*(*)*: depending on args - ---- - - - - - - - -## `method` - - - -

# method()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5517 "View in source") [Ⓣ][1] - -(Function): the way to easily start building methods when using chainable instances - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -4.0.0 - -#### Returns -*(MethodChain)*: @chainable - -#### Example -```js -const chain = new Chain() -chain.method('eh').build() -chain.eh(true) -chain.get('eh') -// => true - -``` ---- - - - - - - - -## `methodEncasingFactory` - - - -

# methodEncasingFactory()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3956 "View in source") [Ⓣ][1] - -(Function): 3 steps -0. enhance error -1. encase function with a specification -2. build a function to call onInvalid or onInvalid depending - - -### @symb - -⛑🏭 -#### Since -4.0.0 - -#### Returns -*(Function)*: curried finisher, for specification - -#### Example -```js -methodEncasingFactory('eh', {}, { onSet: console.log }) -//=> Function - -``` ---- - - - - - - - -## `node` - - - -

# node

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2510 "View in source") [Ⓣ][1] - -(Array): The present node on the recursive walk - ---- - - - - - - - -## `node_` - - - -

# node_

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2516 "View in source") [Ⓣ][1] - -Array - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js ---- - - - - - - - -## `objs` - - - -

# objs

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6461 "View in source") [Ⓣ][1] - -(Map): scoped clones - ---- - - - - - - - -## `objs.set` - - - -

# objs.set()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6602 "View in source") [Ⓣ][1] - -(Function): it did change - clone it for next deepEquals check - ---- - - - - - - - -## `parent` - - - -

# parent

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2526 "View in source") [Ⓣ][1] - -unknown - ---- - - - - - - - -## `path` - - - -

# path

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2521 "View in source") [Ⓣ][1] - -(Array): An array of string keys from the root to the present node - ---- - - - - - - - -## `paths` - - - -

# paths()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2814 "View in source") [Ⓣ][1] - -(Function): gathers dot.prop from any value, with a prefixed/base key - - -### @notes - -* had `onlyLongest` & `asString` but can just .join(',') to match - -#### Since -4.0.0 - -#### Returns -*(*)*: paths - ---- - - - - - - - -## `post` - - - -

# post()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2621 "View in source") [Ⓣ][1] - -(Function): Call this function after each of the children are traversed. - -#### Returns -*(any)*: - ---- - - - - - - - -## `pre` - - - -

# pre()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2613 "View in source") [Ⓣ][1] - -(Function): Call this function before each of the children are traversed. - -#### Returns -*(any)*: - ---- - - - - - - - -## `prepend` - - - -

# prepend()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5641 "View in source") [Ⓣ][1] - -(Function): inserts the value at the **beginning** of the Set - -#### Since -0.4.0 - -#### Returns -*(ChainedSet)*: @chainable - -#### Example -```js -const people = new ChainedSet() -people.add('sue').prepend('first') - -for (let name of people) console.log(name) -//=> first, sue - -``` ---- - - - - - - - -## `prototype[iterator]` - - - -🔬 Tests: iteration  - -

# prototype[iterator]()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L391 "View in source") [Ⓣ][1] - -(generator): Iterator for looping values in the store - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @notes - -* assigned to a variable so buble ignores it - -#### Since -0.5.0 - -#### Returns -*(Object)*: {value: undefined | any, done: true | false} - -#### Example -```js -const chain = new Chain().set('eh', 1) -for (var [key, val] of chain) console.log({ [key]: val }) -//=> {eh: 1} - -``` -#### Example -```js -*[Symbol.iterator](): void { for (const item of this.store) yield item } -``` -#### Example -```js -const { ChainedSet } = require('chain-able') -const set = new ChainedSet() -set.add('eh') - -for (const arr of set) { - const [key, val] = arr - - key - //=> 0 - - val - //=> 'eh' - - arr.length - //=> 2 -} - -``` ---- - - - - - - - -## `prototype[primitive]` - - - -

# prototype[primitive]()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L646 "View in source") [Ⓣ][1] - -Function - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -1.0.2 - -#### Returns -*(Primitive)*: - -#### Example -```js -const chain = new Chain() -chain.toNumber = () => 1 + chain -//=> 1 -chain + 1 -//=> - -``` -#### Example -```js -const chain = new Chain() -chain.toString = () => 'eh' -chain + '' -//=> 'eh' - -``` ---- - - - - - - - -## `reduce` - - - -

# reduce()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1337 "View in source") [Ⓣ][1] - -(Function): Map -> Object - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -4.0.0 - -#### Returns -*(Object)*: reduced object - -#### Example -```js -var emptyMap = new Map() -reduce(emptyMap) -// => {} - -``` -#### Example -```js -var map = new Map() -map.set('eh', 1) -reduce(map) -// => {eh: 1} - -``` ---- - - - - - - - -## `reduce.prototype` - - - -

# reduce.prototype.clean()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7692 "View in source") [Ⓣ][1] - -(Function): goes through the maps, and the map values, reduces them to array then to an object using the reduced values - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Returns -*(Object)*: reduced object, without `notReal` values - -#### Example -```js -const map = new ChainedMap() - -map - .set('emptyArr', []) - .set('arr', [1]) - .set('nill', null) - .set('emptyObj', {}) - .set('obj', { keys: true }) - -clean(map.entries()) -//=> {arr: [1], obj: {keys: true}} - -``` ---- - - - - - - - -## `regexp` - - - -

# regexp()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L906 "View in source") [Ⓣ][1] - -(Function): Checks if `value` is classified as a `RegExp` object. - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -0.1.0 - -#### Returns -*(boolean)*: Returns `true` if `value` is a regexp, else `false`. - -#### Example -```js -isRegExp(/abc/) -// => true - -isRegExp('/abc/') -// => false - -``` ---- - - - - - - - -## `remove` - - - -

# remove()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2577 "View in source") [Ⓣ][1] - -(Function): Remove the current element from the output. If the node is in an Array it will be spliced off. Otherwise it will be deleted from its parent. - -#### Returns -*(void)*: - ---- - - - - - - - -## `return` - - - -

# return()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2494 "View in source") [Ⓣ][1] - -Function - -#### Returns -*(State)*: see types - ---- - - - - - - - -## `schema` - - - -

# schema()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3686 "View in source") [Ⓣ][1] - -(Function): handles:
1. recursively building nestable schemas, 2. creating MethodChains for all types 3. carrying over the inheritable properties 4. @modifies @injects @decorates .add(customValidators) - -#### Returns -*(MethodFactory)*: @chainable - ---- - - - - - - - -## `schema.prototype` - - - -

# schema.prototype.typeListFactory()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3357 "View in source") [Ⓣ][1] - -Function - -#### Returns -*(Function)*: validator - -#### Example -```js -const isStringOrNumber = typeListFactory('string|number') - -isStringOrNumber(1) -//=> true -isStringOrNumber('one') -//=> true -isStringOrNumber(Object) -//=> false - -``` ---- - - - - - -

# schema.prototype.typeValidator()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3615 "View in source") [Ⓣ][1] - -(Function): build a recursive schema for all around runtime type safety - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @symb - -🛂 -#### Since -4.0.0-beta.1 - -#### Returns -*(boolean)*: valid - -#### Example -```js -const typeValidator = schemaFactory('eh', x => typeof x === 'string') - -var isValid = typeValidator('stringy') -//=> true - -var isValid = typeValidator(Number) -//=> false - -``` -#### Example -```js -const isNumber = x => typeof x === 'number' -const typeValidator = schemaFactory('eh', { canada: 'number' }) - -var isValid = typeValidator({ canada: 1 }) -//=> true - -var isValid = typeValidator({}) -//=> false - -var isValid = typeValidator({ canada: false }) -//=> false - -var isValid = typeValidator(1) -//=> false - -``` ---- - - - - - - - -## `schemaFactory` - - - -

# schemaFactory()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3573 "View in source") [Ⓣ][1] - -(Function): pass the property & schema in, get a nestable typeValidator out - -#### Since -4.0.0-alpha.1 - -#### Returns -*(Function)*: typeValidator - -#### Example -```js -// property name here is `dates`, then `created`, then `at` -nestedSchema = { - dates: { - created: { - at: 'date', - }, - }, -} - -input = { - dates: { - created: { - at: new Date(), - }, - }, -} - -input = new Date() -input = { - dates: { - mismatch: true, - }, -} - -``` ---- - - - - - - - -## `scopedEncase` - - - -

# scopedEncase()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3979 "View in source") [Ⓣ][1] - -Function - -#### Since -4.0.0-beta.1 - -#### Returns -*(Function)*: the method... - -#### Example -```js -const fnToEncase = arg => arg === true -const onInvalid = (error, key, arg, instance) => console.log(arguments) -const onValid = (key, arg, instance) => console.log(arguments) -const encased = scopedEncase(fnToEncase).onValid(onValid).onInvalid(onInvalid) -//=> typedOnCall - -``` ---- - - - - - - - -## `set` - - - -

# set()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L140 "View in source") [Ⓣ][1] - -(Function): Checks if `value` is classified as a `Set` object. - -#### Since -4.3.0 - -#### Returns -*(boolean)*: Returns `true` if `value` is a set, else `false`. - -#### Example -```js -isSet(new Set()) -// => true - -isSet(new WeakSet()) -// => false - -``` ---- - - - - - - - -## `set$$2` - - - -

# set$$2()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1620 "View in source") [Ⓣ][1] - -Function - -#### Since -4.0.0 - -#### Returns -*(void)*: - ---- - - - - - - - -## `setChosen` - - - -

# setChosen()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5311 "View in source") [Ⓣ][1] - -(Function): when fn is a full method, not an extended shorthand - -#### Since -0.5.0 - -#### Returns -*(*)*: .set or [keyToSet] return - -#### Example -```js -MergeChain.init(new Chain().extend(['eh'])) - -//isFunction: true => call parent[keyToSet](valueToSet) -setChosen('eh', 1) -//=> parent -parent.get('eh') -//=> 1 - -//=>isFunction: false => parent.set(keyToSet, valueToSet) -setChosen('oh', 1) -//=> parent //<- unless .set is overriden -parent.get('oh') -//=> 1 - -``` ---- - - - - - -

# setChosen()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L5353 "View in source") [Ⓣ][1] - -(Function): maybe we should not even have `.onExisting` -since we can just override merge method... -and then client can just use a custom merger... -
-
-could add and remove subscriber but that's overhead and -tricky here, because if we set a value that was just set... - ---- - - - - - - - -## `simpleKindOf` - - - -

# simpleKindOf()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L984 "View in source") [Ⓣ][1] - -(Function): when Array -> 'array' when null -> 'null' else `typeof x` - -#### Returns -*(string)*: type - ---- - - - - - - - -## `state` - - - -

# state

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2505 "View in source") [Ⓣ][1] - -(Object): Each method that takes a callback has a context *(its this object)* with these attributes: - - -### @classProps - -* {isRoot} @alias isNotRoot Whether or not the present node is a leaf node (has no children) - ---- - - - - - - - -## `stop` - - - -

# stop()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2629 "View in source") [Ⓣ][1] - -Function - -#### Returns -*(void)*: - ---- - - - - - - - -## `test` - - - -

# test

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6373 "View in source") [Ⓣ][1] - -unknown - - -### @todos - -- [ ] replace to-test - ---- - - - - - - - -## `this.extend` - - - -

# this.extend()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4436 "View in source") [Ⓣ][1] - -Function - -#### Example -```js -chain - .method('eh') - .type(`?string`) - .type(`string[]`) - .type(`string|boolean`) - .type(`boolean[]|string[]`) - .type(`!date`) - -``` ---- - - - - - - - -## `toArr` - - - -🌊 Types: deps.d  - -

# toArr()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L1514 "View in source") [Ⓣ][1] - -(Function): anything into an array - - -### @sig - -* => Array -#### Since -0.0.1 - -#### Returns -*(Array)*: anything into an array - -#### Example -```js -toarr([]) -// => [] - -toarr('') -// => [''] - -toarr('1,2') -// => ['1', '2'] - -toarr('1,2') -// => ['1', '2'] - -const map = new Map() -map.set('eh', true) -const arr = toarr(map.entries()) -// => ['eh', true] - -const set = new Set() -set.add('eh') -set.add(true) -const arr = toarr(map.entries()) -// => ['eh', true] - -toarr('').concat(toarr(false)).concat(toarr(null)) -// => ['', false, null] - -``` ---- - - - - - - - -## `toTest` - - - -

# toTest()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6868 "View in source") [Ⓣ][1] - -(Function): like matcher, but .isMatch - - -### @notes - -* as else-if for easier ternary uglification - -#### Since -3.0.0 - -#### Returns -*(boolean)*: is a match, passes the test - -#### Example -```js -matcher('kinga', 'kinga') -//=> true -matcher('k*nga', 'kinga') -//=> true -matcher('kinga', 'nope') -//=> false - -matcher(new RegExp(/kinga/), 'kinga') -//=> true -matcher(new RegExp(/kinga/), 'nope') -//=> false - -matcher(x => x === 'kinga', 'kinga') -//=> true -matcher(x => x === 'kinga', 'nope') -//=> false - -matcher({ test: x => x === 'kinga' }, 'kinga') -//=> true -matcher({ test: x => x === 'kinga' }, 'nope') -//=> false - -``` ---- - - - - - - - -## `traverse` - - - -

# traverse()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2182 "View in source") [Ⓣ][1] - -(Function): {@link https://sourcemaking.com/design_patterns/chain_of_responsibility chainofresponsibility} - -#### Example -```js -traverse({}) -//=> new Traverse(obj) - -``` ---- - - - - - -

# traverse()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7127 "View in source") [Ⓣ][1] - -(Function): traverse `this`, or `this.entries` - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -1.0.2 - -#### Returns -*(TraverseChain)*: @chainable - -#### Example -```js -TAKE FROM TRAVERSECHAIN -``` ---- - - - - - - - -## `traverse.prototype` - - - -* 🌊 Types: TraverseChain.d  -* 🌊 Types: traverse.d  - -

# traverse.prototype.eq()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L6030 "View in source") [Ⓣ][1] - -(Function): deep traversal of nodes to compare any data types does not check reference, only value equality - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @symb - -⚖️ -#### Since -3.0.0 - -#### Returns -*(boolean)*: isEqual - -#### Example -```js -eq(1, 1) -//=> true - -eq(true, false) -//=> false - -eq({}, {}) -//=> true - -``` -#### Example -```js -eq( - { d: new Date(0, 0, 0, 0), x: [1, 2, 3] }, - { d: new Date(0, 0, 0, 0), x: [1, 2, 3] } -) -//=> true - -eq([new RegExp('x')], [/x/]) -//=> true - -eq([new String('x')], ['x']) -//=> true - -eq([new Boolean(false)], [false]) -//=> true - -eq([undefined], [null]) || eq(undefined, null) -//=> false - -``` -#### Example -```js -var xs = [1, 2, 3, 4] -delete xs[2] - -var ys = Object.create(Array.prototype) -ys[0] = 1 -ys[1] = 2 -ys[3] = 4 - -eq(xs, ys) -//=> true - -eq(xs, [1, 2, undefined, 4]) -//=> false - -``` ---- - - - - - - - -## `traversed` - - - -

# traversed()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L7075 "View in source") [Ⓣ][1] - -(Function): value traversed in traverse - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Since -1.0.0 - -#### Returns -*(*)*: traversed - -#### Example -```js -const traverser = new Traverser() -traverser.obj(['duck', 'duck', 'goose']) -traverser.vals(['g**se']) -traverser.traverse() - -traverser.traversed() -//=> ['goose'] - -``` -#### Example -```js -const eh = { - me: true, - nested: { - really: { - deep: { - super: false, - not: 'eh', - canada: true, - modules: [{parser: 'hi'}], - }, - matchme: 'minime', - notme: 'eh', - }, - }, - } - - const chain = new Chain() - Object.assign(chain, eh) - - const traverser = chain - .merge(eh) - .traverse(true) - .keys([/super/, /parser/, /store/, /meta/]) - .vals([/minime/]) - .call(false) - - traverser.traversed() - //=> { - className: 'DotProp', - me: true, - nested: { - really: { - deep: { - not: 'eh', - canada: true, - modules: [{}], - }, - notme: 'eh', - }, - }, - } -``` ---- - - - - - - - -## `tryCatch` - - - -

# tryCatch()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3863 "View in source") [Ⓣ][1] - -Function - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js -#### Returns -*(*)*: validation/encased function call result - ---- - - - - - - - -## `typedOnCall` - - - -

# typedOnCall()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4013 "View in source") [Ⓣ][1] - -(Function): this is the actual built function - -#### Since -4.0.0-beta.1 - -#### Returns -*(Function): typedOnCall(argToValidate: any)* - -#### Example -```js -const encased = encase(fnToEncase) - .onValid() - .onInvalid(function) - .call() -``` ---- - - - - - - - -## `types` - - - -

# types()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L4051 "View in source") [Ⓣ][1] - -Function - -#### Returns -*(void)*: - ---- - - - - - - - -## `update` - - - -

# update()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2556 "View in source") [Ⓣ][1] - -(Function): Set a new value for the present node. -All the elements in value will be recursively traversed unless stopHere is true. - -#### Returns -*(void)*: - ---- - - - - - - - -## `updateState` - - - -

# updateState()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2653 "View in source") [Ⓣ][1] - -(Function): updates if needed: - -#### Returns -*(void)*: - ---- - - - - - - - -## `validators` - - - -

# validators

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L3271 "View in source") [Ⓣ][1] - -unknown - ---- - - - - - - - -## `values` - - - -

# values()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L600 "View in source") [Ⓣ][1] - -(Function): spreads the entries from ChainedMap.store.values allocates a new array, adds the values from the iterator - - -### @see - -* fluents/chain able/blob/master/src/deps/reduce/clean.js - -### @notes - -* look at Chainable.constructor to ensure not to use `new Array...` -* moved from ChainedMap and ChainedSet to Chainable @2.0.2 -* this was [...] & Array.from(this.store.values()) - -{@link https://kangax.github.io/compat-table/es6/#test-Array_static_methods compat-array-static-methods} -{@link https://stackoverflow.com/questions/20069828/how-to-convert-set-to-array set-to-array} -{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/values mozilla-map-values} -{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set/values mozilla-set-values} - -#### Since -0.4.0 - -#### Returns -*(*): toArr(this.store.values())* - -#### Example -```js -const chain = new Chain() -chain.set('eh', 1) -chain.values() -//=> [1] - -``` ---- - - - - - - - -## `when` - - - -

# when()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L458 "View in source") [Ⓣ][1] - -(Function): when the condition is true, trueBrancher is called, else, falseBrancher is called - -#### Returns -*(Chainable)*: @chainable - -#### Example -```js -const prod = process.env.NODE_ENV === 'production' -chains.when(prod, c => c.set('prod', true), c => c.set('prod', false)) - -``` ---- - - - - - - - -## `while` - - - -

# while()

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/dists/dev/index.js#L2883 "View in source") [Ⓣ][1] - -Function - -#### Example -```js -1 -'.eh' - 1 === '\\'(true) + 1 !== undefined(true, eh) - -``` -#### Example -```js -2 -'.eh' - 1 === '\\'(false, undefined) + 1 !== undefined(true, eh) - -``` -#### Example -```js -3 -'.' - 1 === '\\'(true) + 1 !== undefined(false, eh) - -``` ---- - - - - - - - - [1]: #/* istanbul ignore next "Jump back to the TOC." diff --git a/docs/docdown/plugins/autoGetSet.md b/docs/docdown/plugins/autoGetSet.md index d186a7f..0eaef2c 100644 --- a/docs/docdown/plugins/autoGetSet.md +++ b/docs/docdown/plugins/autoGetSet.md @@ -4,8 +4,8 @@ -## `MethodChain.prototype` -* `MethodChain.prototype.autoGetSet` +## `MethodChain` +* `MethodChain.autoGetSet` @@ -15,19 +15,21 @@ -## `MethodChain.prototype` +## `MethodChain` -

# MethodChain.prototype.autoGetSet(name=undefined, parent=undefined)

+

MethodChain.autoGetSet(name=undefined, parent=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/plugins/autoGetSet.js#L24 "View in source") [Ⓣ][1] Function -### @see +#### @see -* fluents/chain able/blob/master/src/method chain.js +* fluents/chain able/blob/master/src/method chain.js #### Arguments 1. `name=undefined` *(Primitive)*: method name being built 2. `parent=undefined` *(Object)*: parent containing the method @@ -54,4 +56,4 @@ chain.eh() - [1]: #methodchain.prototype "Jump back to the TOC." + [1]: #methodchain "Jump back to the TOC." diff --git a/docs/docdown/plugins/autoIncrement.md b/docs/docdown/plugins/autoIncrement.md index 40fbc2e..cf1ab44 100644 --- a/docs/docdown/plugins/autoIncrement.md +++ b/docs/docdown/plugins/autoIncrement.md @@ -5,7 +5,7 @@ ## `exports` -* `exports` +* `exports` @@ -19,7 +19,9 @@ -

# exports(name=undefined, parent=undefined)

+

exports(name=undefined, parent=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/plugins/autoIncrement.js#L7 "View in source") [Ⓣ][1] Function diff --git a/docs/docdown/plugins/decorate.md b/docs/docdown/plugins/decorate.md index 436881b..b60ab34 100644 --- a/docs/docdown/plugins/decorate.md +++ b/docs/docdown/plugins/decorate.md @@ -4,8 +4,8 @@ -## `MethodChain.prototype` -* `MethodChain.prototype.exports` +## `MethodChain` +* `MethodChain.exports` @@ -15,28 +15,31 @@ -## `MethodChain.prototype` +## `MethodChain` -

# MethodChain.prototype.exports(parentToDecorate=undefined)

-[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/plugins/decorate.js#L29 "View in source") [Ⓣ][1] +

MethodChain.exports(parentToDecorate=undefined)

+
+
+[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/plugins/decorate.js#L28 "View in source") [Ⓣ][1] (Function): decorates a parent when the argument is provided BUT THE FUNCTIONS WILL STILL BE SCOPED TO CURRENT PARENT for easy factory chaining -### @see +#### @see -* fluents/chain able/blob/master/src/method chain.js +* fluents/chain able/blob/master/src/method chain.js -### @todos +#### @todos - [ ] this is more like a preset since it *adds* plugins? more of methodFactory now -#### Since + +#### @Since 4.0.0-alpha.1 #### Arguments @@ -62,4 +65,4 @@ typeof obj.ehOh - [1]: #methodchain.prototype "Jump back to the TOC." + [1]: #methodchain "Jump back to the TOC." diff --git a/docs/docdown/plugins/encase.md b/docs/docdown/plugins/encase.md index ec75522..d31dda2 100644 --- a/docs/docdown/plugins/encase.md +++ b/docs/docdown/plugins/encase.md @@ -5,21 +5,21 @@ ## `methodEncasingFactory` -* `methodEncasingFactory` +* `methodEncasingFactory` ## `scopedEncase` -* `scopedEncase` +* `scopedEncase` ## `typedOnCall` -* `typedOnCall` +* `typedOnCall` @@ -33,7 +33,11 @@ -

# methodEncasingFactory(name=undefined, parent=undefined, built=undefined)

+🌊 Types: deps.encase.d  + +

methodEncasingFactory(name=undefined, parent=undefined, built=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/plugins/encase.js#L30 "View in source") [Ⓣ][1] (Function): 3 steps @@ -42,10 +46,11 @@ 2. build a function to call onInvalid or onInvalid depending -### @symb +#### @symb ⛑🏭 -#### Since + +#### @Since 4.0.0 #### Arguments @@ -74,12 +79,15 @@ methodEncasingFactory('eh', {}, { onSet: console.log }) -

# scopedEncase(fnToEncase=undefined, [type=undefined], [specification=undefined])

+

scopedEncase(fnToEncase=undefined, [type=undefined], [specification=undefined])

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/plugins/encase.js#L53 "View in source") [Ⓣ][1] Function -#### Since + +#### @Since 4.0.0-beta.1 #### Arguments @@ -111,12 +119,15 @@ const encased = scopedEncase(fnToEncase).onValid(onValid).onInvalid(onInvalid) -

# typedOnCall(arg=undefined)

+

typedOnCall(arg=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/plugins/encase.js#L87 "View in source") [Ⓣ][1] (Function): this is the actual built function -#### Since + +#### @Since 4.0.0-beta.1 #### Arguments diff --git a/docs/docdown/plugins/getterOnSet.md b/docs/docdown/plugins/getterOnSet.md new file mode 100644 index 0000000..875d05a --- /dev/null +++ b/docs/docdown/plugins/getterOnSet.md @@ -0,0 +1,11 @@ +# getterOnSet.js API documentation + + + + + + + + + + [1]: # "Jump back to the TOC." diff --git a/docs/docdown/plugins/schema.md b/docs/docdown/plugins/schema.md index 5129520..4dd4a45 100644 --- a/docs/docdown/plugins/schema.md +++ b/docs/docdown/plugins/schema.md @@ -5,7 +5,7 @@ ## `exports` -* `exports` +* `exports` @@ -19,7 +19,9 @@ -

# exports(obj=undefined)

+

exports(obj=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/plugins/schema.js#L37 "View in source") [Ⓣ][1] (Function): handles:
1. recursively building nestable schemas, 2. creating MethodChains for all types 3. carrying over the inheritable properties 4. @modifies @injects @decorates .add(customValidators) diff --git a/docs/docdown/plugins/types.md b/docs/docdown/plugins/types.md index 7ca91d7..0513fd0 100644 --- a/docs/docdown/plugins/types.md +++ b/docs/docdown/plugins/types.md @@ -5,7 +5,7 @@ ## `exports` -* `exports` +* `exports` @@ -19,7 +19,9 @@ -

# exports(name=undefined, parent=undefined, built=undefined)

+

exports(name=undefined, parent=undefined, built=undefined)

+
+
[Ⓢ](https://github.com/fluents/chain-able/blob/master/src/plugins/types.js#L18 "View in source") [Ⓣ][1] Function diff --git a/docs/examples/readme.md b/docs/examples/readme.md index 8a9b8f1..b2e895c 100644 --- a/docs/examples/readme.md +++ b/docs/examples/readme.md @@ -1,34 +1,73 @@ +- [🔗 playground - super small files using features - adapted from tests](https://aretecode.github.io/chain-able-playground/) +- [🔗 jsfiddle with Inferno](https://jsfiddle.net/wqxuags2/28/) + + ## who uses it? + + - [fliplog][fliplog]: fluent logging with verbose insight, colors, tables, emoji, filtering, spinners, progress bars, timestamps, capturing, stack traces, tracking, presets, & more... - [lego-api][lego-api] renders the infinitely nestable permutations of conditionals for [fuse-box][fuse-box] so only what you use is included in the bundled api - [d-l-l][d-l-l] makes your webpack build faster, in just a few lines, without having to waste time with the tedious manual configuration steps required to use the DLLPlugin - [webpack-split-plugin][webpack-split-plugin] easily split bundles into multiple pieces with custom specifications - [bench-chain][bench-chain] benchmark recording - averages & graphs. - [cli-chain][cli-chain] easy, powerful, interactive, infinitely nestable fluent cli builder. -- [awesome-fluents][awesome-fluents] more awesome fluents/chains +- [awesome-fluents][awesome-fluents] more awesome fluents/chains. - [funwithflags][funwithflags] parse argument options. minimist in es6. - [chain-able-find][chain-able-find] globby-compatible api, faster, & fluent. +- [chain-able-md][chain-able-md] markdown builder with a fluent api, used to create chain-able docs. +- [frisbee-chain][frisbee-chain] fetch api enhancer with Frisbee, as-a-chain. + + ## [examples](https://github.com/fluents/chain-able/tree/master/examples) -- [playground - super small files using features - adapted from tests](https://aretecode.github.io/chain-able-playground/) - - data type + schema - - define - - encase - - merging - - observing - - LocalStorage +- `MethodChain` _examples using method chains_ + - [data type + schema][schema] + - [define][define] + - [encase][encase] + - [merging][merging] + - [compose][compose] + - [observing][observe] -- minis - really mini projects for examples - - decorators (making a chain that can be used to build decorators that work for all combinations*) - - SwitchChain - making `switch {}` as a chain for fun -- typescript (for intelisense demo) -- decorators (for es6 transpiling experimenting) -- bundler configs (works by default, but easier the better) -- eventually (todo): - - Events - will be an eventsource example - - React & MobX - - Routing - - FileSystem stuff on nodejs +- **minis** _really mini projects for examples_ + - [`DecoratorChain`][DecoratorChain] (making a chain that can be used to build decorators that work for all combinations*) + - [`SwitchChain`][SwitchChain] - making `switch(condition) {}` as-a-chain, for fun + - [`RegExpChain`][RegExpChain] - _fluent RegExp building with english words instead of symbols_ + - [`ObjectDefineChain`][ObjectDefineChain] - _simple example with `Object.define` as-a-chain_ +- [typescript][examples_ts] (_for intelisense demo_) +- [decorators][examples_decorators] (for es6 transpiling experimenting) +- **State** + - [Inferno/React state][examples_react_state] (_for intelisense demo_) + - [TodoStore][TodoStore] (_react state store as a todostore_) + - [LocalStorage][localStorage] +- **nodejs** + - [Comments][examples_commentchain] (_another schema example_) +- @TODO: + - Events: _an eventsource example_ + - chain-able-fs: _FileSystem stuff on nodejs_ + - Proxy: _minimal easy creation of chain-able with Proxies, slower, but shorter_ + - React & MobX: _more state chain examples_ + - Routing: _browser html routing, as a module later_ + + +[chain-able-md]: https://github.com/fluents/chain-able/blob/master/_modules/_chain-able-md/src/index.js +[webpack-split-plugin]: https://github.com/aretecode/webpack-split-plugin +[frisbee-chain]: https://github.com/fluents/chain-able/tree/master/examples +[examples_commentchain]: https://github.com/fluents/chain-able/tree/master/examples/packages/node/index.js +[localStorage]: https://github.com/fluents/chain-able/tree/master/examples/packages/playground/localStorage.js +[compose]: https://github.com/fluents/chain-able/tree/master/examples/packages/playground/compose.js +[observe]: https://github.com/fluents/chain-able/tree/master/examples/packages/playground/observe.js +[define]: https://github.com/fluents/chain-able/tree/master/examples/packages/playground/define.js +[encase]: https://github.com/fluents/chain-able/tree/master/examples/packages/playground/encase.js +[merging]: https://github.com/fluents/chain-able/tree/master/examples/packages/playground/merge.js +[schema]: https://github.com/fluents/chain-able/tree/master/examples/packages/playground/schema.js +[TodoStore]: https://github.com/fluents/chain-able/tree/master/examples/packages/playground/TodoStore.js +[examples_react_state]: examples_react_state +[examples_decorators]: examples_decorators +[examples_ts]: examples_ts +[DecoratorChain]: https://github.com/fluents/chain-able/tree/master/examples/packages/minis/DecoratorChain.js +[ObjectDefineChain]: https://github.com/fluents/chain-able/tree/master/examples/packages/minis/ObjectDefineChain.js +[SwitchChain]: https://github.com/fluents/chain-able/tree/master/examples/packages/minis/SwitchChain.js +[RegExpChain]: https://github.com/fluents/chain-able/tree/master/examples/packages/minis/RegExp.js [d-l-l]: https://github.com/fliphub/d-l-l [chain-able-find]: https://github.com/fluents/chain-able-find diff --git a/examples/packages/minis/decorators.js b/examples/packages/minis/DecoratorChain.js similarity index 100% rename from examples/packages/minis/decorators.js rename to examples/packages/minis/DecoratorChain.js diff --git a/examples/packages/minis/ObjectDefineChain.js b/examples/packages/minis/ObjectDefineChain.js new file mode 100644 index 0000000..b44a46d --- /dev/null +++ b/examples/packages/minis/ObjectDefineChain.js @@ -0,0 +1,149 @@ +const {Chain, isUndefined, isFunction, isObj, isReal, isBoolean} = require('../../../src') + +const booleanMethods = ['configurable', 'enumerable'] +const allReal = x => x.filter(isReal).length === x.length + +// @TODO: all statics +class ObjectDefineChain extends Chain { + constructor(parent) { + super(parent) + + // normal methods + this + .methods(['obj', 'value', 'prop']) + .build() + + const onInvalid = () => { + console.log('must provide a boolean to ' + booleanMethods.join(',')) + } + + // default all params to `true` and all initial values `true` + this + .methods(booleanMethods) + .default(true) + .initial(true) + .type('boolean') + .onInvalid(onInvalid) + .build() + + // do not want to define writable by default, + // it is different since you cannot use it with get set + this + .method('writable') + .type('boolean') + .onInvalid(onInvalid) + .build() + + // -------- + // only needed because get & set are keywords for chainable/maps + const get = this.get.bind(this) + const set = this.set.bind(this) + + this.get = keyOrFunction => { + // setting `.get` + if (isFunction(keyOrFunction)) { + return set('get', keyOrFunction) + } + // normal `key` + else { + return get(keyOrFunction) + } + } + + // if we pass in `function` without `value` = `set` + this.set = (keyOrFunction, value) => { + if (isUndefined(value) && isFunction(keyOrFunction)) { + return set('set', keyOrFunction) + } + else { + // console.log('HAD VALUE DAMNIT', value) + return set(keyOrFunction, value) + } + } + } + + descriptor(descriptor) { + return this.from(descriptor) + } + + // @TODO validate on development env when using .get & .set & .value + // when we pass in an object, it can be the shorthand way to do a define + define(optionalObj) { + if (isObj(optionalObj)) this.obj(optionalObj) + + const { + obj, + configurable, + enumerable, + writable, + set, + get, + value, + prop, + } = this.entries() + + const descriptor = {configurable, enumerable} + + // could also do + // this.observe(['get', 'set', 'value'], x => { + // if (x.get && x.set && x.value) { + // throw new Error('cannot provide get set and value') + // } + // }) + // + // debug + if (this.get('debug')) { + if (allReal([get, set, value])) { + throw new Error('cannot provide get set and value') + } + } + + // can only use .value or .get + .set + if (isFunction(get)) descriptor.get = get + if (isFunction(set)) descriptor.set = set + if (isReal(value)) descriptor.value = value + if (isBoolean(writable)) descriptor.writable = writable + + Object.defineProperty(obj, prop, descriptor) + return this + } +} + + +const invalidD = new ObjectDefineChain() +const getSetD = new ObjectDefineChain() +const fromD = new ObjectDefineChain() + +function onGet() {} +function onSet() {} +const value = true +const obj = {} + +try { + invalidD + .debug(true) + .value(value) + .get(onGet) + .set(onSet) + .define(obj) +} +catch (e) { + +} + +getSetD + .configurable() + .enumerable() + .prop('eh') + .get(onGet) + .set(onSet) + .define(obj) + +fromD + .prop('from') + .descriptor({value: true, writable: true, enumerable: false}) + .define(obj) + + +require('fliplog').data({obj}).echo() +//=> obj: { eh: [Getter/Setter], from: true } } diff --git a/examples/packages/minis/RegExp.js b/examples/packages/minis/RegExp.js new file mode 100644 index 0000000..4174d61 --- /dev/null +++ b/examples/packages/minis/RegExp.js @@ -0,0 +1,505 @@ +// https://github.com/thebinarysearchtree/regexpbuilderjs +// https://github.com/VerbalExpressions/JSVerbalExpressions +const {Chain, isUndefined, isString, isEmpty} = require('chain-able') + +function sanitize(s) { + return s.replace(/([.*+?^=!:${}()|\[\]\/\\])/g, '\\$1') +} + +const lettersUpperCase = 'A-Z' +const lettersLowerCase = 'a-z' +const lettersUpperAndLower = lettersUpperCase + lettersLowerCase +const digit = '(?:\\d)' +const nonDitit = '(?:\\D)' +const start = '(?:^)' +const end = '(?:$)' +const newLine = '(?:\\r\\n|\\r|\\n)' + +class RegExpBuilder extends Chain { + constructor(parent) { + super() + + // this.methods(['flags', 'literal']).autoGetSet().build() + this.method('groupsUsed').autoIncrement().build() + + // ------- + // string type so adding is autoMerge plugin type thing :-) + this.flags = arg => { + if (isUndefined(arg)) return this.get('flags') + const flags = this.get('flags') + arg + return this.set('flags', flags) + } + // default/initial + this.set('flags', '') + // ------- + // ------- + this.addLiteral = this.literal = arg => { + if (isUndefined(arg)) return this.get('literal') + const literal = this.get('literal').push(arg) + return this.set('literal', literal) + } + this.set('literal', []) + // ------- + + this.transform(['of', ''], sanitize) + + // this._flags = '' + // this._literal = [] + // this._groupsUsed = 0 + + this._clear() + } + + // ------------------ data ------------------ + + // -------------- config -------------- + + neither(r) { + if (isString(r)) { + return this.notAhead(new RegExpBuilder().exactly(1).of(r)) + } + return this.notAhead(r) + } + + nor(r) { + if (this.get('min') === 0 && this.get('ofAny')) { + this.min(-1).ofAny(false) + } + + return this.neither(r).min(0).ofAny() + } + + exactly(n) { + return this._flushState().min(n).max(n) + } + + optional(r) { + this.max(1) + const like = this._combineGroupNumberingAndGetLiteral(r) + return this.like(like) + } + + ignoreCase() { + return this._addFlag('i') + } + + multiLine() { + return this._addFlag('m') + } + + globalMatch() { + return this._addFlag('g') + } + + startOfInput() { + return this.addLiteral() + } + + startOfLine() { + return this.multiLine().startOfInput() + } + + endOfInput() { + return this._flushState().addLiteral(end) + } + + endOfLine() { + return this.multiLine().endOfInput() + } + + either(r) { + if (isString(r)) { + return this._eitherLike(new RegExpBuilder().exactly(1).of(r)) + } + else { + return this._eitherLike(r) + } + } + + or(r) { + if (isString(r)) { + return this._orLike(new RegExpBuilder().exactly(1).of(r)) + } + else { + return this._orLike(r) + } + } + + min(min) { + return this._flushState().set('min', min) + } + + max(max) { + return this._flushState().set('max', max) + } + + of(s) { + return this.set('of', s) + // this._of = this._sanitize(s) + // return this + } + + ofAny(ofAny = true) { + return this.set('ofAny', ofAny) + } + + ofGroup(n) { + return this.set('ofGroup', n) + } + + from(s) { + const from = this._sanitize(s.join('')) + return this.set('from', from) + } + notFrom(s) { + const notFrom = this._sanitize(s.join('')) + return this.set('notFrom', notFrom) + } + + like(r) { + const like = this._combineGroupNumberingAndGetLiteral(r) + return this.set('like', like) + } + + reluctantly() { + return this.set('reluctant', true) + } + + ahead(r) { + return this._flushState().addLiteral( + '(?=' + this._combineGroupNumberingAndGetLiteral(r) + ')' + ) + } + + notAhead(r) { + this._flushState() + this.addLiteral('(?!' + this._combineGroupNumberingAndGetLiteral(r) + ')') + return this + } + + asGroup() { + return this.groupsUsed(+1).set('capture', true) + } + + then(s) { + return this.exactly(1).of(s) + } + + find(s) { + return this.then(s) + } + + some(s) { + return this.min(1).from(s) + } + + maybeSome(s) { + return this.min(0).from(s) + } + + maybe(s) { + return this.max(1).of(s) + } + + something() { + return this.min(1).ofAny() + } + + anything() { + return this.min(0).ofAny() + } + + anythingBut(s) { + if (s.length === 1) { + return this.min(0).notFrom([s]) + } + + this.notAhead(new RegExpBuilder().exactly(1).of(s)) + return this.min(0).ofAny() + } + + any() { + return this.exactly(1).ofAny() + } + + lineBreak() { + return this._flushState().addLiteral(newLine) + } + + lineBreaks() { + return this.like(new RegExpBuilder().lineBreak()) + } + + whitespace() { + const min = this.get('min') + const max = this.get('max') + + if (min === -1 && max === -1) { + return this._flushState().addLiteral('(?:\\s)') + } + + return this.set('like', '\\s') + } + + notWhitespace() { + const min = this.get('min') + const max = this.get('max') + + if (min === -1 && max === -1) { + return this._flushState().addLiteral('(?:\\S)') + } + + return this.like('\\S') + } + + tab() { + return this._flushState().addLiteral('(?:\\t)') + } + + tabs() { + return this.like(new RegExpBuilder().tab()) + } + + digit() { + return this._flushState().addLiteral(digit) + } + + notDigit() { + return this._flushState().addLiteral(nonDitit) + } + + digits() { + return this.like(new RegExpBuilder().digit()) + } + + notDigits() { + return this.like(new RegExpBuilder().notDigit()) + } + + letter() { + return this.exactly(1).letters() + } + letters() { + return this.set('from', lettersUpperAndLower) + } + + notLetter() { + return this.exactly(1).notLetters() + } + notLetters() { + return this.set('notFrom', 'A-Za-z') + } + + lowerCaseLetter() { + return this.exactly(1).lowerCaseLetters() + } + lowerCaseLetters() { + return this.set('from', 'a-z') + } + + upperCaseLetter() { + return this.exactly(1).upperCaseLetters() + } + upperCaseLetters() { + return this.set('from', 'A-Z') + } + + append(r) { + this.exactly(1) + this._like = this._combineGroupNumberingAndGetLiteral(r) + return this + } + + // -------------------------------------- + // ----------- private ------------------ + // -------------------------------------- + + _clear() { + // @TODO would be better as .delete + return this.min(-1) + .max(-1) + .of('') + .ofAny(false) + .ofGroup(-1) + .from('') + .notFrom('') + .like('') + .either('') + .reluctant(false) + .capture(false) + } + + _flushState() { + const _of = this.get('of') + const ofAny = this.get('ofAny') + const ofGroup = this.get('ofGroup') + const notFrom = this.get('notFrom') + const from = this.get('from') + const like = this.get('like') + const capture = this.get('capture') + const reluctant = this.get('reluctant') + + const hasValidState = + ofAny || + ofGroup > 0 || + !isEmpty(_of) || + !isEmpty(from) || + !isEmpty(notFrom) || + !isEmpty(like) + + if (hasValidState) { + const captureLiteral = capture ? '' : '?:' + const reluctantLiteral = reluctant ? '?' : '' + const quantityLiteral = this._getQuantityLiteral() + const characterLiteral = this._getCharacterLiteral() + + const literal = + '(' + + captureLiteral + + '(?:' + + characterLiteral + + ')' + + quantityLiteral + + reluctantLiteral + + ')' + + this.addLiteral(literal) + this._clear() + } + } + + _getQuantityLiteral() { + const min = this.get('min') + const max = this.get('max') + + if (min !== -1) { + if (max !== -1) { + return '{' + min + ',' + max + '}' + } + return '{' + min + ',}' + } + else { + return '{0,' + max + '}' + } + } + + _getCharacterLiteral() { + if (!isEmpty(this.get('of'))) { + return this.get('of') + } + else if (this.get('ofAny')) { + return '.' + } + else if (this.get('ofGroup') > 0) { + return '\\' + this.get('ofGroup') + } + else if (!isEmpty(this.get('from'))) { + return '[' + this.get('from') + ']' + } + else if (!isEmpty(this.get('notFrom'))) { + return '[^' + this.get('notFrom') + ']' + } + else if (!isEmpty(this.get('like'))) { + return this.get('like') + } + } + + getLiteral() { + return this._flushState().get('literal').join('') + } + + _combineGroupNumberingAndGetLiteral(r) { + const literal = this._incrementGroupNumbering( + r.getLiteral(), + this.get('groupsUsed') + ) + this.tap('groupsUsed', used => used + r._groupsUsed) + return literal + } + + _incrementGroupNumbering(literal, increment) { + if (increment > 0) { + literal = literal.replace(/[^\\]\\\d+/g, function(groupReference) { + const groupNumber = parseInt(groupReference.substring(2)) + increment + return groupReference.substring(0, 2) + groupNumber + }) + } + return literal + } + + getRegExp() { + this._flushState() + + const literal = this.get('literal').join('') + const flags = this.get('flags') + return new RegExp(literal, flags) + } + + _addFlag(flag) { + const flags = this.get('flags') + if (!flags.includes(flag)) this.addFlag(flag) + + return this + } + + _eitherLike(r) { + this._flushState() + const eitherLike = this._combineGroupNumberingAndGetLiteral(r) + return this.either(eitherLike) + } + + _orLike(r) { + const either = this.get('either') + const or = this._combineGroupNumberingAndGetLiteral(r) + + if (isEmpty(either)) { + const literal = this.getLiteral() + let lastLiteralIndex = lastIndex(literal) + let lastOr = literal[lastLiteralIndex] + lastOr = lastOr.substring(0, lastLiteralIndex) + + literal[lastLiteralIndex] = lastOr + this.addLiteral('|(?:' + or + '))') + } + else { + this.addLiteral('(?:(?:' + either + ')|(?:' + or + '))') + } + + return this._clear() + } +} + +RegExpBuilder.ignoreCase = () => new RegExpBuilder().ignoreCase() +RegExpBuilder.multiLine = () => new RegExpBuilder().multiLine() +RegExpBuilder.globalMatch = () => new RegExpBuilder().globalMatch() +RegExpBuilder.startOfInput = () => new RegExpBuilder().startOfInput() +RegExpBuilder.startOfLine = () => new RegExpBuilder().startOfLine() +RegExpBuilder.endOfInput = () => new RegExpBuilder().endOfInput() +RegExpBuilder.endOfLine = () => new RegExpBuilder().endOfLine() +RegExpBuilder.either = (r) => new RegExpBuilder().either(r) +RegExpBuilder.neither = (r) => new RegExpBuilder().neither(r) +RegExpBuilder.exactly = (n) => new RegExpBuilder().exactly(n) +RegExpBuilder.min = (n) => new RegExpBuilder().min(n) +RegExpBuilder.max = (n) => new RegExpBuilder().max(n) +RegExpBuilder.ahead = (r) => new RegExpBuilder().ahead(r) +RegExpBuilder.notAhead = (r) => new RegExpBuilder().notAhead(r) +RegExpBuilder.then = (s) => new RegExpBuilder().then(s) +RegExpBuilder.find = (s) => new RegExpBuilder().find(s) +RegExpBuilder.some = (s) => new RegExpBuilder().some(s) +RegExpBuilder.maybeSome = (s) => new RegExpBuilder().maybeSome(s) +RegExpBuilder.maybe = (s) => new RegExpBuilder().maybe(s) +RegExpBuilder.anything = () => new RegExpBuilder().anything() +RegExpBuilder.anythingBut = (s) => new RegExpBuilder().anythingBut(s) +RegExpBuilder.any = () => new RegExpBuilder().any() +RegExpBuilder.lineBreak = () => new RegExpBuilder().lineBreak() +RegExpBuilder.whitespace = () => new RegExpBuilder().whitespace() +RegExpBuilder.notWhitespace = () => new RegExpBuilder().notWhitespace() +RegExpBuilder.tab = () => new RegExpBuilder().tab() +RegExpBuilder.digit = () => new RegExpBuilder().digit() +RegExpBuilder.notDigit = () => new RegExpBuilder().notDigit() +RegExpBuilder.letter = () => new RegExpBuilder().letter() +RegExpBuilder.notLetter = () => new RegExpBuilder().notLetter() +RegExpBuilder.lowerCaseLetter = () => new RegExpBuilder().lowerCaseLetter() +RegExpBuilder.upperCaseLetter = () => new RegExpBuilder().upperCaseLetter() +RegExpBuilder.append = (r) => new RegExpBuilder().append(r) +RegExpBuilder.optional = (r) => new RegExpBuilder().optional(r) diff --git a/examples/packages/minis/SwitchChain.js b/examples/packages/minis/SwitchChain.js new file mode 100644 index 0000000..62bec36 --- /dev/null +++ b/examples/packages/minis/SwitchChain.js @@ -0,0 +1,113 @@ +const {Chain, ChainedSet, merge, eq, is} = require('../../../') + +const {isFunction, isBoolean, isArray, isString, isNull} = is +const ignoredTypes = ['null', 'undefined', 'NaN'] +const simpleKindOf = x => (isArray(x) ? 'array' : isNull(x) ? 'null' : typeof x) + +// @TODO find the other SwitchChain that also has break? +// needs more checks +class Switch extends Chain { + constructor(value) { + super(value) + this.cases = new ChainedSet(this) + this.value = this.parent + } + + static on(value) { + return new Switch(value) + } + + // could be decorate + case(value, cb) { + let check = () => { + if (eq(this.value, value)) { + return cb() + } + return false + } + + if (isFunction(value)) { + check = value + } + + if (isBoolean(value)) { + check = () => { + if (value) { + return cb() + } + return false + } + } + + this.cases.add(check) + + return this + } + + // auto ending + default(cb) { + return this.set('default', cb).end() + } + + end() { + for (let [condition] of this.cases) { + const result = condition() + if (result) return result + } + + return this.get('default')() + } +} + +// could use say matcher super easily but the point is +// being able to use the array, since === would not work with an array usually +function DopeSwitch(one, two) { + const types = [one, two].map(simpleKindOf) + const [type1, type2] = types + + if (ignoredTypes.includes(type1)) return two + if (ignoredTypes.includes(type2)) return one + + /* prettier-ignore */ + const result = Switch + .on(types) + // strings[] + .case(['string', 'string'], () => one + two) + .case(['array', 'string'], () => one.concat([two])) + .case(['string', 'array'], () => two.concat([one])) + // primitives + .case(['string', 'number'], () => [one, two]) + .case(['number', 'string'], () => [one, two]) + .case(['number', 'boolean'], () => [one, two]) + .case(['boolean', 'string'], () => [one, two]) + .case(['boolean', 'number'], () => [one, two]) + // boolean[] + .case(['boolean', 'boolean'], () => one) + .case(['array', 'boolean'], () => one.concat([two])) + .case(['boolean', 'array'], () => one.concat([two])) + // number[] + .case(['number', 'number'], () => one + two) + .case(['array', 'number'], () => one.concat([two])) + .case(['number', 'array'], () => one.concat([two])) + // concat + .default(() => merge(one, two)) + + return result +} + +function DopeSwitchDebug(one, two) { + const key = String([one, two]) + return {[key]: DopeSwitch(one, two)} +} + +const merges = [ + DopeSwitchDebug(1, 1), + DopeSwitchDebug('1', 1), + DopeSwitchDebug([], 100), + DopeSwitchDebug({}, {eh: true}), + DopeSwitchDebug([], []), + DopeSwitchDebug([], {}), + DopeSwitchDebug(['duck', 'duck', 'duck'], ['goose']), +] + +console.log(merges) diff --git a/package.json b/package.json index 5e85509..e3f04bb 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "chain-able", - "version": "5.0.0", + "version": "5.0.0-beta.4", "description": "interfaces that describe their intentions.", "main:es6": "src/index.js", "main:dev": "dists/dev/index.js", @@ -94,7 +94,9 @@ "sourceMap": true, "instrument": false, "cache": false, - "include": ["./dist/**/*.js"], + "include": [ + "./dist/**/*.js" + ], "exclude": [ "_todos/**", "_play/**", @@ -109,19 +111,28 @@ "test-dist/built.js", "test-dist/chainsaw/*.js" ], - "_require": ["babel-register", "babel-core/register"], + "_require": [ + "babel-register", + "babel-core/register" + ], "lines": 85, "statements": 85, "functions": 85, "branches": 70, - "extension": [".js"], - "reporter": ["lcov", "html", "text"] + "extension": [ + ".js" + ], + "reporter": [ + "lcov", + "html", + "text" + ] }, "jest": { "transformIgnorePatterns": [ "/node_modules/", - "/_", - "/examples", + "/_/", + "/examples/", "/src/deps/_r|meta|external|env|primitives/", "/src/deps/external/lodash/", "/src/deps/external/", @@ -146,10 +157,18 @@ "watch": false, "cache": true, "setupTestFrameworkScriptFile": "./test/__testsetup.js", - "collectCoverageFrom": ["src/**/*.js", "test/**/*.js"], + "collectCoverageFrom": [ + "src/**/*.js", + "test/**/*.js" + ], "coveragePathIgnorePatterns": [ "\\\\node_modules\\\\", "_modules", + "src/deps/to|string/*.js", + "src/deps/array/insertAtIndex.js", + "src/deps/conditional/eqeq.js", + "src/deps/traversers/stringify.js", + "src/plugins/getterOnSet.js", "src/deps/_r|meta|external|env|primitives", "src/deps/external/lodash", "src/deps/external", @@ -161,6 +180,8 @@ "src/deps/util/flatten|charCodeAtZero.js", "src/deps/is/class|node|stringOrNumber.js", "src/deps/reduce/objects.js", + "src/deps/fp/fp.js", + "src/deps/fp/index.js", "src/deps/symbols/index|species|spreadable.js", "src/deps/index|uniq|eqCurry|typeof|insert-at-index|nonEnumerableTypes.js", "src/compose/decorators.js", @@ -170,11 +191,16 @@ "src/plugins/index|plugins.js", "COMMENT/ignore-below-pass-along-indexes.COMMENT", "src/is|dopemerge|matcher|validators|encase|dot|includes|cache|compose|reduce/index.js", - "src/deps/is|dopemerge|matcher|validators|encase|dot|includes|cache|compose|reduce/index.js", + "src/deps/fp|is|dopemerge|matcher|validators|encase|dot|includes|cache|compose|reduce/index.js", "src/index.web.js", "src/index.js" ], - "coverageReporters": ["json", "text", "lcov", "clover"], + "coverageReporters": [ + "json", + "text", + "lcov", + "clover" + ], "automock": false, "bail": false, "browser": false, @@ -194,14 +220,22 @@ ] }, "ava": { - "files": ["!index.*.js", "test-dist/*.js"], - "source": ["dist/**", "!src/**/*"], + "files": [ + "!index.*.js", + "test-dist/*.js" + ], + "source": [ + "dist/**", + "!src/**/*" + ], "verbose": true, "concurrency": 3, "failFast": false, "failWithoutAssertions": false, "powerAssert": true, - "require": ["babel-core/register"], + "require": [ + "babel-core/register" + ], "babel": "inherit" }, "_optionalDependencies": { @@ -209,9 +243,6 @@ "memwatch-next": "^0.3.0" }, "devDependencies": { - "humanize-url": "^1.0.1", - "humanize-string": "^1.0.1", - "string": "^3.3.3", "@types/node": "^7.0.31", "acorn": "^5.0.3", "acorn-dynamic-import": "^2.0.2", @@ -248,17 +279,24 @@ "funwithflags": "^1.0.2", "fuse-box": "2.2.0-beta.21", "gzip-size-cli": "^2.0.0", + "humanize-string": "^1.0.1", + "humanize-url": "^1.0.1", "immutable": "^3.8.1", "inspector-gadget": "^1.0.0", "jest": "^20.0.4", "jest-benchmark": "^0.0.0", + "js-beautify": "^1.6.14", + "jssmartcheck": "^0.2.3", + "jsverify": "^0.8.2", "lodash": "^4.17.4", "marked": "^0.3.6", "mobx": "^3.1.14", "module-alias": "^2.0.0", "nyc": "^10.3.2", "optimize-js": "^1.0.3", + "preact": "^8.2.1", "ramda": "^0.24.1", + "react": "^15.6.1", "rimraf": "^2.6.1", "rollup": "^0.43.0", "rollup-plugin-babili": "^3.0.0", @@ -272,6 +310,7 @@ "rollup-plugin-typescript2": "^0.4.4", "rollup-plugin-uglify": "^2.0.1", "script-chain": "^0.0.9", + "string": "^3.3.3", "traverse": "^0.6.6", "treeify": "^1.0.1", "tslint": "^5.4.3", diff --git a/src/Chainable.js b/src/Chainable.js index c9207a2..de3d677 100644 --- a/src/Chainable.js +++ b/src/Chainable.js @@ -8,11 +8,13 @@ const isUndefined = require('./deps/is/undefined') const isFunction = require('./deps/is/function') const isString = require('./deps/is/string') const isFalse = require('./deps/is/false') +const noop = require('./deps/util/noop') const ObjectKeys = require('./deps/util/keys') const ObjectDefine = require('./deps/define') -const ignored = require('./deps/ignored') +const ignored = require('./deps/meta/ignored') const ENV_DEVELOPMENT = require('./deps/env/dev') +// @TODO change from `||` to if else const shouldClear = (key, property) => !ignored(key) && (isMap(property) || isSet(property) || (property && property.store)) @@ -45,6 +47,7 @@ const ComposeChainable = Target => { * * @tests Chainable * @types Chainable + * */ class Chainable extends Target { /** @@ -78,11 +81,13 @@ const ComposeChainable = Target => { * @return {Object} {value: undefined | any, done: true | false} * * @NOTE assigned to a variable so buble ignores it + * + * * @see https://github.com/sindresorhus/quick-lru/blob/master/index.js * @see https://stackoverflow.com/questions/36976832/what-is-the-meaning-of-symbol-iterator-in-this-context * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/iterator - * @tests iteration * @see this.store + * @tests iteration * * @example * @@ -222,6 +227,9 @@ const ComposeChainable = Target => { * @see ChainedSet * @see ChainedMap * + * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/clear map-clear} + * @see {@link map-clear} + * * @example * * const chain = new Chain() @@ -278,13 +286,15 @@ const ComposeChainable = Target => { } /** - * @since 0.3.0 + * @desc checks whether the store has a value for a given key * @memberOf Chainable + * @since 0.3.0 * * @param {any} keyOrValue key when Map, value when Set * @return {boolean} * - * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/has + * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/has map-has} + * @see {@link map-has} * * @example * @@ -336,32 +346,20 @@ const ComposeChainable = Target => { let i = 0 this.store.forEach(v => (allocated[i++] = v)) return allocated - - // const size = this.store.size - // const allocated = new Array(size) - // // .forEach((value, index) => { - // - // const values = this.store.values() - // - // for (let index = 0; index < size; index++) { - // // const value = values[index] - // const value = values.next().value - // // console.log({value, index, values}) - // allocated[index] = value - // } - // - // return allocated } /** - * @see http://2ality.com/2015/09/well-known-symbols-es6.html#default-tostring-tags - * @since 1.0.2 - * + * @desc symbol method for toString, toJSON, toNumber * @memberOf Chainable + * @since 1.0.2 + * @version 2 * * @param {string} hint enum[default, string, number] * @return {Primitive} * + * {@link http://2ality.com/2015/09/well-known-symbols-es6.html#default-tostring-tags well-known-symbols-es6} + * @see {@link well-known-symbols-es6} + * * @example * * const chain = new Chain() @@ -409,9 +407,9 @@ const ComposeChainable = Target => { * @method length * @readonly * @since 0.5.0 - * @example for (var i = 0; i < chain.length; i++) * @see ChainedMap.store * @return {number} + * @example for (var i = 0; i < chain.length; i++) */ ObjectDefine(ChainPrototype, 'length', { enumerable: false, @@ -428,7 +426,8 @@ const ComposeChainable = Target => { return Chainable } -const c = ComposeChainable(class {}) +// class {} +const c = ComposeChainable(noop) /** * @since 3.0.0 diff --git a/src/ChainedMap.js b/src/ChainedMap.js index 6fae7ac..e89ac4b 100644 --- a/src/ChainedMap.js +++ b/src/ChainedMap.js @@ -7,6 +7,7 @@ const ChainedMapBase = require('./ChainedMapBase') * @desc ChainedMap composer * @category Chainable * @category Map + * @memberOf ChainedMapBase * @class ChainedMap * @since 0.0.1 * @alias ComposeMap @@ -28,7 +29,8 @@ const ChainedMapBase = require('./ChainedMapBase') * //=> true * */ -const CM = SuperClass => { + +const ComposeChainedMap = SuperClass => { const Composed = SuperClass === ChainedMapBase ? SuperClass @@ -98,19 +100,22 @@ const CM = SuperClass => { */ merge(obj, handleMergeFn) { const merger = MergeChain.init(this) + if (isUndefined(handleMergeFn)) { merger.merge(obj) } else { handleMergeFn(merger.obj(obj)) } + return this } } + return ChainedMap } -const cm = CM(ChainedMapBase) -cm.compose = CM +const composed = ComposeChainedMap(ChainedMapBase) +composed.compose = ComposeChainedMap -module.exports = cm +module.exports = composed diff --git a/src/ChainedMapBase.js b/src/ChainedMapBase.js index 8b37635..326bf89 100644 --- a/src/ChainedMapBase.js +++ b/src/ChainedMapBase.js @@ -31,10 +31,12 @@ const SHORTHANDS_KEY = require('./deps/meta/shorthands') * @prop {Meta} meta meta fn * @prop {Map} store main store * + * {@link https://tc39.github.io/ecma262/#sec-map-objects emca-map} * {@link https://ponyfoo.com/articles/es6-maps-in-depth pony-map} * {@link https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Map mozilla-map} * @see {@link pony-map} * @see {@link mozilla-map} + * @see {@link emca-map} * * @see ChainedMap * @see Chainable @@ -133,17 +135,17 @@ const ComposeChainedMapBase = Target => { for (let k = 0; k < keys.length; k++) { const key = keys[k] - const val = obj[key] + const value = obj[key] const fn = this[key] if (fn && fn.merge) { - fn.merge(val) + fn.merge(value) } else if (isFunction(fn)) { - fn.call(this, val) + fn.call(this, value) } else { - this.set(key, val) + this.set(key, value) } } diff --git a/src/ChainedSet.js b/src/ChainedSet.js index 05a5975..a3fcaa4 100644 --- a/src/ChainedSet.js +++ b/src/ChainedSet.js @@ -5,6 +5,8 @@ const toarr = require('./deps/to-arr') * @class * @category Chainable * @category Set + * @memberOf Chainable + * @member ChainedSet * * @TODO could add .first .last ? * @NOTE had Symbol.isConcatSpreadable but it was not useful @@ -37,10 +39,16 @@ class ChainedSet extends Chainable { /** * @desc appends a new element with a specified value to the end of the .store + * @memberOf ChainedSet * @since 0.4.0 + * * @param {any} value any value to add to **end** of the store * @return {ChainedSet} @chainable - * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set/add + * + * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set/add mozilla-set-add} + * {@link https://github.com/lodash/lodash/blob/master/.internal/addSetEntry.js#L9 lodash-add-set-entry} + * @see {@link mozilla-set-add} + * @see {@link lodash-add-set-entry} * * @example * @@ -51,6 +59,7 @@ class ChainedSet extends Chainable { * * for (let name of people) console.log(name) * //=> sam, sue + * */ add(value) { this.store.add(value) @@ -58,8 +67,10 @@ class ChainedSet extends Chainable { } /** - * @since 0.4.0 * @desc inserts the value at the **beginning** of the Set + * @memberOf ChainedSet + * @since 0.4.0 + * * @param {any} value any value to add to **beginning** the store * @return {ChainedSet} @chainable * @@ -72,6 +83,7 @@ class ChainedSet extends Chainable { * * for (let name of people) console.log(name) * //=> first, sue + * */ prepend(value) { this.store = new Set([value].concat(super.values())) @@ -81,6 +93,7 @@ class ChainedSet extends Chainable { /** * @desc merge any Array/Set/Iteratable/Concatables into the array, at the end * @since 0.4.0 + * @memberOf ChainedSet * * @param {Array | Set | Concatable} arr values to merge in and append * @return {ChainedSet} @chainable @@ -96,6 +109,7 @@ class ChainedSet extends Chainable { * * for (let name of people) console.log(name) * //=> first, sam, sue, merged + * */ merge(arr) { const mergeable = toarr(arr) diff --git a/src/MethodChain.js b/src/MethodChain.js index d9c7655..3678964 100644 --- a/src/MethodChain.js +++ b/src/MethodChain.js @@ -37,7 +37,7 @@ const ObjectAssign = require('./deps/util/assign') // utils const toarr = require('./deps/to-arr') const argumentor = require('./deps/argumentor') -const camelCase = require('./deps/camel-case') +const camelCase = require('./deps/string/camelCase') const markForGarbageCollection = require('./deps/gc') // is const isObj = require('./deps/is/obj') diff --git a/src/TraverseChain.js b/src/TraverseChain.js index f94a9c7..8557dc5 100644 --- a/src/TraverseChain.js +++ b/src/TraverseChain.js @@ -96,16 +96,18 @@ module.exports = class Traverser extends ChainedMapBase { // diff between keys and val is order of arg in ^ tester const matcher = matchFactory(keys, vals) - /* istanbul-ignore next: debug */ + /* istanbul ignore next: debug */ if (ENV_DEBUG) { console.log('matcher for traverse...', keys, vals) } // bound to the traverser traverse(result).forEach(function(key, x, traverser) { - if (traverser.isRoot) return - if (matcher(key, x)) { - /* istanbul-ignore next: debug */ + if (traverser.isRoot) { + // nothing + } + else if (matcher(key, x)) { + /* istanbul ignore next: debug */ if (ENV_DEBUG) { console.log('------- match ------- ', key, x) } @@ -113,7 +115,7 @@ module.exports = class Traverser extends ChainedMapBase { onMatch(x, traverser) } else if (onNonMatch) { - /* istanbul-ignore next: debug */ + /* istanbul ignore next: debug */ if (ENV_DEBUG) { console.log('------- NONmatch ------- ', key, x) } diff --git a/src/compose/Observe.js b/src/compose/Observe.js index d5d13fa..8988704 100644 --- a/src/compose/Observe.js +++ b/src/compose/Observe.js @@ -3,10 +3,10 @@ const traverse = require('../deps/traverse') // const eq = require('../deps/traversers/eq') const match = require('../deps/matcher') const getPathSegments = require('../deps/dot/segments') -const dot = require('../deps/dot') +const dotSet = require('../deps/dot/set') const OBSERVERS_KEY = require('../deps/meta/observers') -const {eq} = traverse +const {eq, clone} = traverse /** * scoped clones @@ -136,7 +136,7 @@ module.exports = Target => { for (let i = 0; i < m.length; i++) { const segments = getPathSegments(m[i]) - dot.set(data, segments, this.get(segments)) + dotSet(data, segments, this.get(segments)) } /** @@ -156,7 +156,7 @@ module.exports = Target => { /** * it did change - clone it for next deepEquals check */ - objs.set(hashKey, traverse(data).clone()) + objs.set(hashKey, clone(data)) /** * call the observer - it matched & data changed diff --git a/src/compose/Transform.js b/src/compose/Transform.js index ff0af1d..ac2de4f 100644 --- a/src/compose/Transform.js +++ b/src/compose/Transform.js @@ -153,6 +153,27 @@ module.exports = Target => { return this } + // @TODO + // // https://stackoverflow.com/questions/31158902/is-it-possible-to-sort-a-es6-map-object + // ordered(comperator = null) { + // // this.set = this.before(this.set) + // this.set = (key, value) => { + // // have to iterate over the keys before setting + // // and then after merging in values, update + // if (this.store.has(key)) { + // // first + // let keys = this.store.keys() + // if (isFunction(comperator)) keys = keys.sort(comperator) + // + // // after + // const store = this.store + // this.store = new Map() + // keys.forEach(keyInOrder => this.store.set(key, store.get(key))) + // store.clear() + // } + // } + // } + // --- remap --- /** * @desc remap properties from 1 to another, for example, apis with inconsistent naming @@ -187,8 +208,7 @@ module.exports = Target => { * */ Target.prototype.remap = function chainRemap(from, to) { - let remap = from - if (!isObj(from)) remap = {[from]: to} + let remap = isObj(from) ? from : {[from]: to} /* prettier-ignore */ ObjectKeys(remap).forEach(key => this.transform(key, val => { diff --git a/src/deps/argumentor.js b/src/deps/argumentor.js index 1c3120b..7a3f8dd 100644 --- a/src/deps/argumentor.js +++ b/src/deps/argumentor.js @@ -1,11 +1,15 @@ +const lengthFromZero = require('./util/lengthFromZero') + /** * @desc turns arguments into an array, used as a util, for opt * + * @name argumentor * @since 3.0.0 * @return {Array} * * @see https://github.com/aretecode/awesome-deopt * @see https://github.com/petkaantonov/bluebird/wiki/Optimization-killers + * @see deps/util/lengthFromZero * * @example * @@ -20,7 +24,8 @@ */ module.exports = function() { const len = arguments.length - const args = new Array(len > 1 ? len - 1 : 0) + // len > 1 ? len - 1 : 0 + const args = new Array(lengthFromZero(len)) for (let i = 0; i < len; ++i) args[i] = arguments[i] return args } diff --git a/src/deps/array/concat.js b/src/deps/array/concat.js new file mode 100644 index 0000000..2924316 --- /dev/null +++ b/src/deps/array/concat.js @@ -0,0 +1,27 @@ +const toarr = require('../to-arr') + +/** + * @desc concat two values, coerce to arrays + * @since 4.0.0 + * + * @func + * @name concat + * + * @param {Array | *} one toArr1 + * @param {Array | *} two toArr2 + * @return {Array} [one, two] + * + * @example + * + * concat([1], [2]) //=> [1, 2] + * concat([1], 2) //=> [1, 2] + * concat(1, 2) //=> [1, 2] + * concat(new Set([1]), 2) //=> [1, 2] + * + * // kind of weird... + * concat(null, 2) //=> [2] + * concat(undefined, 2) //=> [2] + * concat(1, null) //=> [1, null] + * + */ +module.exports = (one, two) => toarr(one || []).concat(toarr(two)) diff --git a/src/deps/array/insert-at-index.js b/src/deps/array/insert-at-index.js deleted file mode 100644 index 57169c2..0000000 --- a/src/deps/array/insert-at-index.js +++ /dev/null @@ -1,18 +0,0 @@ -// http://stackoverflow.com/questions/7032550/javascript-insert-an-array-inside-another-array -// http://stackoverflow.com/questions/1348178/a-better-way-to-splice-an-array-into-an-array-in-javascript/41465578#41465578 -// http://stackoverflow.com/questions/38060705/replace-element-at-specific-position-in-an-array-without-mutating-it -// function insertArrAt(array, index, arrayToInsert) { -// // Array.prototype.splice.apply(array, [index, 0].concat(arrayToInsert)) -// // return array.slice.apply([index, 0].concat(arrayToInsert)) -// return array.slice(index, 0).apply([index, 0].concat(arrayToInsert)) -// return array -// } - -module.exports = function insertAtIndex(arr, index, val) { - if (index < arr.length) { - return [...arr.slice(0, index), ...val, ...arr.slice(index + 1)] - } - else { - return [...arr, ...Array(index - arr.length), ...val] - } -} diff --git a/src/deps/array/insertAtIndex.js b/src/deps/array/insertAtIndex.js new file mode 100644 index 0000000..cda3ff3 --- /dev/null +++ b/src/deps/array/insertAtIndex.js @@ -0,0 +1,33 @@ +// function insertArrAt(array, index, arrayToInsert) { +// // Array.prototype.splice.apply(array, [index, 0].concat(arrayToInsert)) +// // return array.slice.apply([index, 0].concat(arrayToInsert)) +// return array.slice(index, 0).apply([index, 0].concat(arrayToInsert)) +// return array +// } + +/** + * @desc put a value at any index in an array + * @since ? was in insert-at-index dep... + * + * @see http://stackoverflow.com/questions/7032550/javascript-insert-an-array-inside-another-array + * @see http://stackoverflow.com/questions/1348178/a-better-way-to-splice-an-array-into-an-array-in-javascript/41465578#41465578 + * @see http://stackoverflow.com/questions/38060705/replace-element-at-specific-position-in-an-array-without-mutating-it + * + * @param {Array} arr array to put value in at index + * @param {number} index index to put valu eat + * @param {*} val value to put at index + * @return {Array} array with new value at index + * + * @example + * + * insertAtIndex(['zero-1', 'one-2'], 1, 1) //=> ['zero-1', 1, 'one-two'] + * + */ +module.exports = function insertAtIndex(arr, index, val) { + if (index < arr.length) { + return [...arr.slice(0, index), ...val, ...arr.slice(index + 1)] + } + else { + return [...arr, ...Array(index - arr.length), ...val] + } +} diff --git a/src/deps/array/uniq.js b/src/deps/array/uniq.js index 6c851c7..83d786a 100644 --- a/src/deps/array/uniq.js +++ b/src/deps/array/uniq.js @@ -1,2 +1,28 @@ -// eslint-disable-next-line prefer-includes/prefer-includes +/* eslint prefer-includes/prefer-includes: "OFF" */ + +/** + * @name uniqFilter + * @func + * + * @since 0.1.0 + * @param {*} value value in array iteration + * @param {number} index current index + * @param {Array} arr array being iterated, `thisArg` when using .filter + * @return {Array} arr + * + * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/filter mozilla-array-filter} + * @see {@link mozilla-array-filter} + * + * @example + * + * var list = [ + * 1, 2, 3, + * 1, 2, 3, + * 1, 2, 3 + * ] + * + * list.filter(uniq) + * //=> [1, 2, 3] + * + */ module.exports = (value, index, arr) => arr.indexOf(value) === index diff --git a/src/deps/cache/pooler.js b/src/deps/cache/pooler.js new file mode 100644 index 0000000..6a8294f --- /dev/null +++ b/src/deps/cache/pooler.js @@ -0,0 +1,124 @@ +/* eslint consistent-this: ["error", "Klass"] */ + +const ENV_DEBUG = require('../env/debug') + +/** + * @symb 🎱 + * @member pooler + * @type {Object} + * + * {@link https://github.com/facebook/react/blob/master/src/renderers/shared/utils/PooledClass.js react-pooler} + * @see {@link react-pooler} + * + * @tests deps/pooler + * @types deps.cache.pooler + */ +// const pooler = }} + +/** + * @desc call destructor on a pooled instance, put it back in the pool + * @since 5.0.0 + * @memberOf pooler + * + * @param {Object} instance call destructor + * @return {void} + * + * @example + * + * class Eh {} + * addPoolingTo(Eh) + * const eh = Eh.getPooled() + * eh.release() + * + */ +function standardReleaser(instance) { + const Klass = this + + if (ENV_DEBUG) { + if (instance instanceof Klass) { + throw new Error( + `Trying to release an instance + into a pool of a different type.` + ) + } + } + + instance.destructor() + if (Klass.instancePool.length < Klass.poolSize) { + Klass.instancePool.push(instance) + } +} + +/** + * Static poolers. Several custom versions for each potential number of + * arguments. A completely generic pooler is easy to implement, but would + * require accessing the `arguments` object. In each of these, `this` refers to + * the Class itself, not an instance. If any others are needed, simply add them + * here, or in their own files. + * + * @since 5.0.0 + * @memberOf pooler + * + * @param {Object} copyFieldsFrom obj with instance pool + * @return {Object} instance of Klass + * + * @example + * + * class Eh {} + * addPoolingTo(Eh) + * const eh = Eh.getPooled() //=> oneArgumentPooler(Eh) + * eh.release() + * + */ +function oneArgumentPooler(copyFieldsFrom) { + const Klass = this + if (Klass.instancePool.length) { + const instance = Klass.instancePool.pop() + Klass.call(instance, copyFieldsFrom) + return instance + } + else { + return new Klass(copyFieldsFrom) + } +} + +const DEFAULT_POOL_SIZE = 10 +const DEFAULT_POOLER = oneArgumentPooler + +/** + * Augments `CopyConstructor` to be a poolable class, augmenting only the class + * itself (statically) not adding any prototypical fields. Any CopyConstructor + * you give this may have a `poolSize` property, and will look for a + * prototypical `destructor` on instances. + * + * @since 5.0.0 + * @memberOf pooler + * + * @param {Function | Object} CopyConstructor Constructor that can be used to reset. + * @param {Function} pooler Customizable pooler. + * @return {Object} enhanced constructor, decorated with pooler + * + * @example + * + * class Eh {} + * addPoolingTo(Eh) // can optionally pass in pooler as second arg + * //=> Eh.instancePool = [] + * //=> Eh.getPooled = pooler || singleArgumentPooler + * //=> Eh.poolSize = 10 + * //=> Eh.release = standardReleaser + * + */ +function addPoolingTo(CopyConstructor, pooler) { + // Casting as any so that flow ignores the actual implementation and trusts + // it to match the type we declared + const NewKlass = CopyConstructor + + NewKlass.instancePool = [] + NewKlass.getPooled = pooler || DEFAULT_POOLER + if (!NewKlass.poolSize) NewKlass.poolSize = DEFAULT_POOL_SIZE + NewKlass.release = standardReleaser + + return NewKlass +} + +module.exports = addPoolingTo diff --git a/src/deps/concat.js b/src/deps/concat.js deleted file mode 100644 index b974bd4..0000000 --- a/src/deps/concat.js +++ /dev/null @@ -1,3 +0,0 @@ -const toarr = require('./to-arr') - -module.exports = (one, two) => toarr(one || []).concat(toarr(two)) diff --git a/src/deps/conditional/README.md b/src/deps/conditional/README.md index 50a957b..f41fd65 100644 --- a/src/deps/conditional/README.md +++ b/src/deps/conditional/README.md @@ -2,6 +2,7 @@ things like some utils like `not` and such can go in here maybe also have `lib` for lodash style things? +@TODO `none` // @NOTE: there is no need for enum, just `|`, could use `==` // this way we could also just do == diff --git a/src/deps/conditional/all.js b/src/deps/conditional/all.js index 411cad1..4e5e41a 100644 --- a/src/deps/conditional/all.js +++ b/src/deps/conditional/all.js @@ -1,10 +1,24 @@ +const curry = require('../fp/curry') + /** * map all values in an array to see if all match + * Returns `true` if all elements of the list match the predicate, `false` if there are any that don't. + * * @memberOf conditional - * @since 4.0.1 + * @since 4.0.1 + * + * @TODO `not(some)` ? + * * @param {Function} predicate match the value + * @param {Array} array to match against predicate * @return {boolean} all match predicate * + * {@link https://github.com/ramda/ramda/blob/master/src/all.js ramda-all} + * @see {@link ramda-all} + * @see fp/curry + * + * @sig (a -> Boolean) -> [a] -> Boolean + * * @example * * const allBoolean = all(x => typeof x === 'boolean'q) @@ -16,11 +30,11 @@ * //=> false * */ -const all = predicate => arr => { +const all = curry(2, (predicate, arr) => { for (let i in arr) { if (!predicate(arr[i])) return false } return true -} +}) module.exports = all diff --git a/src/deps/conditional/and.js b/src/deps/conditional/and.js index 57b89df..83d1fd7 100644 --- a/src/deps/conditional/and.js +++ b/src/deps/conditional/and.js @@ -1,7 +1,13 @@ +const curry = require('../fp/curry') + /** - * first fn & second fn + * @desc first fn & second fn + * @name and + * @alias both * @memberOf conditional * @since 4.0.1 + * @func + * * @param {Function} left first fn * @param {Function} right second fn * @return {boolean} both functions return truthy @@ -20,4 +26,5 @@ * //=> false * */ -module.exports = (left, right) => x => left(x) && right(x) +const and = (left, right) => x => left(x) && right(x) +module.exports = curry(2, and) diff --git a/src/deps/conditional/eq.js b/src/deps/conditional/eq.js index 3f762fd..adda8b9 100644 --- a/src/deps/conditional/eq.js +++ b/src/deps/conditional/eq.js @@ -1 +1,5 @@ -module.exports = left => right => left === right +const curry = require('../fp/curry') + +module.exports = curry(2, function eqeqeq(left, right) { + return left === right +}) diff --git a/src/deps/conditional/includes/all.js b/src/deps/conditional/includes/all.js index 7ad10d3..c48251c 100644 --- a/src/deps/conditional/includes/all.js +++ b/src/deps/conditional/includes/all.js @@ -1,44 +1,59 @@ -const isArray = require('../../is/array') +const isStringPrimitive = require('../../is/stringPrimitive') +const curry = require('../../fp/curry') const includes = require('./includes') /** * @param {string} needle * @param {Array} haystack * @return {boolean} + * + * @example + * */ -function strHasAll(needle, haystack) { - if (needle === haystack) { - return true - } +function stringIncludesAll(needle, haystack) { + if (needle === haystack) return true + for (let i = 0, len = haystack.length; i < len; i++) if (!includes(haystack[i], needle)) return false + return true } /** - * @see strHasAll + * @see stringIncludesAll * @param {Array} needles * @param {Array} haystack * @return {boolean} */ -function arrayHasAll(needles, haystack) { +function arrayIncludesAll(needles, haystack) { // loop needles - for (let i = 0; i < needles.length; i++) { - if (!strHasAll(needles[i], haystack)) return false - } + for (let i = 0; i < needles.length; i++) + if (!stringIncludesAll(needles[i], haystack)) return false + return true } /** - * @see arrayHasAll - * @see strHasAll - * @param {Array | string} needle - * @param {Array} haystack + * @since 4.0.0 + * @param {Array | string} needle everything in haystack is in this + * @param {Array} haystack everything in this is in the needle * @return {boolean} + * + * @see arrayIncludesAll + * @see stringIncludesAll + * + * @example + * + * /// 'canada' and 'can' are both in it, so true + * includesAll('canada', ['canada', 'can']) + * includesAll(['eh'], 'e') //=> true + * includesAll(['eh'], 'nope') //=> false + * includesAll('eh', ['no', 'eh']) //=> false + * */ function includesAll(needle, haystack) { - if (isArray(needle)) return arrayHasAll(needle, haystack) - else return strHasAll(needle, haystack) + if (isStringPrimitive(needle)) return stringIncludesAll(needle, haystack) + else return arrayIncludesAll(needle, haystack) } -module.exports = includesAll +module.exports = curry(2, includesAll) diff --git a/src/deps/conditional/includes/any.js b/src/deps/conditional/includes/any.js index 517cb36..3ece814 100644 --- a/src/deps/conditional/includes/any.js +++ b/src/deps/conditional/includes/any.js @@ -1,4 +1,5 @@ -const isArray = require('../../is/array') +const isStringPrimitive = require('../../is/stringPrimitive') +const curry = require('../../fp/curry') const includes = require('./includes') /** @@ -7,46 +8,50 @@ const includes = require('./includes') * @return {boolean} */ function strHasAny(needle, haystack) { - if (needle.includes(haystack)) { - return true - } - for (let i = 0, len = haystack.length; i < len; i++) { - if (haystack[i].includes(needle)) { - return true - } - } + if (needle.includes(haystack)) return true + + for (let i = 0, len = haystack.length; i < len; i++) + if (haystack[i].includes(needle)) return true + return false } /** - * @see strHasAny * @param {Array} needles * @param {Array} haystack * @return {boolean} + * + * @see strHasAny */ function arrayHasAny(needles, haystack) { - if (needles.includes(haystack)) { - return true - } + if (needles.includes(haystack)) return true + // loop needles - for (let i = 0; i < needles.length; i++) { - if (strHasAny(needles[i], haystack)) { - return true - } - } + for (let i = 0; i < needles.length; i++) + if (strHasAny(needles[i], haystack)) return true + return false } /** - * @see arrayHasAny - * @see strHasAny * @param {Array | string} needle * @param {Array} haystack * @return {boolean} + * + * @see arrayHasAny + * @see strHasAny + * + * @example + * + * includesAny('eh', 'e') //=> true + * includesAny('eh', 'eh') //=> true + * includesAny(['eh'], 'e') //=> true + * includesAny(['eh'], 'nope') //=> false + * */ function includesAny(needle, haystack) { - if (isArray(needle)) return arrayHasAny(needle, haystack) - else return strHasAny(needle, haystack) + if (isStringPrimitive(needle)) return strHasAny(needle, haystack) + else return arrayHasAny(needle, haystack) } -module.exports = includesAny +module.exports = curry(2, includesAny) diff --git a/src/deps/conditional/includes/flipped.js b/src/deps/conditional/includes/flipped.js new file mode 100644 index 0000000..e94085a --- /dev/null +++ b/src/deps/conditional/includes/flipped.js @@ -0,0 +1,4 @@ +const flip2 = require('../../fp/flip2') +const includes = require('./includes') + +module.exports = flip2(includes) diff --git a/src/deps/conditional/includes/includes.js b/src/deps/conditional/includes/includes.js index e458c40..fa6bd7a 100644 --- a/src/deps/conditional/includes/includes.js +++ b/src/deps/conditional/includes/includes.js @@ -1 +1,28 @@ -module.exports = (haystack, needle) => haystack.includes(needle) +const curry = require('../../fp/curry') + +/** + * @memberOf includes + * @name includes + * @func + * + * @param {Array | string} haystack haystack includes needle + * @param {string | *} needle needle in haystack + * @return {boolean} needle in haystack + * + * @TODO `~haystack.indexOf(needle)` + * + * {@link https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Operators/Bitwise_Operators#Bitwise_NOT mozilla-bitwise-not} + * @see {@link mozilla-bitwise-not} + * @see conditional/includes/flipped + * + * @example + * + * includes('eh', 'e') //=> true + * includes('eh', 'nope') //=> false + * includes(['eh'], 'eh') //=> true + * includes(['eh'], 'nope') //=> false + * + */ +const includes = (haystack, needle) => haystack.includes(needle) + +module.exports = curry(2, includes) diff --git a/src/deps/conditional/index.js b/src/deps/conditional/index.js new file mode 100644 index 0000000..c80615d --- /dev/null +++ b/src/deps/conditional/index.js @@ -0,0 +1,15 @@ +/* istanbul ignore */ +const all = require('./all') +const and = require('./and') +const some = require('./some') +const not = require('./not') +const or = require('./or') +const eq = require('./eq') + +/** + * @member conditional + * @type {Object} + */ +const conditional = {all, and, some, not, or, eq} + +module.exports = conditional diff --git a/src/deps/conditional/not.js b/src/deps/conditional/not.js index be3b1cb..87f1d7d 100644 --- a/src/deps/conditional/not.js +++ b/src/deps/conditional/not.js @@ -1,9 +1,20 @@ +const curry = require('../fp/curry') + /** * return a negated function + * A function wrapping a call to the given function in a `!` operation. + * It will: + * - return `true` when the underlying function would return a false-y value, + * - and `false` when it would return a truth-y one. + * + * @name not * @memberOf conditional * @since 4.0.1 + * @func + * * @param {Function} fn any function - * @return {Function} !Function + * @param {*} x value to pass to function + * @return {Function} !Function(x) * * @example * @@ -17,4 +28,12 @@ * //=> false * */ -module.exports = fn => x => !fn(x) +const not = (fn, x) => !fn(x) +module.exports = curry(2, not) + +// curry(2, +// function not(predicate) { +// return function() { +// return !predicate.apply(this, arguments) +// } +// } diff --git a/src/deps/conditional/or.js b/src/deps/conditional/or.js index 3964fb4..884dfcd 100644 --- a/src/deps/conditional/or.js +++ b/src/deps/conditional/or.js @@ -1,14 +1,21 @@ +const curry = require('../fp/curry') + /** - * first fn || second fn + * @desc first fn || second fn, curried + * @name or * @memberOf conditional * @since 4.0.1 + * @func + * * @param {Function} left first fn * @param {Function} right second fn + * @param {*} x value to pass into left & right, curried * @return {boolean} one of the functions return truthy * * @example + * const {isTrue, isFalse} = require('chain-able') * - * const either = or(x => x === false, x => x === true) + * const either = or(isFalse, isTrue) * * either([true]) * //=> true @@ -19,5 +26,8 @@ * either([1]) * //=> false * + * // because curried + * or(isTrue, isFalse, true) //=> true + * */ -module.exports = (left, right) => x => left(x) || right(x) +module.exports = curry(3, (left, right, x) => left(x) || right(x)) diff --git a/src/deps/conditional/some.js b/src/deps/conditional/some.js index 17182a2..6ee3c50 100644 --- a/src/deps/conditional/some.js +++ b/src/deps/conditional/some.js @@ -1,10 +1,16 @@ +const curry = require('../fp/curry') + /** - * map all values in an array to see if **some** match + * @desc map all values in an array to see if **some** match, curried * @memberOf conditional - * + * @name some + * @alias any * @since 4.0.1 + * @func + * * @param {Function} predicate match the value - * @return {boolean} all match predicate + * @param {Array | any} arr values to match on the predicate + * @return {boolean} **some** match predicate * * @example * @@ -20,11 +26,9 @@ * //=> true * */ -const some = test => arr => { +module.exports = curry(2, function some(test, arr) { for (let i in arr) { if (test(arr[i])) return true } return false -} - -module.exports = some +}) diff --git a/src/deps/construct/map.js b/src/deps/construct/map.js new file mode 100644 index 0000000..826e862 --- /dev/null +++ b/src/deps/construct/map.js @@ -0,0 +1,3 @@ +const construct = require('../fp/construct') + +module.exports = construct(1, Map) diff --git a/src/deps/construct/regexp.js b/src/deps/construct/regexp.js new file mode 100644 index 0000000..bf7a46d --- /dev/null +++ b/src/deps/construct/regexp.js @@ -0,0 +1,3 @@ +const construct = require('../fp/construct') + +module.exports = construct(1, RegExp) diff --git a/src/deps/construct/set.js b/src/deps/construct/set.js new file mode 100644 index 0000000..c4857b4 --- /dev/null +++ b/src/deps/construct/set.js @@ -0,0 +1,3 @@ +const construct = require('../fp/construct') + +module.exports = construct(1, Set) diff --git a/src/deps/dopemerge/dopemerge.js b/src/deps/dopemerge/dopemerge.js index 7c888e1..576221d 100644 --- a/src/deps/dopemerge/dopemerge.js +++ b/src/deps/dopemerge/dopemerge.js @@ -182,6 +182,7 @@ function deepmerge(target, source, optsArg) { * @param {*} opts dopemerge options * @return {Object | Array | any} merged * + * {@link https://github.com/lodash/lodash/blob/master/merge.js lodash-merge} * {@link https://github.com/KyleAMathews/deepmerge deepmerge} * @see {@link deepmerge} * diff --git a/src/deps/dopemerge/emptyTarget.js b/src/deps/dopemerge/emptyTarget.js index d3cb695..b74f4cf 100644 --- a/src/deps/dopemerge/emptyTarget.js +++ b/src/deps/dopemerge/emptyTarget.js @@ -3,7 +3,9 @@ const isArray = require('../is/array') /** * @desc make a new empty Array or Object for cloning * @memberOf dopemerge + * @name emptyTarget * @since 2.0.0 + * @func * * @param {*} val array or object to return an empty one of * @return {Object | Array} depending on the data type of val @@ -15,6 +17,7 @@ const isArray = require('../is/array') * * emptyTarget([1]) * //=> [] + * */ module.exports = function emptyTarget(val) { return isArray(val) ? [] : {} diff --git a/src/deps/dopemerge/map.js b/src/deps/dopemerge/map.js index e982d63..b6ba098 100644 --- a/src/deps/dopemerge/map.js +++ b/src/deps/dopemerge/map.js @@ -1,10 +1,35 @@ +/* istanbul ignore: WIP */ const ObjectKeys = require('../util/keys') const isMap = require('../is/map') const isFalse = require('../is/false') const reduce = require('../reduce') const dopemerge = require('./dopemerge') -function dopemergeMap(obj1, obj2) { +/** + * merge maps & sets + * @memberOf dopemerge + * + * @param {Map | Set} obj1 merge with 2 + * @param {Map | Set} obj2 merge with 1 + * @return {Map | Set} merged + * + * @TODO easy clone + * + * @example + * + * var targetMap = new Map() + * targetMap.set('true', false) + * targetMap.set('obj', {obj: []}) + * targetMap.set('arr', [1]) + * var srcMap = new Map() + * srcMap.set('true', true) + * srcMap.set('obj', {obj: [Symbol]}) + * srcMap.set('arr', [2]) + * srcMap.set('emptyArr', []) + * var mergedMap = dopemergeMap(targetMap, srcMap, {clone: true}) + * + */ +module.exports = function dopemergeMap(obj1, obj2) { const oneIsMap = isMap(obj1) const twoIsMap = isMap(obj2) @@ -45,15 +70,3 @@ function dopemergeMap(obj1, obj2) { return dest } - -// test -var targetMap = new Map() -targetMap.set('true', false) -targetMap.set('obj', {obj: []}) -targetMap.set('arr', [1]) -var srcMap = new Map() -srcMap.set('true', true) -srcMap.set('obj', {obj: [Symbol]}) -srcMap.set('arr', [2]) -srcMap.set('emptyArr', []) -var mergedMap = dopemergeMap(targetMap, srcMap, {clone: true}) diff --git a/src/deps/dot/README.md b/src/deps/dot/README.md index e841496..7e65640 100644 --- a/src/deps/dot/README.md +++ b/src/deps/dot/README.md @@ -3,6 +3,7 @@ - https://github.com/mariocasciaro/object-path/blob/master/index.js - https://github.com/sindresorhus/dot-prop/blob/master/index.js - https://github.com/sindresorhus/is-obj/blob/master/index.js +- https://github.com/facebook/fbjs/blob/master/packages/fbjs/src/misc/getByPath.js # segments: ```js diff --git a/src/deps/dot/delete.js b/src/deps/dot/delete.js index aab49cf..8924584 100644 --- a/src/deps/dot/delete.js +++ b/src/deps/dot/delete.js @@ -3,6 +3,26 @@ const lengthMinusOne = require('../util/lengthMinusOne') const getPathSegments = require('./segments') const isDottable = require('./dottable') +/** + * @desc delete a path on an object + * @name dot.delete + * @memberOf dot + * @func + * @since 3.0.0 + * @extends dot/getPathSegments + * + * @param {Object} obj the object to DELETE the nested property from. + * @param {Dottable | string | Array} path dot-prop-path to use + * @return {void} + * + * + * @example + * + * dot.get({a: {b: 2}}, 'a.b'); //=> 2 + * dot.get({a: {b: 2}}, ['a', 'b']); //=> 2 + * dot.get({c: {b: 2}}, ['a', 'b']); //=> undefined + * + */ module.exports = function dotdelete(obj, path) { if (!isDottable(obj, path)) { return diff --git a/src/deps/dot/escape.js b/src/deps/dot/escape.js index 13784ca..1cf1b22 100644 --- a/src/deps/dot/escape.js +++ b/src/deps/dot/escape.js @@ -1 +1,8 @@ -module.exports = x => x.replace(/[.]/gim, '') +const replace = require('../fp/replace') + +/** + * @memberOf dot + * @name escapeDot + * @extends fp/replace + */ +module.exports = replace(/[.]/gim, '') diff --git a/src/deps/dot/get.js b/src/deps/dot/get.js index e0a9dc7..3326bda 100644 --- a/src/deps/dot/get.js +++ b/src/deps/dot/get.js @@ -5,28 +5,49 @@ const lengthMinusOne = require('../util/lengthMinusOne') const getPathSegments = require('./segments') const isDottable = require('./dottable') -module.exports = function(obj, path, value) { +/** + * @name dot.get + * @memberOf dot + * @func + * @since 3.0.0 + * @extends dot/getPathSegments + * + * @param {Object} obj the object to retrieve the nested property from. + * @param {Dottable | string | Array} path dot-prop-path to use + * @param {*} fallback use when there is no value at specified path + * @return {*} value at path or fallback + * + * @example + * + * dot.get({a: {b: 2}}, 'a.b'); //=> 2 + * dot.get({a: {b: 2}}, ['a', 'b']); //=> 2 + * dot.get({c: {b: 2}}, ['a', 'b']); //=> undefined + * + */ +module.exports = function(obj, path, fallback) { if (!isDottable(obj, path)) { - return isUndefined(value) ? obj : value + return isUndefined(fallback) ? obj : fallback } const pathArr = getPathSegments(path) for (let i = 0; i < pathArr.length; i++) { if (!isEnumerable(obj, pathArr[i])) { - return value + return fallback } obj = obj[pathArr[i]] if (isNullOrUndefined(obj)) { - // `obj` is either `undefined` or `null` so we want to stop the loop, and - // if this is not the last bit of the path, and - // if it did't return `undefined` - // it would return `null` if `obj` is `null` - // but we want `get({foo: null}, 'foo.bar')` to equal `undefined`, or the supplied value, not `null` + /* + * `obj` is either `undefined` or `null` so we want to stop the loop, and + * if this is not the last bit of the path, and + * if it did't return `undefined` + * it would return `null` if `obj` is `null` + * but we want `get({foo: null}, 'foo.bar')` to equal `undefined`, or the supplied fallback, not `null` + */ if (i !== lengthMinusOne(pathArr)) { - return value + return fallback } break diff --git a/src/deps/dot/has.js b/src/deps/dot/has.js index 0f3b2b1..176f263 100644 --- a/src/deps/dot/has.js +++ b/src/deps/dot/has.js @@ -2,6 +2,24 @@ const isObj = require('../is/obj') const getPathSegments = require('./segments') const isDottable = require('./dottable') +/** + * @name dot.has + * @memberOf dot + * @func + * @since 3.0.0 + * @extends dot/getPathSegments + * + * @param {Object} obj the object to retrieve the nested property from. + * @param {Dottable | string | Array} path dot-prop-path to use + * @return {boolean} has at path + * + * @example + * + * dot.has({a: {b: 2}}, 'a.b'); //=> true + * dot.has({a: {b: 2}}, ['a', 'b']); //=> true + * dot.has({c: {b: 2}}, ['a', 'b']); //=> undefined + * + */ module.exports = function dotHas(obj, path) { if (!isDottable(obj, path)) { return false diff --git a/src/deps/dot/paths.js b/src/deps/dot/paths.js index cd4874e..5392a49 100644 --- a/src/deps/dot/paths.js +++ b/src/deps/dot/paths.js @@ -16,6 +16,7 @@ let run = 0 * @param {boolean | undefined} [longest] optionally filter to keep only longest/deepest paths * @return {Array} paths[] * + * @see deps/traverse * @TODO should build a trie if doing this * @NOTE had `onlyLongest` & `asString` but can just .join(',') to match * @@ -33,7 +34,7 @@ module.exports = function(key, value, longest) { let paths = [] - /* istanbul-ignore next: debug */ + /* istanbul ignore next: debug */ if (ENV_DEBUG) { console.log({value}) } @@ -47,13 +48,14 @@ module.exports = function(key, value, longest) { // const currentPath = this.paths const currentPath = this.path - /* istanbul-ignore next: debug */ + /* istanbul ignore next: debug */ if (ENV_DEBUG) { console.log('paths', run++, this.path) } // ignore - if (!currentPath || !currentPath.length) return + if (!currentPath) return + else if (!currentPath.length) return // dot-prop the array of paths // if we have a key, prefix it diff --git a/src/deps/dot/segments.js b/src/deps/dot/segments.js index 3ccffe5..ee45da1 100644 --- a/src/deps/dot/segments.js +++ b/src/deps/dot/segments.js @@ -3,6 +3,22 @@ const isUndefined = require('../is/undefined') const lengthMinusOne = require('../util/lengthMinusOne') let cache + +/** + * @name dotPropSegments + * @since 4.0.0 + * @memberOf dot + * + * @param {string | Array} path dot-prop-path + * @return {Array} array path + * + * @example + * + * dotPropSegments('eh.oh') //=> ['eh', 'oh'] + * dotPropSegments(['eh', 'oh']) //=> ['eh', 'oh'] + * dotPropSegments('ehoh') //=> ['ehoh'] + * + */ module.exports = path => { if (!cache) cache = new Map() if (cache.has(path)) return cache.get(path) diff --git a/src/deps/dot/set.js b/src/deps/dot/set.js index 9fddc33..16094bf 100644 --- a/src/deps/dot/set.js +++ b/src/deps/dot/set.js @@ -17,6 +17,7 @@ module.exports = function dotset(obj, path, value) { obj[p] = {} } + // isLast if (i === lengthMinusOne(pathArr)) { obj[p] = value } diff --git a/src/deps/encase/encase.js b/src/deps/encase/encase.js index 5551d0a..37d4db5 100644 --- a/src/deps/encase/encase.js +++ b/src/deps/encase/encase.js @@ -1,12 +1,21 @@ const tryCatch = require('./tryCatch') /** + * @version 5.0.0 wrapped tryCatch & withSpecification in curry * @version 4.0.1 added custom encaser * @since 4.0.0 + * @member encase + * @symb 🛡 + * * @param {Function} call function to _encase_ * @param {Function | undefined} [encaser=tryCatch] function to encase _with_ * @return {Function} -> FunctionObject{onInvalid, onValid, rethrow, call} * + * {@link https://github.com/fluture-js/Fluture#encase fluture-encase} + * {@link https://github.com/lodash/lodash/blob/master/attempt.js lodash-attempt} + * @see {@link lodash-attempt} + * @see {@link fluture-encase} + * * @example * * const throws = x => { @@ -33,6 +42,7 @@ const tryCatch = require('./tryCatch') module.exports = (call, encaser) => { const encased = encaser ? encaser(call) : tryCatch(call) + // @TODO rethink this scoped approach // left, right, rethrow let onInvalid let onValid diff --git a/src/deps/encase/tryCatch.js b/src/deps/encase/tryCatch.js index 0789521..d2e53b4 100644 --- a/src/deps/encase/tryCatch.js +++ b/src/deps/encase/tryCatch.js @@ -1,4 +1,9 @@ +const curry = require('../fp/curry') + /** + * @TODO could curry + * + * @memberOf encase * @see https://github.com/fluture-js/Fluture#encase * @since 4.0.0 <- moved out into a dep * @since 1.0.0 @@ -6,7 +11,7 @@ * @param {Function} call * @return {boolean | any} validation/encased function call result */ -module.exports = call => (onValid, onInvalid, rethrow) => (a, b, c) => { +module.exports = curry(3, (call, onValid, onInvalid) => (a, b, c) => { let result try { result = call(a, b, c) @@ -18,4 +23,4 @@ module.exports = call => (onValid, onInvalid, rethrow) => (a, b, c) => { if (onInvalid) return onInvalid(error) else return error } -} +}) diff --git a/src/deps/encase/withSpecification.js b/src/deps/encase/withSpecification.js index 7c83722..fd8605d 100644 --- a/src/deps/encase/withSpecification.js +++ b/src/deps/encase/withSpecification.js @@ -1,5 +1,30 @@ -module.exports = specification => call => (onInvalid, onValid) => (a, b, c) => { +const curry = require('../fp/curry') + +/** + * @desc a special encased wrapper with no try catch but same api + * @name withSpecification + * @func + * @memberOf encase + * @since 4.0.0 + * + * @param {Function} specification match + * @param {Function} call cb to determine valid or invalid + * @param {Function} onInvalid cb when invalid + * @param {Function} onInvalid cb when valid + * @return {Function} a lot of functions... + * + * @see fp/curry + * + * @example + * const onInvalid = console.error + * const onValid = console.debug + * const onCall = console.log + * const encased = withSpecification(x => true)(onCall)(onValid, onInvalid) + * + * encased(1, 2, 3) //=> onCall (did not throw) + */ +module.exports = curry(4, (specification, call, onInvalid, onValid) => (a, b, c) => { const result = call(a, b, c) if (specification(result)) return onInvalid(result) else return onValid(result) -} +}) diff --git a/src/deps/expressions/README.md b/src/deps/expressions/README.md new file mode 100644 index 0000000..87161ba --- /dev/null +++ b/src/deps/expressions/README.md @@ -0,0 +1 @@ +basic math expressions, above, below, between, math, even, odd, times, increment, decrement diff --git a/src/deps/expressions/above.js b/src/deps/expressions/above.js new file mode 100644 index 0000000..9ea1edf --- /dev/null +++ b/src/deps/expressions/above.js @@ -0,0 +1,8 @@ +const curry = require('../fp/curry') + +// @alias gt +function isAbove(aboveThis, x) { + return x > aboveThis +} + +module.exports = curry(2, isAbove) diff --git a/src/deps/expressions/below.js b/src/deps/expressions/below.js new file mode 100644 index 0000000..8841448 --- /dev/null +++ b/src/deps/expressions/below.js @@ -0,0 +1,8 @@ +const curry = require('../fp/curry') + +// @alias lt +function isBelow(aboveThis, x) { + return x < aboveThis +} + +module.exports = curry(2, isBelow) diff --git a/src/deps/expressions/between.js b/src/deps/expressions/between.js new file mode 100644 index 0000000..2d9f2ff --- /dev/null +++ b/src/deps/expressions/between.js @@ -0,0 +1,19 @@ +const curry = require('../fp/curry') + +/** + * @param {number} x number between + * @param {number} min minimum + * @param {number} max maximum + * @param {boolean} greaterThanOrEqualTo strictly between, not equal to (left right) + * @return {boolean} x >= min && x <= max + * + * @example + * between(100, 0, 200) //=> true + * between(100, 100, 100) //=> true + * between(100, 10, 99) //=> false + */ +function between(x, min, max, greaterThanOrEqualTo = true) { + return x >= min && x <= max +} + +module.exports = curry(3, between) diff --git a/src/deps/expressions/bitwiseMathOperator.js b/src/deps/expressions/bitwiseMathOperator.js new file mode 100644 index 0000000..a7a3f62 --- /dev/null +++ b/src/deps/expressions/bitwiseMathOperator.js @@ -0,0 +1,7 @@ +// https://github.com/aretecode/collection-pipeline/blob/master/src/AbstractExpressionBuilder.php +// from expression evaluator in php collection +module.exports = function bitwiseMathOperator(x, y) { + if (x === 1) { + return x > y + } +} diff --git a/src/deps/expressions/even.js b/src/deps/expressions/even.js new file mode 100644 index 0000000..dc799c3 --- /dev/null +++ b/src/deps/expressions/even.js @@ -0,0 +1,24 @@ +const not = require('../conditional/not') +const isEven = require('./even') + +/** + * @desc isEven + * @param {number | any} x value to check + * @return {boolean} isEven + * + * @extends isOdd + * @variations inverse + * + * @example + * + * isEven(1) + * //=> false + * isEven(2) + * //=> true + * + * var rando = Math.floor(Math.random(0, 10000)) + * isEven(rando) !== isOdd(rando) + * //=> true + * + */ +module.exports = not(isEven) diff --git a/src/deps/expressions/expressions.js b/src/deps/expressions/expressions.js new file mode 100644 index 0000000..47fc1a6 --- /dev/null +++ b/src/deps/expressions/expressions.js @@ -0,0 +1,13 @@ +const above = require('./above') +const below = require('./below') +const between = require('./between') +const even = require('./even') +const odd = require('./odd') + +// gte lte +const gt = above +const lt = below +const isEven = even +const isOdd = odd + +module.exports = {gt, lt, above, below, between, isEven, isOdd, odd, even} diff --git a/src/deps/expressions/increment.js b/src/deps/expressions/increment.js new file mode 100644 index 0000000..89cbff0 --- /dev/null +++ b/src/deps/expressions/increment.js @@ -0,0 +1,4 @@ +// increment, decrement, sum, subtract, add, multiply... +// these should just stay external +// there was something with the bitwise operator experiment +// only to use this alongside the conditional for an insane sized evaluator diff --git a/src/deps/expressions/index.js b/src/deps/expressions/index.js new file mode 100644 index 0000000..6f01295 --- /dev/null +++ b/src/deps/expressions/index.js @@ -0,0 +1 @@ +module.exports = require('./expressions') diff --git a/src/deps/expressions/odd.js b/src/deps/expressions/odd.js new file mode 100644 index 0000000..8adfd7d --- /dev/null +++ b/src/deps/expressions/odd.js @@ -0,0 +1,22 @@ +const isNumber = require('../is/number') + +/* prettier-ignore */ +/** + * @desc isOdd + * @param {number | any} x value to check + * @return {boolean} isOdd + * + * @see https://stackoverflow.com/questions/6211613/testing-whether-a-value-is-odd-or-even (smaller solution than original) + * @extends isNumber + * @alternate n % 2 === 0 + * + * @example + * + * isOdd(1) + * //=> true + * isOdd(2) + * //=> false + */ +module.exports = function isOdd(x) { + return isNumber(x) && (x & 1) +} diff --git a/src/deps/fp/README.md b/src/deps/fp/README.md new file mode 100644 index 0000000..432be26 --- /dev/null +++ b/src/deps/fp/README.md @@ -0,0 +1,2 @@ +could do a wicked curry with types so auto fits in slot of type :3 +can also do like `onType`, or `onSignature` to allow EASY overloading!!! diff --git a/src/deps/fp/always.js b/src/deps/fp/always.js new file mode 100644 index 0000000..6dc14bf --- /dev/null +++ b/src/deps/fp/always.js @@ -0,0 +1,41 @@ +/** + * Returns a function that always returns the given value. Note that for + * non-primitives the value returned is a reference to the original value. + * + * This function is known as `const`, `constant`, or `K` (for K combinator) in + * other languages and libraries. + * + * @alias always + * @alias constant + * @func + * @memberOf fp + * @since v5.0.0 + * @category Function + * @sig a -> (* -> a) + * + * @param {*} value The value to wrap in a function + * @return {Function} A Function :: * -> val. + * + * {@link http://underscorejs.org/#constant underscore-constant} + * {@link https://github.com/lodash/lodash/issues/1010 lodash-constant} + * {@link https://github.com/ramda/ramda/issues/1038 ramda-constant-docs-issue} + * {@link https://github.com/ramda/ramda/blob/master/src/always.js ramda-always} + * @see {@link ramda-constant-docs-issue} + * @see {@link ramda-always} + * @see {@link lodash-constant} + * @see {@link underscore-constant} + * + * @types fp + * @tests fp/always + * + * @example + * + * var t = always('Tee'); + * t(); //=> 'Tee' + * + */ +module.exports = function constant(value) { + return function() { + return value + } +} diff --git a/src/deps/fp/arity.js b/src/deps/fp/arity.js new file mode 100644 index 0000000..e27cb56 --- /dev/null +++ b/src/deps/fp/arity.js @@ -0,0 +1,43 @@ +/* eslint complexity: "OFF" */ +/* eslint consistent-return: "OFF" */ +/* eslint max-len: "OFF" */ +/* eslint no-unused-vars: "OFF" */ + +/* istanbul ignore next: metadata, one is covered, all are covered */ +/* prettier-ignore */ +/** + * @desc just for `.length` of a function? + * @memberOf fp + * + * @since 5.0.0 + * @param {number} n number of arguments + * @param {Function} fn function to wrap + * @return {Function} function with params + * + * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/arity mozilla-func-arity} + * @see {@link mozilla-func-arity} + * + * @TODO keeping this means change uglify... + * + * @example + * + * const wan = one => console.log(one) + * arity(1, wan) + * => function(one => wan(one)) + * + */ +module.exports = function _arity(n, fn) { + if (n === 0 || n > 5) return function() { return fn.apply(this, arguments) } + else if (n === 1) return function($0) { return fn.apply(this, arguments) } + else if (n === 2) return function($0, $1) { return fn.apply(this, arguments) } + else if (n === 3) return function($0, $1, $2) { return fn.apply(this, arguments) } + else if (n === 4) return function($0, $1, $2, $3) { return fn.apply(this, arguments) } + else if (n === 5) return function($0, $1, $2, $3, $4) { return fn.apply(this, arguments) } + + // @NOTE ignoring + // else if (n === 6) return function(a0, a1, a2, a3, a4, a5) { return fn.apply(this, arguments) } + // else if (n === 7) return function(a0, a1, a2, a3, a4, a5, a6) { return fn.apply(this, arguments) } + // else if (n === 8) return function(a0, a1, a2, a3, a4, a5, a6, a7) { return fn.apply(this, arguments) } + // else if (n === 9) return function(a0, a1, a2, a3, a4, a5, a6, a7, a8) { return fn.apply(this, arguments) } + // else if (n === 10) return function(a0, a1, a2, a3, a4, a5, a6, a7, a8, a9) { return fn.apply(this, arguments) } +} diff --git a/src/deps/fp/construct.js b/src/deps/fp/construct.js new file mode 100644 index 0000000..088a8e9 --- /dev/null +++ b/src/deps/fp/construct.js @@ -0,0 +1,84 @@ +/* eslint max-len: "OFF" */ +/* eslint consistent-return: "OFF" */ + +const isNumberPrimitive = require('../is/numberPrimitive') +const curry = require('./curry') +// const nAry = require('./arity') + +/** + * Wraps a constructor function inside a curried function that can be called + * with the same arguments and returns the same type. The arity of the function + * returned is specified to allow using variadic constructor functions. + * + * @func + * @memberOf fp + * @symb 👷 + * @since 5.0.0-beta.4 + * @fork v0.4.0 + * @category Function + * @sig Number -> (* -> {*}) -> (* -> {*}) + * + * @param {number} n The arity of the constructor function. (aka, number of args) + * @param {Function} Klass The constructor function to wrap. (class to do `new Klass` on) + * @return {Function} A wrapped, curried constructor function. + * + * @extends R.construct + * @extends R.constructN + * @variation with a single *notNumber* arg, it acts as construct, rather than constructN + * + * {@link https://github.com/ramda/ramda/blob/master/src/constructN.js ramda-construct} + * @see {@link ramda-construct} + * @see isNumberPrimitive + * + * @example + * + * // Variadic Constructor function + * function Salad() { + * this.ingredients = arguments; + * } + * + * Salad.prototype.recipe = function() { + * var instructions = R.map(ingredient => 'Add a dollop of ' + ingredient, this.ingredients); + * return R.join('\n', instructions); + * }; + * + * var ThreeLayerSalad = R.constructN(3, Salad); + * + * // Notice we no longer need the 'new' keyword, and the constructor is curried for 3 arguments. + * var salad = ThreeLayerSalad('Mayonnaise')('Potato Chips')('Ketchup'); + * + * console.log(salad.recipe()); + * // Add a dollop of Mayonnaise + * // Add a dollop of Potato Chips + * // Add a dollop of Ketchup + * + */ +function constructN(n, Klass) { + if (!isNumberPrimitive(n)) { + return constructN(n.length, n) + } + else if (n === 0) { + return () => new Klass() + } + else { + /*, $5, $6, $7, $8, $9 */ + // curry(nAry(n, + return curry(n, function($0, $1, $2, $3, $4) { + const len = arguments.length + if (len === 1 || len > 5) return new Klass($0, $1, $2) + else if (len === 2) return new Klass($0, $1) + else if (len === 3) return new Klass($0, $1, $2) + else if (len === 4) return new Klass($0, $1, $2, $3) + else if (len === 5) return new Klass($0, $1, $2, $3, $4) + // else if (len=== 6) return new Klass($0, $1, $2, $3, $4, $5) + // else if (len=== 7) return new Klass($0, $1, $2, $3, $4, $5, $6) + // else if (len=== 8) return new Klass($0, $1, $2, $3, $4, $5, $6, $7) + // else if (len=== 9) return new Klass($0, $1, $2, $3, $4, $5, $6, $7, $8) + // else if (len === 10) return new Klass($0, $1, $2, $3, $4, $5, $6, $7, $8, $9) + }) + // )) + } +} + +// module.exports = curry(2, constructN) +module.exports = constructN diff --git a/src/deps/fp/constructInit.js b/src/deps/fp/constructInit.js new file mode 100644 index 0000000..a5d68b5 --- /dev/null +++ b/src/deps/fp/constructInit.js @@ -0,0 +1,10 @@ +/* istanbul ignore: @TODO */ + +// adds .init function that is constructN +// @NOTE construct +// function addInit(Klass) { +// Klass.prototype.init = function() { +// return new Klass(arguments) +// } +// // return Klass +// } diff --git a/src/deps/fp/curry.js b/src/deps/fp/curry.js new file mode 100644 index 0000000..4c1fc92 --- /dev/null +++ b/src/deps/fp/curry.js @@ -0,0 +1,141 @@ +const _isPlaceholder = require('./isPlaceholder') +const _arity = require('./arity') + + +/** + * Returns a curried equivalent of the provided function, with the specified + * arity. The curried function has two unusual capabilities. First, its + * arguments needn't be provided one at a time. If `g` is `R.curryN(3, f)`, the + * following are equivalent: + * + * - `g(1)(2)(3)` + * - `g(1)(2, 3)` + * - `g(1, 2)(3)` + * - `g(1, 2, 3)` + * + * Secondly, the special placeholder value [`R.__`](#__) may be used to specify + * "gaps", allowing partial application of any combination of arguments, + * regardless of their positions. If `g` is as above and `_` is [`R.__`](#__), + * the following are equivalent: + * + * - `g(1, 2, 3)` + * - `g(_, 2, 3)(1)` + * - `g(_, _, 3)(1)(2)` + * - `g(_, _, 3)(1, 2)` + * - `g(_, 2)(1)(3)` + * - `g(_, 2)(1, 3)` + * - `g(_, 2)(_, 3)(1)` + * + * @func + * @memberOf fp + * @since 5.0.0-beta.1 + * @ramda v0.5.0 + * @category Function + * @sig Number -> (* -> a) -> (* -> a) + * + * @param {Number} length The arity of the curried function. + * @param {Array} received An array of arguments received thus far. + * @param {Function} fn The function to curry. + * @return {Function} A new, curried function. + * + * {@link https://github.com/ramda/ramda/blob/master/src/uncurryN.js ramda-uncurry} + * {@link https://github.com/ramda/ramda/blob/master/src/curryN.js ramda-curry} + * {@link https://github.com/lodash/lodash/blob/master/curry.js lodash-curry} + * @see {@link ramda-curry} + * @see {@link lodash-curry} + * @see {@link ramda-uncurry} + * + * @types fp + * @tests fp/curry + * + * @example + * + * var sumArgs = (...args) => R.sum(args); + * + * var curriedAddFourNumbers = R.curryN(4, sumArgs); + * var f = curriedAddFourNumbers(1, 2); + * var g = f(3); + * g(4); //=> 10 + * + */ +function _curryN(length, received, fn) { + return function() { + const combined = [] + let argsIdx = 0 + let left = length + let combinedIdx = 0 + + while (combinedIdx < received.length || argsIdx < arguments.length) { + let result + + if ( + combinedIdx < received.length && + (!_isPlaceholder(received[combinedIdx]) || argsIdx >= arguments.length) + ) { + result = received[combinedIdx] + } + else { + result = arguments[argsIdx++] + // argsIdx += 1 + } + combined[combinedIdx++] = result + if (!_isPlaceholder(result)) { + left -= 1 + } + // combinedIdx += 1 + } + return left <= 0 + ? fn.apply(this, combined) + : _arity(left, _curryN(length, combined, fn)) + } +} + +/** + * Returns a curried equivalent of the provided function, with the specified + * arity. The curried function has two unusual capabilities. First, its + * arguments needn't be provided one at a time. If `g` is `R.curryN(3, f)`, the + * following are equivalent: + * + * - `g(1)(2)(3)` + * - `g(1)(2, 3)` + * - `g(1, 2)(3)` + * - `g(1, 2, 3)` + * + * Secondly, the special placeholder value [`R.__`](#__) may be used to specify + * "gaps", allowing partial application of any combination of arguments, + * regardless of their positions. If `g` is as above and `_` is [`R.__`](#__), + * the following are equivalent: + * + * - `g(1, 2, 3)` + * - `g(_, 2, 3)(1)` + * - `g(_, _, 3)(1)(2)` + * - `g(_, _, 3)(1, 2)` + * - `g(_, 2)(1)(3)` + * - `g(_, 2)(1, 3)` + * - `g(_, 2)(_, 3)(1)` + * + * @func + * @memberOf fp + * @since v0.5.0 + * @category Function + * @sig Number -> (* -> a) -> (* -> a) + * + * @param {Number} length The arity for the returned function. + * @param {Function} fn The function to curry. + * @return {Function} A new, curried function. + * + * @see ramda + * + * @example + * + * var sumArgs = (...args) => R.sum(args); + * + * var curriedAddFourNumbers = R.curryN(4, sumArgs); + * var f = curriedAddFourNumbers(1, 2); + * var g = f(3); + * g(4); //=> 10 + * + */ +module.exports = function curryN(length, fn) { + return _arity(length, _curryN(length, [], fn)) +} diff --git a/src/deps/fp/first.js b/src/deps/fp/first.js new file mode 100644 index 0000000..4df4f2f --- /dev/null +++ b/src/deps/fp/first.js @@ -0,0 +1,33 @@ +const firstIndex = require('./firstIndex') + +/** + * Returns the first element of the given list or string. In some libraries + * this function is named `first`. + * + * @memberOf fp + * @since v5.0.0 + * + * @extends deps/fp/firstIndex + * @param {*} x Array or Object find the last key of + * @return {*} value at last index + * + * @func + * @category List + * @sig [a] -> a | Undefined + * @sig String -> String + * + * @see https://github.com/lodash/lodash/blob/master/head.js + * @see https://github.com/ramda/ramda/blob/master/src/head.js + * @see R.init, R.head, R.tail + * @TODO could just pipe nth + * + * @example + * + * first(['fi', 'fo', 'fum']); //=> 'fi' + * first([]); //=> undefined + * + * first('abc'); //=> 'a' + * first(''); //=> '' + * + */ +module.exports = x => x[firstIndex(x)] diff --git a/src/deps/fp/firstIndex.js b/src/deps/fp/firstIndex.js new file mode 100644 index 0000000..e7f5208 --- /dev/null +++ b/src/deps/fp/firstIndex.js @@ -0,0 +1,29 @@ +const keys = require('../util/keysObjOrArray') +const isArray = require('../is/array') + +/** + * get first index in a list + * @memberOf fp + * @since 5.0.0-beta.2 + * + * @param {Array | Object | string | *} x item to find the first index of + * @return {*} first index, usually number/string + * + * @NOTE works for strings too eh + * @extends deps/util/keysObjOrArray + * @see deps/fp/first + * + * @example + * + * firstIndex([0, 'one']) //=> 0 + * firstIndex({one: 1, two: 2}) //=> 'one' + * + */ +function firstIndex(x) { + return (isArray(x) ? x : keys(x))[0] + // const xKeys = isArray(x) ? x : keys(x) + // const first = xKeys[0] + // return first +} + +module.exports = firstIndex diff --git a/src/deps/fp/flip.js b/src/deps/fp/flip.js new file mode 100644 index 0000000..f573960 --- /dev/null +++ b/src/deps/fp/flip.js @@ -0,0 +1,44 @@ +const argumentor = require('../argumentor') + +/** + * @desc flip the fn args: + * Creates a function that invokes `func` with arguments reversed. + * + * @memberOf fp + * @symb 🙃 + * @since 5.0.0-beta.4 + * + * @param {Function} fn The function to invoke with its first two parameters reversed. + * @return {*} The result of invoking `fn` with its first two parameters' order reversed. + * + * @func + * @ramda v0.1.0 + * @category Function + * @sig ((a, b, c, ...) -> z) -> (b -> a -> c -> ... -> z) + * + * @TODO could also just call with fn.apply([b, a]), and have flipN + * + * {@link https://github.com/lodash/lodash/blob/4.2.1-npm-packages/lodash.flip/index.js lodash-flip} + * {@link https://github.com/ramda/ramda/blob/master/src/flip.js ramda-flip} + * @see {@link ramda-flip} + * @see {@link lodash-flip} + * @see fp/reverse + * + * @types fp + * @tests fp/flip + * + * @example + * + * var mergeThree = (a, b, c) => [].concat(a, b, c) + * mergeThree(1, 2, 3); //=> [1, 2, 3] + * flip(mergeThree)(1, 2, 3); //=> [3, 2, 1] + * + * const flipped = flip((...args) => args) + * flipped('a', 'b', 'c', 'd') + * // => ['d', 'c', 'b', 'a'] + */ +module.exports = function flip(fn) { + return function() { + return fn.apply(this, argumentor.apply(null, arguments).reverse()) + } +} diff --git a/src/deps/fp/flip2.js b/src/deps/fp/flip2.js new file mode 100644 index 0000000..d6b1ebb --- /dev/null +++ b/src/deps/fp/flip2.js @@ -0,0 +1,42 @@ +const argumentor = require('../argumentor') +const curry = require('./curry') + +/** + * Returns a new function much like the supplied one, except that the first two + * arguments' order is reversed. + * + * @memberOf fp + * @symb 🙃🙃 + * @since 5.0.0-beta.4 + * + * @param {Function} fn The function to invoke with its first two parameters reversed. + * @return {*} The result of invoking `fn` with its first two parameters' order reversed. + * + * @extends fp/flip + * @variation just flip, but flips arg 1-2 instead of reversing all arguments + * @see fp/flip + * @TODO flipN + * + * @types fp + * @tests fp/flip2 + * + * @example + * + * var mergeThree = (a, b, c) => [].concat(a, b, c) + * mergeThree(1, 2, 3); //=> [1, 2, 3] + * flip(mergeThree)(1, 2, 3); //=> [2, 1, 3] + * + * const flipped = flip((...args) => args) + * flipped('a', 'b', 'c', 'd') + * // => ['b', 'a', 'c', 'd'] + * + */ +module.exports = function flip2(fn) { + return curry(2, function(a, b) { + const args = argumentor.apply(null, arguments) + // .slice(n).reverse().splice() + args[0] = b + args[1] = a + return fn.apply(this, args) + }) +} diff --git a/src/deps/fp/fp.js b/src/deps/fp/fp.js new file mode 100644 index 0000000..601198b --- /dev/null +++ b/src/deps/fp/fp.js @@ -0,0 +1,52 @@ +/* istanbul ignore: for docblocks @member */ + +const always = require('./always') +const arity = require('./arity') +const curry = require('./curry') +const first = require('./first') +const last = require('./last') +const mapWhere = require('./mapWhere') +const path = require('./path') +const pipe = require('./pipe') +const prop = require('./prop') +const construct = require('./construct') +const firstIndex = require('./firstIndex') +const lastIndex = require('./lastIndex') +const hasInMatching = require('./hasInMatching') +const includesCount = require('./includesCount') +const remove = require('./remove') +const replace = require('./replace') +const reverse = require('./reverse') +const invoke = require('./invoke') +const flip = require('./flip') +const flip2 = require('./flip2') + +/** + * @member fp + * @symb 🐏 + * @tests fp/* + * @types fp + * @type {Object} + */ +module.exports = { + always, + arity, + construct, + hasInMatching, + includesCount, + invoke, + curry, + first, + firstIndex, + flip, + flip2, + last, + lastIndex, + mapWhere, + path, + pipe, + prop, + replace, + remove, + reverse, +} diff --git a/src/deps/fp/hasInMatching.js b/src/deps/fp/hasInMatching.js new file mode 100644 index 0000000..a8a90da --- /dev/null +++ b/src/deps/fp/hasInMatching.js @@ -0,0 +1,34 @@ +const curry = require('../fp/curry') +const hasIn = require('../is/in') + +/** + * @TODO surely would be better with focusing on a prop, then applying predicate, lense? :s + * @TODO is it better in fp/ or is/ ? needs some definitions + * + * @desc isIn + hasIn ...and also allows a predicate/matcher/specification + * + * @memberOf is + * @since 5.0.0-beta.4 + * + * @param {Object} predicate predicate match the property against this + * @param {Object} obj object to check + * @param {any} prop property to check in object + * @return {boolean} obj[prop] hasIn & satisfies + * + * @see https://github.com/ramda/ramda/blob/master/src/propOr.js + * @extends hasIn + * @extends isNull + * @extends isIn + * + * @example + * + * hasIn({}, 'eh') //=> false + * hasIn(null, 'eh') //=> false + * hasIn({eh: true}, 'eh') //=> true + * + */ +function hasInMatching(predicate, obj, prop) { + return hasIn(obj, prop) && predicate(obj[prop]) +} + +module.exports = curry(3, hasInMatching) diff --git a/src/deps/fp/includesCount.js b/src/deps/fp/includesCount.js new file mode 100644 index 0000000..c4ca450 --- /dev/null +++ b/src/deps/fp/includesCount.js @@ -0,0 +1,76 @@ +const isArray = require('../is/array') +const isString = require('../is/stringPrimitive') +const esc = require('../matcher/to-regexp') +const pipe = require('../fp/pipe') +const curry = require('../fp/curry') +const invoke = require('../fp/invoke') +const lengthMinusOne = require('../util/lengthMinusOne') +const newRegExp = require('../construct/regexp') +const prop = require('../fp/prop') + +// @NOTE similar https://github.com/ramda/ramda/blob/master/src/countBy.js + +// @TODO move this +// @TODO invoke('_', prop('test')) +// const toTest = invoke('_', prop('test')) +const toTest = x => y => x.test(y) +// function toTest(x) { +// return function(y) { +// return x.test(y) +// } +// } + +// const newRegExp = (source) => new RegExp(source) +const toRegExp = pipe(esc, newRegExp, toTest) + +// @TODO could have `method` for curring with .flip .invoke +const split = invoke('_', 'split') +const filter = invoke('_', 'filter') + +const emptyArr = [] + +/** + * @desc getIncludesCount, how many times a needle occurrs in a haystack + * + * @since 5.0.0-beta.4 + * @alias occurrs + * @alias getIncludesCount + * + * @param {string | Array} haystack haystack to look in + * @param {string | Matchable} needle needle to find + * @return {number} occurrs/includes times/count + * + * {@link https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/indexOf#Finding_all_the_occurrences_of_an_element mozilla-array-occurrences} + * {@link https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/String/indexOf#Using_indexOf()_to_count_occurrences_of_a_letter_in_a_string mozilla-occurrences} + * @see {@link mozilla-occurrences} + * @see {@link mozilla-array-occurrences} + * + * @example + * + * getIncludesCount('1 00 1', '1') //=> 2 + * getIncludesCount([1, 1, 0, 0], 1) //=> 2 + * getIncludesCount([0], 1) //=> 0 + * getIncludesCount('', 1) //=> 0 + * getIncludesCount(null, 1) //=> 0 + * + */ +function getIncludesCount(haystack, needle) { + if (isString(haystack)) { + // return haystack.split(needle) + return split(haystack, needle) + } + else if (isArray(haystack)) { + // @TODO this disables ternary ability + // const matcher = toRegExp(needle).test + // return haystack.filter(toRegExp(needle)) + return filter(haystack, toRegExp(needle)) + } + // may not be needed... + else { + return emptyArr + } +} + +// curry for 2 args, pipe result through to .length - 1 +const getIncludesThenLength = pipe(getIncludesCount, lengthMinusOne) +module.exports = curry(2, getIncludesThenLength) diff --git a/src/deps/fp/index.js b/src/deps/fp/index.js new file mode 100644 index 0000000..e92a521 --- /dev/null +++ b/src/deps/fp/index.js @@ -0,0 +1,3 @@ +/* istanbul ignore: for ease of use */ + +module.exports = require('./fp.js') diff --git a/src/deps/fp/invoke.js b/src/deps/fp/invoke.js new file mode 100644 index 0000000..0f3b7cf --- /dev/null +++ b/src/deps/fp/invoke.js @@ -0,0 +1,74 @@ +/* eslint consistent-return: "OFF" */ + +const curry = require('../fp/curry') +const hasIn = require('../is/hasIn') + +/** + * Creates a function that invokes the method at `path` of a given object. + * Any additional arguments are provided to the invoked method. + * + * @ignore + * @private + * @name method + * @NOTE basically this is `invoke` but not curried + * + * @since 5.0.0-beta.4 + * @lodash 3.7.0 + * @category Util + * + * @param {Array|string} path The path of the method to invoke. + * @param {Array} [args] The arguments to invoke the method with. + * @returns {Function} Returns the new invoker function. + * + * @see https://github.com/lodash/lodash/blob/master/method.js + * + * @example + * + * const objects = [ + * { 'a': { 'b': () => 2 } }, + * { 'a': { 'b': () => 1 } } + * ] + * + * map(objects, method('a.b')) + * // => [2, 1] + * + * map(objects, method(['a', 'b'])) + * // => [2, 1] + */ + +/** + * @desc call a method when it exists + * @since 5.0.0-beta.4 + * @memberOf fp + * @symb 📞 + * + * @param {*} x object + * @param {*} key property with method + * @param {*} args arguments + * @return {*} + * + * @TODO add `path` calling, fallback to noop + * @see is/hasIn + * + * {@link http://underscorejs.org/docs/underscore.html#section-33 underscore-invoke} + * {@link https://github.com/lodash/lodash/blob/master/invoke.js lodash-invoke} + * @see {@link lodash-invoke} + * @see {@link underscore-invoke} + * + * @example + * + * var obj = {eh: console.log} + * invoke(obj, 'eh', 'eh!') + * //=> console.log('eh!') + * + * var getTag = invoke(Object.prototype.toString, 'call') + * getTag([]) + * //=> '[object Array]' + * + */ +function _invoke(x, key, args) { + if (hasIn(x, key)) return x[key](args) + // return void 0 +} + +module.exports = curry(3, _invoke) diff --git a/src/deps/fp/isPlaceholder.js b/src/deps/fp/isPlaceholder.js new file mode 100644 index 0000000..33d32e6 --- /dev/null +++ b/src/deps/fp/isPlaceholder.js @@ -0,0 +1,3 @@ +module.exports = function _isPlaceholder(x) { + return x === '_' +} diff --git a/src/deps/fp/last.js b/src/deps/fp/last.js new file mode 100644 index 0000000..9f0484c --- /dev/null +++ b/src/deps/fp/last.js @@ -0,0 +1,33 @@ +const lastIndex = require('./lastIndex') + +/** + * Returns the last element of the given list or string. + * + * @func + * @memberOf fp + * @since 5.0.0-beta.2 + * + * @param {*} x list to get last index of + * @return {*} + * + * @ramda v0.1.4 + * @category List + * @sig [a] -> a | Undefined + * @sig String -> String + * + * @see R.init, R.head, R.tail + * @extends deps/fp/lastIndex + * + * @types fp + * @tests fp/* + * + * @example + * + * last(['fi', 'fo', 'fum']); //=> 'fum' + * last([]); //=> undefined + * + * last('abc'); //=> 'c' + * last(''); //=> '' + * + */ +module.exports = x => x[lastIndex(x)] diff --git a/src/deps/fp/lastIndex.js b/src/deps/fp/lastIndex.js new file mode 100644 index 0000000..62f5875 --- /dev/null +++ b/src/deps/fp/lastIndex.js @@ -0,0 +1,30 @@ +const keys = require('../util/keysObjOrArray') +const lengthMinusOne = require('../util/lengthMinusOne') +const isArray = require('../is/array') + +/** + * get last index in a list + * @memberOf fp + * @since 5.0.0-beta.2 + * + * @param {Array | Object | string | *} x item to find the last index of + * @return {*} last index, usually number/string + * + * @NOTE works for strings too eh + * @extends deps/util/keysObjOrArray + * @see deps/fp/last + * + * @example + * + * lastIndex([0, 'one']) //=> 1 + * lastIndex({one: 1, two: 2}) //=> 'two' + * + */ +function lastIndex(x) { + const xKeys = isArray(x) ? x : keys(x) + return xKeys[lengthMinusOne(xKeys)] + // const last = xKeys[xKeys.length - 1] + // return last +} + +module.exports = lastIndex diff --git a/src/deps/fp/mapWhere.js b/src/deps/fp/mapWhere.js new file mode 100644 index 0000000..e38c719 --- /dev/null +++ b/src/deps/fp/mapWhere.js @@ -0,0 +1,43 @@ +const isArray = require('../is/array') +const objOrArrayKeys = require('../util/keysObjOrArray') +const curry = require('../fp/curry') + +/** + * Creates an array of values by running each property of `object` thru + * `iteratee`. The iteratee is invoked with three arguments: (value, key, object). + * + * @memberOf fp + * @since 5.0.0 + * @category Object + * + * @param {Object} obj The object to iterate over. + * @param {Function} predicate The function invoked per iteration. + * @return {Array} Returns the new mapped array. + * + * @see https://github.com/lodash/lodash/blob/master/map.js + * + * @example + * + * const square = n => n * n + * map({ 'a': 4, 'b': 8 }, square) + * // => [16, 64] (iteration order is not guaranteed) + * + */ +function mapWhere(obj, predicate) { + const output = {} + const isArrayObj = isArray(obj) + const keys = objOrArrayKeys(obj) + + for (let index = 0; index < keys.length; index++) { + const key = isArrayObj ? index : keys[index] + const value = obj[key] + + if (predicate(value, key, obj)) { + output[key] = value + } + } + + return output +} + +module.exports = curry(2, mapWhere) diff --git a/src/deps/fp/path.js b/src/deps/fp/path.js new file mode 100644 index 0000000..e0093c7 --- /dev/null +++ b/src/deps/fp/path.js @@ -0,0 +1,37 @@ +const isNullOrUndefined = require('../is/nullOrUndefined') +const curry = require('./curry') + +/** + * Retrieve the value at a given path. + * + * @func + * @memberOf fp + * @since v5.0.0 + * @category Object + * @typedefn Idx = String | Int + * @sig [Idx] -> {a} -> a | Undefined + * + * @param {Array} path The path to use. + * @param {Object} obj The object to retrieve the nested property from. + * @return {*} The data at `path`. + * + * @see https://github.com/ramda/ramda/blob/master/src/path.js + * @see R.prop + * + * @example + * + * R.path(['a', 'b'], {a: {b: 2}}); //=> 2 + * R.path(['a', 'b'], {c: {b: 2}}); //=> undefined + * + */ +module.exports = curry(2, function path(paths, obj) { + let value = obj + let index = 0 + + while (index < paths.length) { + if (isNullOrUndefined(value)) return + value = value[paths[index++]] + } + + return value +}) diff --git a/src/deps/fp/pipe.js b/src/deps/fp/pipe.js new file mode 100644 index 0000000..af7fbb6 --- /dev/null +++ b/src/deps/fp/pipe.js @@ -0,0 +1,54 @@ +const isArray = require('../is/array') +const argumentor = require('../argumentor') +const pipeTwo = require('./pipeTwo') + +/** + * Performs left-to-right function composition. The leftmost function may have + * any arity; the remaining functions must be unary. + * In some libraries this function is named `sequence`. + * + * @icon | + * @func + * @memberOf fp + * @since v5.0.0 + * @category Function + * @sig (((a, b, ..., n) -> o), (o -> p), ..., (x -> y), (y -> z)) -> ((a, b, ..., n) -> z) + * @symb R.pipe(f, g, h)(a, b) = h(g(f(a, b))) + * @extends fp/pipeTwo + * + * @param {Function} first function first + * @param {...Function} rest function next + * @return {Function} + * + * @see R.compose + * @see https://github.com/ramda/ramda/blob/master/src/pipe.js + * @see https://github.com/ramda/ramda/blob/master/test/pipe.js + * + * @types fp + * @tests fp/pipe + * + * @example + * + * var f = R.pipe(Math.pow, R.negate, R.inc); + * f(3, 4); // -(3^4) + 1 + * + * @example + * + * var x = v => v + 'x' + * var y = v => v + 'y' + * var z = v => v + 'z' + * + * const xyz = pipe(x, y, z) + * /// starts with w, adds x, then y, then z + * const wxyz = xyz('w') + * //=> 'wxyz' + */ +module.exports = function pipe(first) { + // @TODO: could move into pipeArray + // could start from first, second? etc? + // (isArray(first) ? first : argumentor.apply(null, arguments)) + let args = argumentor.apply(null, arguments) + .slice(1).reduce((previous, next) => pipeTwo(previous, next)) + + return pipeTwo(first, args) +} diff --git a/src/deps/fp/pipeTwo.js b/src/deps/fp/pipeTwo.js new file mode 100644 index 0000000..1e050bd --- /dev/null +++ b/src/deps/fp/pipeTwo.js @@ -0,0 +1,32 @@ +/** + * Performs left-to-right function composition. ONLY CAN PIPE 2 ARGUMENTS + * + * @NOTE The result of pipe is not automatically curried. + * @NOTE This is a variation, is the internal version with only 2 functions, for now + * + * @func + * @memberOf fp + * @since v5.0.0 + * @category Function + * + * @param {...Function} f function first + * @param {...Function} g function next + * @return {Function} + * + * @see https://github.com/ramda/ramda/blob/master/src/pipe.js + * @see https://github.com/ramda/ramda/blob/master/test/pipe.js + * + * @types fp + * @tests fp/pipe + * + * @example + * + * var f = R.pipe(Math.pow, R.negate); + * f(3, 4); // -(3^4) + 1 + * + */ +module.exports = function _pipe(f, g) { + return function() { + return g.call(this, f.apply(this, arguments)) + } +} diff --git a/src/deps/fp/prop.js b/src/deps/fp/prop.js new file mode 100644 index 0000000..3a42fb8 --- /dev/null +++ b/src/deps/fp/prop.js @@ -0,0 +1,26 @@ +const curry = require('./curry') + +/** + * Returns a function that when supplied an object returns the indicated + * property of that object, if it exists. + * + * @func + * @memberOf fp + * @since v5.0.0 + * @category Object + * @sig s -> {s: a} -> a | Undefined + * + * @param {String} p The property name + * @param {Object} obj The object to query + * @return {*} The value at `obj.p`. + * + * @types fp + * @tests fp/prop + * + * @example + * + * R.prop('x', {x: 100}); //=> 100 + * R.prop('x', {}); //=> undefined + * + */ +module.exports = curry(2, (p, obj) => obj[p]) diff --git a/src/deps/fp/remove.js b/src/deps/fp/remove.js new file mode 100644 index 0000000..c63b3c3 --- /dev/null +++ b/src/deps/fp/remove.js @@ -0,0 +1,10 @@ +const isObjNotNull = require('../is/objNotNull') +const isUndefined = require('../is/undefined') +const isArray = require('../is/array') +const curry = require('./curry') + +// @TODO remove with index, or with value +module.exports = curry(2, function removeFromArrayOrObj(obj, key) { + if (isArray(obj)) obj.splice(key, 1) + else if (isObjNotNull(obj)) delete obj[key] +}) diff --git a/src/deps/fp/replace.js b/src/deps/fp/replace.js new file mode 100644 index 0000000..9cc0ef8 --- /dev/null +++ b/src/deps/fp/replace.js @@ -0,0 +1,36 @@ +const curry = require('./curry') + +/** + * Replace a substring or regex match in a string with a replacement. + * + * @func + * @memberOf fp + * @since v5.0.0 + * @category String + * @sig RegExp|String -> String -> String -> String + * + * @param {RegExp|String} pattern A regular expression or a substring to match. + * @param {String} replacement The string to replace the matches with. + * @param {String} str The String to do the search and replacement in. + * @return {String} The result. + * + * @types fp + * @tests fp/replace + * + * {@link https://github.com/ramda/ramda/blob/master/src/replace.js ramda-replace} + * {@link https://github.com/lodash/lodash/blob/master/replace.js lodash-replace} + * @see {@link ramda-replace} + * @see {@link lodash-replace} + * + * @example + * + * replace('foo', 'bar', 'foo foo foo'); //=> 'bar foo foo' + * replace(/foo/, 'bar', 'foo foo foo'); //=> 'bar foo foo' + * + * // Use the "g" (global) flag to replace all occurrences: + * replace(/foo/g, 'bar', 'foo foo foo'); //=> 'bar bar bar' + * + */ +module.exports = curry(3, function replace(pattern, replacement, str) { + return str.replace(pattern, replacement) +}) diff --git a/src/deps/fp/reverse.js b/src/deps/fp/reverse.js new file mode 100644 index 0000000..ebb0c26 --- /dev/null +++ b/src/deps/fp/reverse.js @@ -0,0 +1,43 @@ +const slice = require('../native/arraySlice') +const isString = require('../is/string') + +/** + * Returns a new list or string with the elements or characters in reverse + * order. + * + * @symb ⬅️ + * @memberOf fp + * @since 5.0.0-beta.5 + * + * @param {Array|String} x (list) string or array to reverse + * @return {Array|String} + * + * @func + * @ramda v0.1.0 + * @category List + * @sig [a] -> [a] + * @sig String -> String + * + * {@link https://stackoverflow.com/a/26610963/2855712 stack-overflow-10-ways-to-reverse-string} + * {@link https://github.com/ramda/ramda/blob/master/src/reverse.js ramda-reverse} + * @see {@link ramda-reverse} + * @see {@link stack-overflow-10-ways-to-reverse-string} + * + * @example + * + * reverse([1, 2, 3]); //=> [3, 2, 1] + * reverse([1, 2]); //=> [2, 1] + * reverse([1]); //=> [1] + * reverse([]); //=> [] + * + * reverse('abc'); //=> 'cba' + * reverse('ab'); //=> 'ba' + * reverse('a'); //=> 'a' + * reverse(''); //=> '' + * + */ +module.exports = function reverse(x) { + return isString(x) + ? x.split('').reverse().join('') + : slice.call(x, 0).reverse() +} diff --git a/src/deps/gc.js b/src/deps/gc.js index e9c5a4d..0567e88 100644 --- a/src/deps/gc.js +++ b/src/deps/gc.js @@ -2,6 +2,7 @@ const ObjectProperties = require('./util/props') const traverse = require('./traverse') const isObj = require('./is/obj') const isArray = require('./is/array') +const keys = require('./util/keysObjOrArray') // function gc() { // if (typeof window !== 'undefined') window.global = window @@ -40,7 +41,8 @@ const isArray = require('./is/array') */ function markForGarbageCollection(obj) { // @TODO: ArrayOrObj loop... like tons of libs do... - let props = isObj(obj) ? ObjectProperties(obj) : obj //isArray(obj) ? obj + // let props = isObj(obj) ? ObjectProperties(obj) : obj //isArray(obj) ? obj + let props = keys(obj) for (let p = 0; p < props.length; p++) { if (isObj(obj[p])) { diff --git a/src/deps/is/JSON.js b/src/deps/is/JSON.js new file mode 100644 index 0000000..9f9ffd5 --- /dev/null +++ b/src/deps/is/JSON.js @@ -0,0 +1,85 @@ +const getIncludesCount = require('../fp/includesCount') +const isEven = require('../expressions/even') +const isArray = require('./array') +const isNumber = require('./numberPrimitive') +const isString = require('./stringPrimitive') +const isTrue = require('./true') + +// https://bitsrc.io/amit/json/global/json-validator/code +// +// const onlyLettersAndSpaces = /^([\sa-z]+)*$/gim +// const regexp = /[\"|\{|\[|\}|]+/ +// const chars = ['[', '"', '{', ']', '}'] +// const nums = [91, 34] +// const map = { +// '"': 34, +// '{': 123, +// '}': 125, +// ']': 93, +// '[': 91, +// } + + +// @TODO everything like this (with numbers) +// eslint-disable-next-line no-useless-escape +const JSONAlphaOmega = x => + x === 93 || x === 91 || x === 125 || x === 123 || x === 34 + + +function hasWith(x, fn, symbol) { + if (isArray(symbol)) return symbol.map(s => hasWith(x, fn, s)).every(isTrue) + else return fn(getIncludesCount(x.split(''), symbol)) +} + +const isValidJSONLine = subString => { + const trimmed = subString.trim() + const start = trimmed.charCodeAt(0) + const end = trimmed.charCodeAt(trimmed.length - 1) + return JSONAlphaOmega(start) && JSONAlphaOmega(end) +} + +/* prettier-ignore */ +/** + * @desc isJSON, without tryCatch + * @param {*} x value to check + * @return {boolean} x isJSON + * + * @example + * isJSON('{}') + * // => true + * + * isJSON('') + * // => false + * + * isJSON('[]') + * // => true + */ +function isJSON(x) { + return isString(x) && x.split(',').every(isValidJSONLine) +} + +function isJSONSafe(x) { + return isJSON(x) && hasWith(x, isEven, ['[', ']', '{', '}', '"']) +} + +// https://github.com/mootools/mootools-core/blob/master/Source/Utilities/JSON.js + +const reValidJSON = /^[\],:{}\s]*$/ +const reProps = /\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g +const reVals = /"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g +const reColons = /(?:^|:|,)(?:\s*\[)+/g + +// const replacements = [ +// replace(reProps, '@'), +// replace(reVals, ']'), +// replace(reColons, ':'), +// ] +// const replaceAll = pipe(replacements) + +function isValidJSON(string) { + reValidJSON.test( + string.replace(reProps, '@').replace(reVals, ']').replace(reColons, '') + ) +} + +module.exports = isJSON diff --git a/src/deps/is/README.md b/src/deps/is/README.md index 7b617e4..a6f9794 100644 --- a/src/deps/is/README.md +++ b/src/deps/is/README.md @@ -3,3 +3,4 @@ https://www.npmjs.com/package/kind-of https://github.com/lodash/lodash/blob/master/isString.js https://github.com/lodash/lodash/blob/master/.internal/baseGetTag.js https://github.com/lodash/lodash/blob/master/.internal/getTag.js +https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures diff --git a/src/deps/is/arguments.js b/src/deps/is/arguments.js new file mode 100644 index 0000000..8959786 --- /dev/null +++ b/src/deps/is/arguments.js @@ -0,0 +1,57 @@ +const hasOwnProperty = require('../util/hasOwnProperty') +const isEnumerable = require('./enumerable') +const toS = require('./toS') + +/** + * @desc check if toString on object is Arguments + * @since 4.0.0 + * + * @param {Object | *} x value to check if isArguments + * @return {boolean} isArguments + * + * @see is/toS + * @name isArguments + * @func + * + * + * {@link http://underscorejs.org/docs/underscore.html#section-141 underscore-is-arguments} + * {@link https://github.com/substack/node-deep-equal/blob/master/lib/is_arguments.js node-deep-equals-is-arguments} + * {@link https://github.com/lodash/lodash/blob/master/isArguments.js lodash-is-arguments} + * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/arguments mozilla-func-arguments} + * @see {@link mozilla-func-arguments} + * @see {@link node-deep-equals-is-arguments} + * @see {@link lodash-is-arguments} + * @see {@link underscore-is-arguments} + * + * @example + * + * isArguments({}) //=> false + * (function() { + * isArguments(arguments) + * //=> true + * })() + * + */ +function isArguments(x) { + return toS(x) === '[object Arguments]' +} + +module.exports = isArguments + +// function unsupported(object) { +// return ( +// (object && +// typeof object === 'object' && +// typeof object.length === 'number' && +// hasOwnProperty(object, 'callee') && +// !isEnumerable.call(object, 'callee')) || +// false +// ) +// } +// +// const supportsArgumentsClass = +// (function() { +// return toS(arguments) +// })() === '[object Arguments]' +// +// module.exports = supportsArgumentsClass ? supported : unsupported diff --git a/src/deps/is/array.js b/src/deps/is/array.js index 71d84e1..f8da72e 100644 --- a/src/deps/is/array.js +++ b/src/deps/is/array.js @@ -1,6 +1,16 @@ /** - * @func isArray - * @see https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray + * @name isArray + * @func + * @memberOf is + * + * {@link https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray mozilla-isarray} + * {@link https://github.com/facebook/immutable-js/blob/master/src/utils/isArrayLike.js immutables-is-array-like} + * @todo is-arraylike https://github.com/facebook/immutable-js/blob/master/src/utils/isArrayLike.js + * + * @param {*} arg + * @return {boolean} isArray(arg) + * + * @see {@link mozilla-isarray} * @type {Function} * @since 3.0.0 */ diff --git a/src/deps/is/arrayOf.js b/src/deps/is/arrayOf.js new file mode 100644 index 0000000..d0cef51 --- /dev/null +++ b/src/deps/is/arrayOf.js @@ -0,0 +1,25 @@ +const and = require('../conditional/and') +const all = require('../conditional/all') +const isArray = require('./array') + +/** + * @desc every item in an array matches predicate + * @since 4.0.0 was in validatorBuilder + * @version 5.0.0 + * + * @memberOf is + * @param {Function} predicate test to pass on every item in an array + * @return {boolean} all match predicate + * + * @example + * + * isArrayOf(isTrue)([true, true]) //=> true + * isArrayOf(isEmpty)(['']) //=> true + * + * isArrayOf(isBoolean)([true, false, 1, 2, 0]) //=> false + * isArrayOf(isString)(['string', Number]) //=> false + * + */ +module.exports = function isArrayOf(predicate) { + return and(isArray, all(predicate)) +} diff --git a/src/deps/is/async.js b/src/deps/is/async.js index aba138e..347d278 100644 --- a/src/deps/is/async.js +++ b/src/deps/is/async.js @@ -9,6 +9,7 @@ const toS = require('./toS') * * @memberOf is * @func isAsync + * @see is/toS * * @example * diff --git a/src/deps/is/asyncish.js b/src/deps/is/asyncish.js index 79acdfe..74e4b3c 100644 --- a/src/deps/is/asyncish.js +++ b/src/deps/is/asyncish.js @@ -1,29 +1,29 @@ +const or = require('../conditional/or') const isAsync = require('./async') const isPromise = require('./promise') /** * @desc async function or promise - * @category Lang + * @since 4.0.0-beta.2 + * @memberOf is * * @param {*} x value * @return {boolean} x isAsyncish - * @since 4.0.0-beta.2 * - * @memberOf is - * @func isAsyncish + * @category Lang + * @func + * @name isAsyncish * @extends isAsyncish * @extends isPromise * @variation isAsyncish OR isPromise * * @example * - * isAsyncish(async function() {}) - * //=> true - * isAsyncish(new Promise(r => r())) - * //=> true + * isAsyncish(async function() {}) //=> true + * isAsyncish(new Promise(r => r())) //=> true + * + * isAsyncish({}) //=> false + * isAsyncish(function() {}) //=> false * - * isAsyncish({}) - * //=> false - * isAsyncish(function() {}) */ -module.exports = x => isAsync(x) || isPromise(x) +module.exports = or(isAsync, isPromise) diff --git a/src/deps/is/boolean.js b/src/deps/is/boolean.js index a4ac0da..4f7ad7e 100644 --- a/src/deps/is/boolean.js +++ b/src/deps/is/boolean.js @@ -1,23 +1,22 @@ const toS = require('./toS') -const isTrue = require('./true') -const isFalse = require('./false') +const isBooleanPrimitive = require('./booleanPrimitive') /** - * @desc Checks if `value` is classified as a boolean primitive or object. - * @category Lang + * @desc Checks if `value` is classified as a boolean primitive OR object. * @since 3.0.0 + * @category Lang + * @memberOf is * * @param {*} x value * @return {boolean} isBoolean * * @extends isTrue * @extends isFalse + * @extends isBooleanPrimitive + * * @see is/toS - * @memberOf is * @func isBoolean * - * @NOTE could also have typeof x === 'boolean' || (/true|false/).test(x) - * * @example * * isBoolean(false) @@ -31,5 +30,5 @@ const isFalse = require('./false') * */ module.exports = function isBoolean(x) { - return isTrue(x) || isFalse(x) || toS(x) === '[object Boolean]' + return isBooleanPrimitive(x) || toS(x) === '[object Boolean]' } diff --git a/src/deps/is/booleanPrimitive.js b/src/deps/is/booleanPrimitive.js new file mode 100644 index 0000000..7db158a --- /dev/null +++ b/src/deps/is/booleanPrimitive.js @@ -0,0 +1,35 @@ +const isTrue = require('./true') +const isFalse = require('./false') + +/** + * @desc Checks if `value` is classified as a boolean primitive NOT object. + * @category Lang + * @since 5.0.0-beta.4 + * + * @param {*} x value + * @return {boolean} isBooleanPrimitive + * + * @extends isTrue + * @extends isFalse + * @see is/toS + * @memberOf is + * @func isBooleanPrimitive + * + * @NOTE could also have typeof x === 'boolean' || (/true|false/).test(x) + * + * @example + * + * isBooleanPrimitive(false) + * //=> true + * isBooleanPrimitive(new Boolean(1)) + * //=> false + * + * isBooleanPrimitive(1) + * //=> false + * isBooleanPrimitive('') + * //=> false + * + */ +module.exports = function isBooleanPrimitive(x) { + return isTrue(x) || isFalse(x) +} diff --git a/src/deps/is/browser.js b/src/deps/is/browser.js new file mode 100644 index 0000000..a83c5db --- /dev/null +++ b/src/deps/is/browser.js @@ -0,0 +1,16 @@ +const isUndefinedLike = require('./undefinedLike') + +/* istanbul ignore next: jest mess up */ +/** + * @desc check typeof window + * @since 5.0.0-beta.1 + * @memberOf is + * @return {boolean} is in browser, or has global window + * @name isBrowser + * @func + * @extends isUndefinedLike + * @see utils/localGlobal + * @example isBrowser() //=> true | false + */ +module.exports = () => + !isUndefinedLike(typeof window) && !isUndefinedLike(window.window) diff --git a/src/deps/is/buffer.js b/src/deps/is/buffer.js new file mode 100644 index 0000000..59d476c --- /dev/null +++ b/src/deps/is/buffer.js @@ -0,0 +1,36 @@ +const length = require('../util/length') +const isObj = require('./obj') +const isFunction = require('./function') +const isNumber = require('./number') + +/** + * @desc isBuffer, global Buffer + * @since 5.0.0-beta.1 + * + * @memberOf is + * @param {Buffer | *} x value to check if Buffer + * @return {boolean} x is Buffer + * + * If you need to support Safari 5-7 (8-10 yr-old browser), + * @see https://github.com/feross/is-buffer + * + * @example + * + * isBuffer({}) //=> false + * isBuffer(new Buffer('eh')) //=> true + * + */ +module.exports = function isBuffer(x) { + if (!x || isObj(x) || length(x)) return false + else if (!isFunction(x.copy) || isFunction(x.slice)) return false + else if (length(x) > 0 && isNumber(x[0])) return false + else return true +} + +// another way to write it +// module.exports = function isBuffer(val) { +// var c = val.constructor +// return c && +// typeof c.isBuffer === 'function' && +// c.isBuffer(val) +// } diff --git a/src/deps/is/circular.js b/src/deps/is/circular.js new file mode 100644 index 0000000..9b66c02 --- /dev/null +++ b/src/deps/is/circular.js @@ -0,0 +1,69 @@ +const isObj = require('./obj') + +/** + * safari, ff, chrome/opera + * @type {Array} + */ +const errorKeywords = ['circular', 'cyclic'] + +/** + * @desc check if a value is circular + * + * @memberOf is + * @since 5.0.0-beta.4 + * @symb 🔘 + * + * @param {Object | *} obj object to check if is circular + * @return {boolean} isCircular / hasCircular + * + * @TODO find the circular property... + * @NOTE is slow try catch json + * @NOTE if (isFunction(obj)) { throw new Error('cannot determine if function is circular')} + * + * @example + * + * const a = {}; + * a.b = a; + * isCircular(a) //=> true + * + * const a = {}; + * a.b = { + * c: a + * } + * isCircular(a) //=> true + * + * const a = {}; + * a.b = { + * c: 4 + * } + * isCircular(a) //=> false + * + * const a = []; + * a.push(a); + * isCircular(a) //=> true + * + * isCircular({}) //=> false + * isCircular('hi') //=> false + * isCircular(undefined) //=> false + * + */ +module.exports = function isCircular(obj) { + if (!isObj(obj)) return false + + try { + JSON.stringify(obj) + } + catch (err) { + let index = errorKeywords.length + while (index--) { + if (err.message.includes(errorKeywords[index])) { + return true + } + } + + // @NOTE should not do this + throw err + } + + return false +} diff --git a/src/deps/is/dot.js b/src/deps/is/dot.js index 007c49c..ed212b4 100644 --- a/src/deps/is/dot.js +++ b/src/deps/is/dot.js @@ -1,6 +1,26 @@ +const includes = require('../conditional/includes') const isArray = require('./array') const isString = require('./string') +/** + * @since 3.0.0 + * @memberOf is + * @name isDot + * + * @TODO update with conditional + * + * @param {*} x value to check + * @return {boolean} x isDot + * + * @see isArray + * @see isString + * @see includes + * + * @example + * isDot('eh.oh') //=> true + * isDot('eh') //=> false + * isDot(['eh', 'oh']) //=> true + */ module.exports = function isDot(x) { return isArray(x) || (isString(x) && x.includes('.')) } diff --git a/src/deps/is/empty.js b/src/deps/is/empty.js new file mode 100644 index 0000000..41fa395 --- /dev/null +++ b/src/deps/is/empty.js @@ -0,0 +1,46 @@ +const keys = require('../util/keysObjOrArray') +const isNullOrUndefined = require('./nullOrUndefined') +const isObj = require('./obj') +const isArray = require('./array') + +/* prettier-ignore */ +/** + * Returns `true` if the given value is its type's empty value; + * `false` otherwise. + * + * @func + * @memberOf is + * @since v0.1.0 + * @category Logic + * @sig a -> Boolean + * + * @param {*} x value to check if empty + * @return {boolean} + * + * @see empty + * @see https://github.com/ramda/ramda/issues/1228 + * + * @example + * + * isEmpty([1, 2, 3]); //=> false + * isEmpty([]); //=> true + * isEmpty(''); //=> true + * isEmpty(null); //=> false + * isEmpty({}); //=> true + * isEmpty({length: 0}); //=> false + * + */ +module.exports = function isEmpty(x) { + if (x === '') return true + else if (isNullOrUndefined(x)) return false + else if (isObj(x) || isArray(x)) return keys(x).length === 0 + else return false + + // else return ( + // // null|undefined = empty + // // isNullOrUndefined(x) || + // // '' = empty + // // [] | {} = empty + // keys(x).length === 0 + // ) +} diff --git a/src/deps/is/enumerable.js b/src/deps/is/enumerable.js index bf3d111..d1a7464 100644 --- a/src/deps/is/enumerable.js +++ b/src/deps/is/enumerable.js @@ -1,2 +1,40 @@ -module.exports = (obj, prop) => - Object.prototype.propertyIsEnumerable.call(obj, prop) +const propertyIsEnumerable = require('../native/propertyIsEnumerable') +const curry = require('../fp/curry') + +/** + * @desc object at property is enumerable + * @memberOf is + * @since 3.0.0 + * + * @param {Object | *} obj + * @param {string | *} prop + * @return {boolean} obj[prop] is enumerable + * + * @func + * @name isEnumerable + * @type {Function} + * + * {@link https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Object/propertyIsEnumerable mozilla-propertyisenumerable} + * @see {@link mozilla-propertyisenumerable} + * + * @TODO use fp/call + * + * @example + * + * const obj = {eh: true} + * isEnumerable(obj, 'eh') + * //=> true + * + * const objPropEnumerable = isEnumerable(obj) + * objPropEnumerable('eh') + * //=> true + * + * Object.defineProperty(obj, 'length', { + * enumerable: false, + * value: () => Object.keys(obj).length, + * }) + * isEnumerable(obj, 'length') + * //=> false + * + */ +module.exports = curry(2, (obj, prop) => propertyIsEnumerable.call(obj, prop)) diff --git a/src/deps/is/eqeq.js b/src/deps/is/eqeq.js deleted file mode 100644 index 49df00b..0000000 --- a/src/deps/is/eqeq.js +++ /dev/null @@ -1,4 +0,0 @@ -// @TODO use this in the bitwise arithmetic validation builder -// @TODO check v8 on this -// eslint-disable-next-line -module.exports = (x, y) => x == y diff --git a/src/deps/is/function.js b/src/deps/is/function.js index 290d007..9e43883 100644 --- a/src/deps/is/function.js +++ b/src/deps/is/function.js @@ -1,12 +1,12 @@ /** * Checks if `value` is classified as a `Function` object. * @category Lang + * @memberOf is + * @since 3.0.0 * * @param {*} x The value to check. * @return {boolean} x isFunction * - * @since 3.0.0 - * @memberOf is * @func isFunction * * @NOTE || x instanceof Function @@ -18,6 +18,9 @@ * https://github.com/krambuhl/custom-event-polyfill/issues/2 * browser usage is < 0.3%, very edge case * + * {@link http://underscorejs.org/docs/underscore.html#section-141 underscore-is-function} + * @see {@link underscore-is-function} + * * @example * * isFunction(function() {}) @@ -33,6 +36,7 @@ * //=> false * isFunction(/abc/) * // => false + * */ module.exports = function isFunction(x) { return typeof x === 'function' diff --git a/src/deps/is/generator.js b/src/deps/is/generator.js index ada01b1..05b8343 100644 --- a/src/deps/is/generator.js +++ b/src/deps/is/generator.js @@ -7,11 +7,13 @@ const toS = require('./toS') * @return {boolean} x isGenerator * * @alternate fn.constructor.name === 'GeneratorFunction' - * @see https://github.com/jonschlinkert/kind-of/blob/master/index.js#L66 + * + * {@link https://github.com/jonschlinkert/kind-of/blob/master/index.js#L66} + * @see {@link kind-of} * * @example * - * isGenerator(*function() {}) + * isGenerator(*function() {}) * //=> true * isGenerator(function() {}) * //=> false diff --git a/src/deps/is/hasIn.js b/src/deps/is/hasIn.js index ec50237..ec52760 100644 --- a/src/deps/is/hasIn.js +++ b/src/deps/is/hasIn.js @@ -2,12 +2,23 @@ const isNull = require('./null') const isIn = require('./in') /** + * @desc isIn, but first checks it is not null + * @since 5.0.0 + * @memberOf is + * * @param {Object} obj object to check * @param {any} prop property to check in object * @return {boolean} * * @extends isNull * @extends isIn + * + * @example + * + * hasIn({}, 'eh') //=> false + * hasIn(null, 'eh') //=> false + * hasIn({eh: true}, 'eh') //=> true + * */ module.exports = function hasIn(obj, prop) { return !isNull(obj) && isIn(obj, prop) diff --git a/src/deps/is/in.js b/src/deps/is/in.js index 4e8accb..ff7b612 100644 --- a/src/deps/is/in.js +++ b/src/deps/is/in.js @@ -1,12 +1,20 @@ /** + * @desc prop is in Object(obj) + * @since 5.0.0 + * @memberOf is + * * @func * @type {Function} - * @typedef Function() {} - */ - -/** + * @name isIn + * * @param {Object} obj object to check property of * @param {Primitive} prop property in obj * @return {boolean} property + * + * @example + * + * isIn({eh: true}, 'eh') //=> true + * isIn({eh: true}, 'oh') //=> false + * */ module.exports = (obj, prop) => prop in Object(obj) diff --git a/src/deps/is/instanceOf.js b/src/deps/is/instanceOf.js new file mode 100644 index 0000000..0812400 --- /dev/null +++ b/src/deps/is/instanceOf.js @@ -0,0 +1,31 @@ +const curry = require('../fp/curry') + +/** + * @see https://github.com/lodash/lodash/issues/620 + * @see https://github.com/ramda/ramda/commit/9d4cb895595aca3d83ce0a4b10416ae7302bd8ac + * + * @since 5.0.0-beta.4 + * @param {Object} instanceToCheckAgainst check the second arg against this + * @param {Object} isThisInstanceOfThat check this against first arg + * @return {boolean} arg2 instanceof arg1 + * + * @example + * + * const isObjInstance = instanceOf(Object) + * isObjInstance({}) + * //=> true + * + * const isArrInstance = instanceOf(Array) + * isArrInstance({}) + * //=> false + * + * isArrInstance(new Array) + * //=> true + * + */ +function instanceOf(instanceToCheckAgainst, isThisInstanceOfThat) { + return isThisInstanceOfThat instanceof instanceToCheckAgainst + // || arg1.constructor === arg2 +} + +module.exports = curry(2, instanceOf) diff --git a/src/deps/is/iteratable.js b/src/deps/is/iteratable.js new file mode 100644 index 0000000..b7f708e --- /dev/null +++ b/src/deps/is/iteratable.js @@ -0,0 +1,79 @@ +const isObjNotNull = require('./objNotNull') +const isArray = require('./array') +const isRegExp = require('./regexp') +const isError = require('./error') +const isDate = require('./date') +const isSymbol = require('./symbol') +const isAsyncish = require('./asyncish') +const isPrimitive = require('./primitive') + +/** + * @desc is able to be iterated on + * + * @param {*} x node is iteratable + * @return {boolean} x isIteratable + * + * @extends isObj + * @extends isArray + * @extends isPrimitive + * @extends isRegExp + * @extends isDate + * @extends isSymbol + * @extends isAsync + * @extends isError + * + * @example + * + * isIteratable([]) //=> true + * isIteratable({}) //=> true + * isIteratable(new Date()) //=> false + * isIteratable(Symbol('eh')) //=> false + * isIteratable(new Promise(r => r())) //=> false + * isIteratable(new Error('eh')) //=> false + * + */ +module.exports = function isIteratable(x) { + // ez ones + if (isObjNotNull(x) || isArray(x)) return true + + const notIteratable = + isPrimitive(x) || + isRegExp(x) || + isDate(x) || + isSymbol(x) || + isAsyncish(x) || + // isNative(x) || + isError(x) + + // not-not is iteratable + return !notIteratable + + // if (notIteratable) return false + // else return true + // if (isNullOrUndefined(node)) { + // } + // else if (isString(node)) { + // } + // else if (isNumber(node)) { + // } + // else if (isBoolean(node)) { + // } + // else if (isRegExp(node)) { + // } + // else if (isDate(node)) { + // } + // else if (isSymbol(node) || isAsyncish(node)) { + // } + // else if (isNative(node)) { + // } + // else { + // return true + // } + // return false +} + +// function isSpecial(x) { +// // isPromise(x) || +// return isSymbol(x) || isError(x) || +// // || isGenerator(x) +// } diff --git a/src/deps/is/match.js b/src/deps/is/match.js new file mode 100644 index 0000000..0002ab3 --- /dev/null +++ b/src/deps/is/match.js @@ -0,0 +1,10 @@ +const curry = require('../fp/curry') +const matcher = require('../matcher/matcher') +const isEmpty = require('../is/empty') + +// @TODO document +// @TODO ensure it's best here & not in matcher/ +// +// pipe(matcher, isEmpty, not) +const isMatch = (inputs, patterns) => !isEmpty(matcher(inputs, patterns)) +module.exports = curry(2, isMatch) diff --git a/src/deps/is/matcher.js b/src/deps/is/matcher.js index 4b4b508..0939754 100644 --- a/src/deps/is/matcher.js +++ b/src/deps/is/matcher.js @@ -1,3 +1,4 @@ +const or = require('../conditional/or') const isFunction = require('./function') const isRegExp = require('./regexp') @@ -9,6 +10,10 @@ const isRegExp = require('./regexp') * @param {*} x value to check * @return {boolean} isFunction || isRegExp * + * @see is/regexp + * @see is/function + * @see conditionals/or + * * @example * * isMatcher(/(.*)/) @@ -23,5 +28,5 @@ const isRegExp = require('./regexp') * //=> false * */ -module.exports = x => isFunction(x) || isRegExp(x) +module.exports = or(isFunction, isRegExp) // x => isFunction(x) || isRegExp(x) // x instanceof RegExp diff --git a/src/deps/is/native.js b/src/deps/is/native.js index 978cb59..d99d638 100644 --- a/src/deps/is/native.js +++ b/src/deps/is/native.js @@ -1,3 +1,21 @@ +const funcToString = require('../native/functionToString') +const hasOwnProperty = require('../native/hasOwnProperty') + +const reIsNative = RegExp( + '^' + + funcToString + // Take an example native function source for comparison + .call(hasOwnProperty) + // Strip regex characters so we can use it for regex + .replace(/[\\^$.*+?()[\]{}|]/g, '\\$&') + // Remove hasOwnProperty from the template to make it generic + .replace( + /hasOwnProperty|(function).*?(?=\\\()| for .+?(?=\\\])/g, + '$1.*?' + ) + + '$' +) + /** * @desc based on isNative from react-fibers, based on isNative() from Lodash * @since 4.0.6 @@ -7,6 +25,16 @@ * @param {*} x value to check * @return {boolean} * + * {@link https://esdiscuss.org/topic/spec-feedback-on-rev-6#content-2 esdiscuss-functiontostring} + * {@link https://github.com/lodash/lodash/issues/2185 lodash-functiontostring-issue} + * {@link http://tc39.github.io/Function-prototype-toString-revision/ functiontostring-emca} + * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/toString Function.toString} + * + * @see {@link Function.toString} + * @see {@link functiontostring-emca} + * @see {@link lodash-functiontostring-issue} + * @see {@link esdiscuss-functiontostring} + * * @example * * isNative(Array.prototype.push) @@ -17,26 +45,8 @@ * */ module.exports = function isNative(x) { - // - var funcToString = Function.prototype.toString - - var reIsNative = RegExp( - '^' + - funcToString - // Take an example native function source for comparison - .call(Object.prototype.hasOwnProperty) - // Strip regex characters so we can use it for regex - .replace(/[\\^$.*+?()[\]{}|]/g, '\\$&') - // Remove hasOwnProperty from the template to make it generic - .replace( - /hasOwnProperty|(function).*?(?=\\\()| for .+?(?=\\\])/g, - '$1.*?' - ) + - '$' - ) - try { - var source = funcToString.call(x) + const source = funcToString.call(x) return reIsNative.test(source) } catch (err) { diff --git a/src/deps/is/notNested.js b/src/deps/is/notNested.js new file mode 100644 index 0000000..0e640d2 --- /dev/null +++ b/src/deps/is/notNested.js @@ -0,0 +1,29 @@ +const isStringOrNumber = require('../is/stringOrNumber') +const isReal = require('../is/real') +const isBoolean = require('../is/boolean') +const isRegExp = require('../is/regexp') +const isError = require('../is/error') + +/** + * @since 5.0.0 + * @param {*} x value to check + * @return {boolean} x isNotNested + * + * @example + * + * isNotNested('') //=> true + * isNotNested(true) //=> true + * isNotNested(new RegExp()) //=> true + * isNotNested(new Error('eh')) //=> false + * isNotNested(null) //=> false + * + */ +module.exports = function isNotNested(x) { + return ( + isStringOrNumber(x) || + isBoolean(x) || + !isReal(x) || + isError(x) || + isRegExp(x) + ) +} diff --git a/src/deps/is/notRealOrIsEmpty.js b/src/deps/is/notRealOrIsEmpty.js new file mode 100644 index 0000000..d042895 --- /dev/null +++ b/src/deps/is/notRealOrIsEmpty.js @@ -0,0 +1,17 @@ +const and = require('../conditional/and') +const not = require('../conditional/not') +const isReal = require('./real') +const isEmpty = require('./empty') + +/** + * @SIZE: another 10bytes for these fns + * @name isNotRealOrIsEmpty + * + * @see is/isReal + * @see is/isEmpty + * @see conditional/and + * @see conditional/not + * + * @type {Function} + */ +module.exports = and(not(isReal), isEmpty) diff --git a/src/deps/is/number.js b/src/deps/is/number.js index 415d07b..6a5a84d 100644 --- a/src/deps/is/number.js +++ b/src/deps/is/number.js @@ -46,5 +46,6 @@ const isNumberPrimitive = require('./numberPrimitive') * ? false * : (/^0x[0-9a-f]+$/i).test(x) || * (/^[-+]?(?:\d+(?:\.\d*)?|\.\d+)(e[-+]?\d+)?$/).test(x)) + * */ module.exports = x => isNumberPrimitive(x) || toS(x) === '[object Number]' diff --git a/src/deps/is/numberPrimitive.js b/src/deps/is/numberPrimitive.js index 9b22477..84a0b13 100644 --- a/src/deps/is/numberPrimitive.js +++ b/src/deps/is/numberPrimitive.js @@ -30,5 +30,6 @@ * //=> false * isNumberPrimitive(false) * //=> false + * */ module.exports = x => typeof x === 'number' diff --git a/src/deps/is/obj.js b/src/deps/is/obj.js index e37ad56..883feb1 100644 --- a/src/deps/is/obj.js +++ b/src/deps/is/obj.js @@ -1,5 +1,6 @@ const objTypeof = require('./objTypeof') const isFunction = require('./function') +const isNull = require('./null') /** * @func isObj @@ -10,6 +11,7 @@ const isFunction = require('./function') * * @since 3.0.0 * @category Lang + * * @param {*} value The value to check. * @return {boolean} Returns `true` if `value` is an object, else `false`. * @@ -31,5 +33,6 @@ const isFunction = require('./function') * * isObject(null) * // => false + * */ -module.exports = x => x !== null && (objTypeof(x) || isFunction(x)) +module.exports = x => !isNull(x) && (objTypeof(x) || isFunction(x)) diff --git a/src/deps/is/objNotNull.js b/src/deps/is/objNotNull.js index 550b4e4..83a68a7 100644 --- a/src/deps/is/objNotNull.js +++ b/src/deps/is/objNotNull.js @@ -3,16 +3,22 @@ const isNullOrUndef = require('./nullOrUndefined') /** * @param {*} x value - * @return {boolean} isObjStrict + * @return {boolean} isObjNotNull * * @since 3.0.0 * @memberOf is - * @func isObjStrict + * @func isObjNotNull + * @alias isObjectLike + * + * {@link https://github.com/lodash/lodash/blob/master/isObjectLike.js lodash-is-object-like} + * {@link https://github.com/sindresorhus/is-obj/blob/master/index.js is-obj} * @see is/obj * @see is/objWithKeys * @see is/objTypeof * @see is/null - * @see https://github.com/sindresorhus/is-obj/blob/master/index.js + * @see {@link is-obj} + * @see {@link lodash-is-object-like} + * * @TODO !Array.isArray * * @extends isObjTypeof @@ -20,22 +26,22 @@ const isNullOrUndef = require('./nullOrUndefined') * * @example * - * isObjStrict(new Object()) + * isObjNotNull(new Object()) * //=> true - * isObjStrict({}) + * isObjNotNull({}) * //=> true - * isObjStrict(Object.create(null)) + * isObjNotNull(Object.create(null)) * //=> true - * isObjStrict(null) + * isObjNotNull(null) * //=> false * - * isObjStrict(new Set()) + * isObjNotNull(new Set()) * //=> false - * isObjStrict(function() {}) + * isObjNotNull(function() {}) * //=> false - * isObjStrict('') + * isObjNotNull('') * //=> false - * isObjStrict(1) + * isObjNotNull(1) * //=> false * */ diff --git a/src/deps/is/primitive.js b/src/deps/is/primitive.js new file mode 100644 index 0000000..1ada048 --- /dev/null +++ b/src/deps/is/primitive.js @@ -0,0 +1,43 @@ +const isBooleanPrimitive = require('./booleanPrimitive') +const isStringPrimitive = require('./stringPrimitive') +const isNumberPrimitive = require('./numberPrimitive') +const isNullOrUndefined = require('./nullOrUndefined') + +/** + * Checks if `value` is classified as a **primitive** + * `(number|string|boolean|null|undefined)` + * + * @version 5.0.0 added booleanPrimitive, is in own file + * @since 4.0.0 was in another file + * @category Lang + * @memberOf is + * @param {*} x The value to check. + * @returns {boolean} x is number|string|boolean|null|undefined + * + * @see http://www.adequatelygood.com/Object-to-Primitive-Conversions-in-JavaScript.html + * @see https://developer.mozilla.org/en-US/docs/Glossary/Primitive + * @see http://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html + * + * @example + * + * isPrimitive('abc') // => true + * isPrimitive(1) // => true + * isPrimitive('') // => true + * isPrimitive(null) // => true + * isPrimitive(undefined) // => true + * isPrimitive(void 0) // => true + * + * isPrimitive(new String('abc')) // => false + * isPrimitive([]) // => false + * isPrimitive(() => {}) // => false + * isPrimitive({}) // => false + * + */ +module.exports = function isPrimitive(node) { + return ( + isNullOrUndefined(node) || + isStringPrimitive(node) || + isNumberPrimitive(node) || + isBooleanPrimitive(node) + ) +} diff --git a/src/deps/is/prototypeOf.js b/src/deps/is/prototypeOf.js index 313086f..9997490 100644 --- a/src/deps/is/prototypeOf.js +++ b/src/deps/is/prototypeOf.js @@ -1,2 +1,33 @@ -module.exports = (obj, comparator) => - Object.prototype.isPrototypeOf.call(obj, comparator) +const isNill = require('./nullOrUndefined') + +const isPrototypeOf = Object.prototype.isPrototypeOf + +/** + * check if arg 1 is prototype of arg 2 + * + * @TODO curry2 + * @memberOf is + * @name isPrototypeOf + * @since 3.0.0 + * + * @param {Object | *} haystack check needle against + * @param {Object | *} needle is prototype of haystack + * @return {boolean} needle isPrototypeOf haystack + * + * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/isPrototypeOf mozilla-obj-isprototypeof} + * @see {@link mozilla-obj-isprototypeof} + * + * @example + * + * class Eh extends Function {} + * class Canada extends Eh {} + * isPrototypeOf(Eh, Function) //=> true + * isPrototypeOf(Canada, Function) //=> true + * isPrototypeOf(Eh, Date) //=> false + * + * isPrototypeOf({}, Object) //=> true + * isPrototypeOf({}, Array) //=> false + * + */ +module.exports = (haystack, needle) => + !isNill(haystack) && isPrototypeOf.call(haystack, needle) diff --git a/src/deps/is/string.js b/src/deps/is/string.js index 32621af..17a914a 100644 --- a/src/deps/is/string.js +++ b/src/deps/is/string.js @@ -15,6 +15,7 @@ const isStringPrimitive = require('./stringPrimitive') * @return {boolean} Returns `true` if `value` is a string, else `false`. * * @see https://github.com/lodash/lodash/blob/master/isString.js + * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String * @see isStringPrimitive * * @example diff --git a/src/deps/is/stringOrNumber.js b/src/deps/is/stringOrNumber.js index 00da788..7e8a611 100644 --- a/src/deps/is/stringOrNumber.js +++ b/src/deps/is/stringOrNumber.js @@ -1,3 +1,4 @@ +const or = require('../conditional/or') const isString = require('./string') const isNumber = require('./number') @@ -21,4 +22,4 @@ const isNumber = require('./number') * isString(1) * // => false */ -module.exports = x => isString(x) || isNumber(x) +module.exports = or(isString, isNumber) diff --git a/src/deps/is/toS.js b/src/deps/is/toS.js index 22202f3..1bbfd3a 100644 --- a/src/deps/is/toS.js +++ b/src/deps/is/toS.js @@ -1,8 +1,12 @@ +const invoke = require('../fp/invoke') +const objectToString = require('../native/objectToString') + /** * The base implementation of `getTag` without fallbacks for buggy environments. * * @memberOf is * @since 3.0.0 + * @alias getTag * * @param {*} obj The value to `Object.prototype.toString.call(obj)`. * @return {string} Returns the `toStringTag`. @@ -10,16 +14,22 @@ * @see https://github.com/lodash/lodash/blob/master/.internal/baseGetTag.js * @see https://github.com/jonschlinkert/kind-of * @see https://github.com/substack/js-traverse/blob/master/index.js#L285 + * @see http://luxiyalu.com/object-prototype-tostring-call/ * * @TODO obj[Symbol.toStringTag] + * @TODO run deopt check on this invoking see how many invocations... are needed to inline * * @example * * toS({}) - * //=> '[Object object]' + * //=> '[object Object]' * * toS(function() {}) - * //=> '[Object function]' + * //=> '[Object Function]' + * + * getTag([]) + * //=> '[object Array]' * */ -module.exports = obj => Object.prototype.toString.call(obj) +// module.exports = obj => objectToString.call(obj) +module.exports = invoke(objectToString, 'call') diff --git a/src/deps/is/undefined.js b/src/deps/is/undefined.js index f561f63..f8de163 100644 --- a/src/deps/is/undefined.js +++ b/src/deps/is/undefined.js @@ -12,8 +12,6 @@ * @see is/nullOrUndefined * @see https://github.com/infernojs/inferno/blob/master/packages/inferno-shared/src/index.ts#L57 * - * @NOTE || typeof x === 'undefined' - * * @example * * isUndefined(undefined) diff --git a/src/deps/is/undefinedLike.js b/src/deps/is/undefinedLike.js new file mode 100644 index 0000000..866e956 --- /dev/null +++ b/src/deps/is/undefinedLike.js @@ -0,0 +1,26 @@ +const isUndefined = require('./undefined') + +/** + * @desc Checks if `value` is `undefined` OR `"undefined"` + * @since 5.0.0-beta.4 + * @memberOf is + * @category Lang + * + * @param {*} x value + * @return {boolean} x isUndefinedLike + * + * @extends isUndefined + * @func isUndefinedLike + * + * @see is/nullOrUndefined + * + * @example + * + * isUndefined(void 0) //=> true + * isUndefined(undefined) //=> true + * isUndefined('undefined') //=> true + * isUndefined(NaN) //=> false + * isUndefined({}) //=> false + * + */ +module.exports = x => isUndefined(x) || x === 'undefined' diff --git a/src/deps/is/weakMap.js b/src/deps/is/weakMap.js new file mode 100644 index 0000000..db4f72e --- /dev/null +++ b/src/deps/is/weakMap.js @@ -0,0 +1,25 @@ +const isObjNotNull = require('./objNotNull') +const toS = require('./toS') + +/** + * Checks if `value` is classified as a `WeakMap` object. + * + * @since 5.0.0-beta.4 + * @category Lang + * @param {*} x The value to check. + * @return {boolean} Returns `true` if `value` is a weak map, else `false`. + * + * @example + * + * isWeakMap(new WeakMap) + * // => true + * + * isWeakMap(new Map) + * // => false + * + */ +function isWeakMap(x) { + return isObjNotNull(x) && toS(x) === '[object WeakMap]' +} + +module.exports = isWeakMap diff --git a/src/deps/is/weakSet.js b/src/deps/is/weakSet.js new file mode 100644 index 0000000..7ee1762 --- /dev/null +++ b/src/deps/is/weakSet.js @@ -0,0 +1,25 @@ +const isObjNotNull = require('./objNotNull') +const toS = require('./toS') + +/** + * Checks if `value` is classified as a `isWeakSet` object. + * + * @since 5.0.0-beta.4 + * @category Lang + * @param {*} x The value to check. + * @return {boolean} Returns `true` if `value` is a weak map, else `false`. + * + * @example + * + * isWeakSet(new WeakSet) + * // => true + * + * isWeakSet(new Set) + * // => false + * + */ +function isWeakSet(x) { + return isObjNotNull(x) && toS(x) === '[object WeakSet]' +} + +module.exports = isWeakSet diff --git a/src/deps/matcher/escape-string-regex.js b/src/deps/matcher/escape-string-regex.js index 5e8f9fc..e705c11 100644 --- a/src/deps/matcher/escape-string-regex.js +++ b/src/deps/matcher/escape-string-regex.js @@ -1,3 +1,5 @@ +const replace = require('../fp/replace') + /** * @func escapeStringRegExp * @module escape-string-regexp @@ -9,6 +11,7 @@ * * {@link https://github.com/sindresorhus/escape-string-regexp escape-string-regexp} * @see {@link escape-string-regexp *} 🍴 + * @see fp/replace * * @NOTE also as const escapeStringRegexp = require('escape-string-regexp'); * @@ -19,4 +22,4 @@ * new RegExp(escaped); * */ -module.exports = str => str.replace(/[|\\{}()[\]^$+*?.]/g, '\\$&') +module.exports = replace(/[|\\{}()[\]^$+*?.]/g, '\\$&') diff --git a/src/deps/matcher/matcher.js b/src/deps/matcher/matcher.js index ca27ce9..1a4eebd 100644 --- a/src/deps/matcher/matcher.js +++ b/src/deps/matcher/matcher.js @@ -10,7 +10,8 @@ const ObjectAssign = require('../util/assign') const isMatcher = require('../is/matcher') const cache = require('../cache') const toarr = require('../to-arr') -const toRegExp = require('./to-regexp') +const newRegExp = require('../construct/regexp') +const toEscapedRegExp = require('./to-regexp') const m = {} @@ -74,12 +75,12 @@ m.make = (pattern, shouldNegate, alphaOmega) => { // } let negated = matchable[0] === '!' if (negated) matchable = matchable.slice(1) - matchable = toRegExp(matchable) + matchable = toEscapedRegExp(matchable) if (negated && shouldNegate) matchable = `(?!${matchable})` if (alphaOmega) matchable = `^${matchable}$` - matchable = new RegExp(`${matchable}`, 'i') + matchable = newRegExp(`${matchable}`, 'i') matchable.negated = negated cache.set(pattern, matchable) diff --git a/src/deps/matcher/to-regexp.js b/src/deps/matcher/to-regexp.js index 986c45c..a7d6b83 100644 --- a/src/deps/matcher/to-regexp.js +++ b/src/deps/matcher/to-regexp.js @@ -1,3 +1,5 @@ +const replace = require('../fp/replace') +const pipe = require('../fp/pipeTwo') const escapeStringRegExp = require('./escape-string-regex') /** @@ -18,4 +20,4 @@ const escapeStringRegExp = require('./escape-string-regex') * => 'eh' * */ -module.exports = str => escapeStringRegExp(str).replace(/\\\*/g, '.*') +module.exports = pipe(escapeStringRegExp, replace(/\\\*/g, '.*')) diff --git a/src/deps/matcher/to-test.js b/src/deps/matcher/to-test.js index adc951a..af03577 100644 --- a/src/deps/matcher/to-test.js +++ b/src/deps/matcher/to-test.js @@ -1,17 +1,23 @@ -const isString = require('../is/string') +const stringPrimitive = require('../is/stringPrimitive') const isFunction = require('../is/function') +const newRegExp = require('../construct/regexp') +const toBoolean = require('../to/boolean') +const pipe = require('../fp/pipe') const esc = require('./escape-string-regex') +// @TODO use in matcher +const constructEscRegExp = pipe(esc, newRegExp) + /** * @desc like matcher, but .isMatch * @since 3.0.0 * - * @param {Matchable} matchable any matchable - * @param {any} [arg1=undefined] arg to match with - * @param {any} [arg2=undefined] optional second arg to pass into tester + * @param {Matchable} matchable any matchable + * @param {any} [arg1=undefined] arg to match with + * @param {any} [arg2=undefined] optional second arg to pass into tester * @return {boolean} is a match, passes the test * - * @NOTE as else-if for easier ternary uglification + * @NOTE as else-if for easier ternary uglification * * @example * @@ -38,8 +44,10 @@ const esc = require('./escape-string-regex') * //=> false * */ -module.exports = (matchable, arg1, arg2) => { - if (isString(matchable)) return !!new RegExp(esc(matchable)).test(arg1) - else if (isFunction(matchable) && !matchable.test) return !!matchable(arg1) - else return !!matchable.test(arg1, arg2) +function toTest(matchable, arg1, arg2) { + if (stringPrimitive(matchable)) return constructEscRegExp(matchable).test(arg1) + else if (isFunction(matchable) && !matchable.test) return matchable(arg1) + else return matchable.test(arg1, arg2) } + +module.exports = pipe(toTest, toBoolean) diff --git a/src/deps/ignored.js b/src/deps/meta/ignored.js similarity index 100% rename from src/deps/ignored.js rename to src/deps/meta/ignored.js diff --git a/src/deps/meta/meta.js b/src/deps/meta/meta.js index 2c381c7..6dd5790 100644 --- a/src/deps/meta/meta.js +++ b/src/deps/meta/meta.js @@ -1,11 +1,12 @@ // without it, the arguments & caller are uglier when drbugging -'use strict' + const isSet = require('../is/set') const ArrayFrom = require('../util/from') const isUndefined = require('../is/undefined') -const concat = require('../concat') +const concat = require('../array/concat') const toarr = require('../to-arr') +const always = require('../fp/always') const TRANSFORMERS_KEY = require('./transformers') const OBSERVERS_KEY = require('./observers') const SHORTHANDS_KEY = require('./shorthands') @@ -13,6 +14,7 @@ const DECORATED_KEY = require('./decorated') // will expand this later const isInKeyMapAsSet = x => x === OBSERVERS_KEY +const emptyArray = [] // always([]) // @NOTE: using `[]` deopts o.o // eslint-disable-next-line @@ -70,7 +72,7 @@ function getMeta(_this) { * @param {Primitive | undefined} [prop=undefined] * @return {any} */ - const get = (key, prop) => (has(key, prop) ? store[key].get(prop) : []) + const get = (key, prop) => (has(key, prop) ? store[key].get(prop) : emptyArray) /** * @since 4.0.0 @@ -117,8 +119,8 @@ function getMeta(_this) { // when we want to just access the property, return an array // @example `.meta('transformers')` if (isUndefined(prop)) { - if (isUndefined(store[key])) return [] - else return store[key].size === 0 ? [] : ArrayFrom(store[key].values()) + if (isUndefined(store[key])) return emptyArray + else return store[key].size === 0 ? emptyArray : ArrayFrom(store[key].values()) } // we have `key, prop` // @@ -129,7 +131,7 @@ function getMeta(_this) { } // 2: prop is a key, we want to return the [..] for that specific property // @example `.meta('transformers', 'eh')` - else if (isUndefined(store[key])) return [] + else if (isUndefined(store[key])) return emptyArray else return toarr(get(key, prop)) } // we have `key, prop, value` diff --git a/src/deps/native/arraySlice.js b/src/deps/native/arraySlice.js new file mode 100644 index 0000000..c150e80 --- /dev/null +++ b/src/deps/native/arraySlice.js @@ -0,0 +1 @@ +module.exports = Array.prototype.slice diff --git a/src/deps/native/functionToString.js b/src/deps/native/functionToString.js new file mode 100644 index 0000000..b1956b8 --- /dev/null +++ b/src/deps/native/functionToString.js @@ -0,0 +1 @@ +module.exports = Function.prototype.toString diff --git a/src/deps/native/hasOwnProperty.js b/src/deps/native/hasOwnProperty.js new file mode 100644 index 0000000..5bfd8c0 --- /dev/null +++ b/src/deps/native/hasOwnProperty.js @@ -0,0 +1 @@ +module.exports = Object.prototype.hasOwnProperty diff --git a/src/deps/native/objectToString.js b/src/deps/native/objectToString.js new file mode 100644 index 0000000..e9643b9 --- /dev/null +++ b/src/deps/native/objectToString.js @@ -0,0 +1 @@ +module.exports = Object.prototype.toString diff --git a/src/deps/native/propertyIsEnumerable.js b/src/deps/native/propertyIsEnumerable.js new file mode 100644 index 0000000..744a19b --- /dev/null +++ b/src/deps/native/propertyIsEnumerable.js @@ -0,0 +1 @@ +module.exports = Object.prototype.propertyIsEnumerable diff --git a/src/deps/reduce/clean.js b/src/deps/reduce/clean.js index fc6d993..0841f1f 100644 --- a/src/deps/reduce/clean.js +++ b/src/deps/reduce/clean.js @@ -1,7 +1,12 @@ -const isNotEmptyArray = require('../is/notEmptyArray') const isReal = require('../is/real') -const isObjWithKeys = require('../is/objWithKeys') +const isEmpty = require('../is/empty') const ObjectKeys = require('../util/keys') +const mapWhere = require('../fp/mapWhere') +const reduceToObj = require('./toObj') + +// const [isNotReal, isNotEmpty] = [isReal, isEmpty].map(not) +// const isNotEmptyOrNotReal = or(isNotReal, isNotEmpty) +const mapNotEmpty = mapWhere('_', x => isReal(x) && !isEmpty(x)) /** * @desc goes through the maps, @@ -16,10 +21,13 @@ const ObjectKeys = require('../util/keys') * @param {Object} obj object to clean, usually .entries() * @return {Object} reduced object, without `notReal` values * + * @TODO seems to be overkill with reducing mapping just copy & ignore or delete? + * * @see reduce * @see isObjWithKeys * @see isNotEmptyArray * @see isReal + * @see http://underscorejs.org/#reduce * * @example * @@ -37,13 +45,9 @@ const ObjectKeys = require('../util/keys') * */ module.exports = function clean(obj) { - return ObjectKeys(obj).reduce(function(acc, key) { - const val = obj[key] - - if (isReal(val) && (isNotEmptyArray(val) || isObjWithKeys(val))) { - acc[key] = val - } + const mapped = mapNotEmpty(obj) + const keys = ObjectKeys(mapped) + const iterator = (reduced, key) => (reduced[key] = mapped[key]) - return acc - }, {}) + return reduceToObj(keys, iterator) } diff --git a/src/deps/reduce/entries.js b/src/deps/reduce/entries.js index 71d527e..6ac3251 100644 --- a/src/deps/reduce/entries.js +++ b/src/deps/reduce/entries.js @@ -1,5 +1,6 @@ const isFunction = require('../is/function') -const ignored = require('../ignored') +const isObj = require('../is/obj') +const ignored = require('../meta/ignored') const ObjectKeys = require('../util/keys') const ObjectAssign = require('../util/assign') @@ -12,7 +13,9 @@ const ObjectAssign = require('../util/assign') * @param {Object | any} reduced merged object and reduced * @return {Function} Function(values: Object) * + * @see https://www.airpair.com/javascript/javascript-array-reduce * @see ChainedMap + * @NOTE could curry, but this is super hot function * * @example * @@ -70,9 +73,10 @@ module.exports = reduced => obj => { continue } - const val = obj[key] - if (val && isFunction(val.entries)) { - ObjectAssign(reduced, {[key]: val.entries(true) || {}}) + const value = obj[key] + // @NOTE could use hasInMatching here + if (isObj(value) && isFunction(value.entries)) { + ObjectAssign(reduced, {[key]: value.entries(true) || {}}) } } diff --git a/src/deps/reduce/objects.js b/src/deps/reduce/objects.js deleted file mode 100644 index 90890c7..0000000 --- a/src/deps/reduce/objects.js +++ /dev/null @@ -1,17 +0,0 @@ -// @TODO -// const reduce = require('./entries') -// const indexValueBy = property => x => { -// const obj = {} -// Object.keys(x).map(key => obj[property] = x) -// } -// const indexPropBy = key => {} -// const pluckValues = keys => {} -// const spreadValues = keys = {} // into arr in order? -// const orderBy = keys => {} // order -// -// module.exports = (key, valueProp) => x => { -// const reduced = reduce(x) -// const indexed = indexPropBy(key)(reduced) -// const mapped = indexValueBy(valueProp)(indexed) -// return mapped -// } diff --git a/src/deps/reduce/reduce.js b/src/deps/reduce/reduce.js index 00e3bed..518b4da 100644 --- a/src/deps/reduce/reduce.js +++ b/src/deps/reduce/reduce.js @@ -31,7 +31,7 @@ module.exports = map => { reduced = ArrayFrom(map.entries()).reduce((acc, [key, value]) => { acc[key] = value return acc - }, {}) + }, reduced) } return reduced diff --git a/src/deps/reduce/toObj.js b/src/deps/reduce/toObj.js new file mode 100644 index 0000000..010ce5d --- /dev/null +++ b/src/deps/reduce/toObj.js @@ -0,0 +1,6 @@ +module.exports = function reduceObj(array, iterator) { + return array.reduce(function(reduced, next) { + iterator(reduced, next) + return reduced + }, {}) +} diff --git a/src/deps/camel-case.js b/src/deps/string/camelCase.js similarity index 94% rename from src/deps/camel-case.js rename to src/deps/string/camelCase.js index ca235f5..75bb2fe 100644 --- a/src/deps/camel-case.js +++ b/src/deps/string/camelCase.js @@ -2,6 +2,7 @@ /** * @desc camelCase * @since 0.2.0 + * @symb 🐫 * * @param {string} str string to turn into camelCase * @return {string} camelCased string @@ -13,6 +14,9 @@ * @see https://stackoverflow.com/questions/1533131/what-useful-bitwise-operator-code-tricks-should-a-developer-know-about * @TODO s.charAt(0).toLowerCase() + string.slice(1) * + * @types deps + * @tests deps/camelCase + * * @example * * camelCase('snake_case') diff --git a/src/deps/to/README.md b/src/deps/to/README.md new file mode 100644 index 0000000..cbccca5 --- /dev/null +++ b/src/deps/to/README.md @@ -0,0 +1 @@ +cast values diff --git a/src/deps/to/array.js b/src/deps/to/array.js new file mode 100644 index 0000000..eb9f413 --- /dev/null +++ b/src/deps/to/array.js @@ -0,0 +1,2 @@ +// https://github.com/lodash/lodash/blob/master/toArray.js +module.exports = require('../to-arr') diff --git a/src/deps/to/boolean.js b/src/deps/to/boolean.js new file mode 100644 index 0000000..aea2a8f --- /dev/null +++ b/src/deps/to/boolean.js @@ -0,0 +1,2 @@ +// http://people.mozilla.org/~jorendorff/es6-draft.html#sec-toboolean +module.exports = x => !!x diff --git a/src/deps/to/coerce.js b/src/deps/to/coerce.js new file mode 100644 index 0000000..1cc5bf4 --- /dev/null +++ b/src/deps/to/coerce.js @@ -0,0 +1,11 @@ +// use in toArr & chained-set +const objToPairs = obj => {} + +const coerceTo = type => data => { + // toBoolean + // toString + // toObject + // toArray + // toMap + // toSet +} diff --git a/src/deps/to/index.js b/src/deps/to/index.js new file mode 100644 index 0000000..97623e2 --- /dev/null +++ b/src/deps/to/index.js @@ -0,0 +1 @@ +module.exports = require('./to') diff --git a/src/deps/to/integer.js b/src/deps/to/integer.js new file mode 100644 index 0000000..d433331 --- /dev/null +++ b/src/deps/to/integer.js @@ -0,0 +1,17 @@ +const toNumber = require('./number') + +// http://people.mozilla.org/~jorendorff/es6-draft.html#sec-tointeger +function toInteger(argument) { + const number = toNumber(argument) + if (Number.isNaN(number)) { + return +0 + } + + if (number === 0 || number === -Infinity || number === +Infinity) { + return number + } + + return Math.sign(number) * Math.floor(Math.abs(number)) +} + +module.exports = toInteger diff --git a/src/deps/to/map.js b/src/deps/to/map.js new file mode 100644 index 0000000..5936b15 --- /dev/null +++ b/src/deps/to/map.js @@ -0,0 +1,17 @@ +const construct = require('../fp/construct') + +// @TODO own file +const constructMap = construct(1, Map) + +const objToMap = obj => { + const map = constructMap() + + // can just use obj.hasOwnProperty again? + const objHasProp = hasOwnProperty(obj) + for (let prop in obj) { + if (objHasProp(prop)) map.set(prop, obj[prop]) + } + // Object.keys(obj).forEach(key => map.set(key, obj[key])) + + return map +} diff --git a/src/deps/to/number.js b/src/deps/to/number.js new file mode 100644 index 0000000..bb272c8 --- /dev/null +++ b/src/deps/to/number.js @@ -0,0 +1,5 @@ +// http://people.mozilla.org/~jorendorff/es6-draft.html#sec-tonumber +function ToNumber(argument) { + return +argument +} +module.exports = ToNumber diff --git a/src/deps/to/object.js b/src/deps/to/object.js new file mode 100644 index 0000000..f5cfe4d --- /dev/null +++ b/src/deps/to/object.js @@ -0,0 +1,13 @@ +const isNill = require('../is/nullOrUndefined') + +// http://people.mozilla.org/~jorendorff/es6-draft.html#sec-toobject +module.exports = function toObj(x) { + // @TODO better to return false + // if (x === null || x === undefined) { + // throw new TypeError('Null or undefined passed to ToObject') + // } + if (isNill(x)) return false + + // check for null & undefined + return Object(x) +} diff --git a/src/deps/to/set.js b/src/deps/to/set.js new file mode 100644 index 0000000..eaaa358 --- /dev/null +++ b/src/deps/to/set.js @@ -0,0 +1,10 @@ +const construct = require('../fp/construct') + +// @TODO own file +const constructSet = construct(1, Set) + +const arrayToSet = arr => { + const aSet = constructSet() + for (let key = 0; key < arr.length; key++) aSet(arr[key]) + return aSet +} diff --git a/src/deps/to/setToArray.js b/src/deps/to/setToArray.js new file mode 100644 index 0000000..ac98233 --- /dev/null +++ b/src/deps/to/setToArray.js @@ -0,0 +1,4 @@ +// const allocated = new Array(this.store.size) +// let i = 0 +// this.store.forEach(v => (allocated[i++] = v)) +// return allocated diff --git a/src/deps/to/string.js b/src/deps/to/string.js new file mode 100644 index 0000000..ac6c31f --- /dev/null +++ b/src/deps/to/string.js @@ -0,0 +1,51 @@ +// http://people.mozilla.org/~jorendorff/es6-draft.html#sec-tostring + +// import map from './map.js' +// import isSymbol from './isSymbol.js' +// +// /** Used as references for various `Number` constants. */ +// const INFINITY = 1 / 0 +// +// /** Used to convert symbols to primitives and strings. */ +// const symbolProto = Symbol ? Symbol.prototype : undefined +// const symbolToString = symbolProto ? symbolProto.toString : undefined +// +// /** +// * Converts `value` to a string. An empty string is returned for `null` +// * and `undefined` values. The sign of `-0` is preserved. +// * +// * @since 4.0.0 +// * @category Lang +// * @param {*} value The value to convert. +// * @returns {string} Returns the converted string. +// * @example +// * +// * toString(null) +// * // => '' +// * +// * toString(-0) +// * // => '-0' +// * +// * toString([1, 2, 3]) +// * // => '1,2,3' +// */ +// function toString(value) { +// if (value == null) { +// return '' +// } +// // Exit early for strings to avoid a performance hit in some environments. +// if (typeof value === 'string') { +// return value +// } +// if (Array.isArray(value)) { +// // Recursively convert values (susceptible to call stack limits). +// return `${map(value, (other) => (other == null ? other : toString(other)))}` +// } +// if (isSymbol(value)) { +// return symbolToString ? symbolToString.call(value) : '' +// } +// const result = `${value}` +// return (result == '0' && (1 / value) == -INFINITY) ? '-0' : result +// } +// +// export default toString diff --git a/src/deps/to/to.js b/src/deps/to/to.js new file mode 100644 index 0000000..e3ac53c --- /dev/null +++ b/src/deps/to/to.js @@ -0,0 +1,29 @@ +const array = require('./array') +const boolean = require('./boolean') +const integer = require('./integer') +const map = require('./map') +const number = require('./number') +const obj = require('./object') +const string = require('./string') + +/** + * @member to + * @type {Object} + */ +module.exports = { + array, + boolean, + integer, + number, + map, + obj, + string, + // to + toArray: array, + toBoolean: boolean, + toInteger: integer, + toNumber: number, + toMap: map, + toObj: obj, + toString: string, +} diff --git a/src/deps/traverse.js b/src/deps/traverse.js index d161f0b..b8791f7 100644 --- a/src/deps/traverse.js +++ b/src/deps/traverse.js @@ -10,95 +10,40 @@ // debug conditionals /* eslint max-depth: "OFF" */ -const isObjNotNull = require('./is/objNotNull') -const isRegExp = require('./is/regexp') -const isError = require('./is/error') +const isEmpty = require('./is/empty') const isTrue = require('./is/true') -const isBoolean = require('./is/boolean') -const isNumber = require('./is/number') -const isString = require('./is/string') -const isDate = require('./is/date') +const isIteratable = require('./is/iteratable') const isUndefined = require('./is/undefined') -const isNullOrUndefined = require('./is/nullOrUndefined') const isArray = require('./is/array') const isMap = require('./is/map') const isSet = require('./is/set') -const isSymbol = require('./is/symbol') -const isAsyncish = require('./is/asyncish') -const isFunction = require('./is/function') const isObj = require('./is/obj') +const isPrimitive = require('./is/primitive') +const isNull = require('./is/null') const ObjectKeys = require('./util/keys') -const hasOwnProperty = require('./util/hasOwnProperty') -const toS = require('./is/toS') const reduce = require('./reduce') const toarr = require('./to-arr') -const dot = require('./dot') +const dotSet = require('./dot/set') +const emptyTarget = require('./dopemerge/emptyTarget') +const copy = require('./traversers/copy') +const eq = require('./traversers/_eq') +const addPoolingTo = require('./cache/pooler') // const props = require('./util/props') -// const emptyTarget = require('./dopemerge/emptyTarget') +// const ENV_DEBUG = require('./env/debug') // const ENV_DEBUG = true +// const TRUTH = true const ENV_DEBUG = false -function isPrimitive(node) { - return ( - isNullOrUndefined(node) || - isString(node) || - isNumber(node) || - isBoolean(node) - ) -} -function isIteratable(node) { - // ez ones - if (isObj(node) || isArray(node)) return true - - const notIteratable = - isPrimitive(node) || - isRegExp(node) || - isDate(node) || - isSymbol(node) || - isAsyncish(node) || - // isNative(node) || - isError(node) - - if (notIteratable) return false - else return true - - // if (isNullOrUndefined(node)) { - // } - // else if (isString(node)) { - // } - // else if (isNumber(node)) { - // } - // else if (isBoolean(node)) { - // } - // else if (isRegExp(node)) { - // } - // else if (isDate(node)) { - // } - // else if (isSymbol(node) || isAsyncish(node)) { - // } - // else if (isNative(node)) { - // } - // else { - // return true - // } - // return false -} - -// function isSpecial(x) { -// // isPromise(x) || -// return isSymbol(x) || isError(x) || -// // || isGenerator(x) -// } - /** - * {@link https://github.com/wmira/object-traverse/blob/master/index.js } - * {@link https://www.npmjs.com/browse/keyword/traverse } - * {@link https://www.npmjs.com/package/tree-walk } - * {@link https://www.npmjs.com/package/1tree } - * {@link https://www.npmjs.com/package/pathway } - * {@link https://www.npmjs.com/package/@mojule/tree } - * + * {@link https://github.com/wmira/object-traverse/blob/master/index.js object-traverse} + * {@link https://www.npmjs.com/browse/keyword/traverse traverse-js} + * {@link https://www.npmjs.com/package/tree-walk tree-walk} + * {@link https://www.npmjs.com/package/1tree 1tree} + * {@link https://www.npmjs.com/package/pathway pathway} + * {@link https://www.npmjs.com/package/@mojule/tree tree} + * {@link http://web.archive.org/web/20160930054101/http://substack.net/tree_traversal tree-traversal-article} + * {@link https://medium.com/@alexanderv/tries-javascript-simple-implementation-e2a4e54e4330 js-trie-medium} * -------------------- * * if needed, clone @@ -142,1110 +87,774 @@ function isIteratable(node) { * @emits after */ -const isObjOrArr = x => isObj(x) || isArray(x) - -// need some thin wrapper around values to go up and down path -// -// -// const ValueObject = { -// node: value, -// kind: typeof, -// isRoot: false, -// isLeaf: false, -// isPrimitive: false, -// branches: [], -// isFirst: false, -// isLast: false, -// parent: {}, -// } -// -// class It { -// constructor(x) { -// // this.tree = { -// // parent: {}, -// // } -// -// // this.root = x -// -// // this.previous = x -// this.current = x -// -// this.depth = 0 -// this.all = new Set() -// // this.path -// // this.key -// } -// -// get node() { -// return this.current -// } -// -// addBranch() {} -// -// // for updating -// branchHead() {} -// -// goUp() { -// this.depth-- -// } -// goDown(current) { -// this.parent = this.current -// this.depth++ -// this.current = current -// } -// // not needed but conceptually -// // goNext() {} -// -// find() {} -// path() {} -// } -// const it = x => new It(x) - -// @TODO make this a trie OR a linked-list -const makeIterator = () => { +/** + * @class + * @desc Traverse class, pooled + * @alias IterAteOr + * @member Traverse + * @constructor + * @since 5.0.0 + * + * @see {@link tree-traversal-article} + * @param {Traversable} iteratee value to iterate, clone, copy, check for eq + * @param {Object | undefined} [config] wip config for things such as events or configs + * + * @tests traverse + * @types traverse + * + * @extends pooler + * @see traverse + * @TODO make this a trie OR a linked-list + * + * @example + * + * new Traverse([1]) + * new Traverse([], {}) + * + */ +function Traverse(iteratee, config) { // always cleared when done anyway - // const parents = new Map() - const parents = new Set() - // const parentKeys = [] - const hasParent = (depth, value) => { - if (!isObjOrArr(value)) return false - - // return Array.from(parents.values()).indexOf(value) !== -1 - // const keys = Array.from(parents.keys()) - // console.log('___pk', {keys}) - // for (let k = 0; k < keys.length; k++) { - // const key = keys[k] - // const matches = - // depth.includes(key) || (key.includes && key.includes(depth)) - // console.log({key, matches, depth}) - // // .has(value) - // if (matches) { - // let has = false - // parents.get(key).forEach(haz => { - // if (value === haz) has = true - // }) - // return has - // } - // } - - // for (let i = depth; i >= depth; i--) { - // if (parents.get(i).has(value)) return true - // } - - // return false - return parents.has(value) - } - const addParent = (depth, value) => { - if (!isObjOrArr(value)) return - if (parents.size >= 100) parents.clear() - - // if (!parents.has(depth)) parents.set(depth, new Set()) - // parents.get(depth).add(value) - - parents.add(value) - } - // (isObjOrArr(value) ? parents.add(value) : parents.add(value)) - // const removeLastParent = () => parents.delete(lastParent) - const clearParents = (depth, value) => parents.clear() - - // parents.forEach(parent => (parent.has(value) ? parent.delete(value) : null)) - // parents.delete(value) - const removeParent = (depth, value) => parents.delete(value) - - // const pps = [] - // const ppHas = value => { - // for (let i = 0; i < pps.length; i++) { - // if (pps[i] === value) { - // return true - // } - // } - // } - // const ppAdd = value => pps.push(value) - // const ppPop = () => pps.pop() - - /** - * @param {Traversable} iteratee - * @param {Object | undefined} [config] wip config for things such as events or configs - * @constructor - */ - function ItOrAteOr(iteratee, config) { - this.iteratee = iteratee - this.parent = iteratee - this.root = iteratee - // this.tree = it(iteratee) - - this.path = [] - - // @HACK @FIXME @TODO remove, not needed, compat - // this.path = this.path - - this.key = undefined + if (isUndefined(this.parents)) this.parents = new Set() - this.isAlive = true - this.isCircular = false - this.isLeaf = false - this.isRoot = true + this.node = iteratee + this.parent = iteratee + this.root = iteratee + this.reset() - // iterates +1 so start at 0 - this.depth = -1 - - // to pass in the events (as commented below) without messing up scope? - // if (config.on) this.on = config.on - return this - } + // to pass in the events (as commented below) without messing up scope? + // if (config.on) this.on = config.on + return this +} - ItOrAteOr.prototype.forEach = function iterateForEach(cb) { - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log('\n forEach \n') - } +Traverse.prototype.reset = function() { + this.path = [] + this.key = undefined + this.isAlive = true + this.isCircular = false + this.isLeaf = false + this.isRoot = true - const result = this.iterate(cb) + // iterates +1 so start at 0 + this.depth = -1 +} - // TODO: HERE, WHEN THIS IS ADDED, CAN BREAK SOME TESTS? SCOPED PARENTS MAP? - this.done() +/** + * @desc find parent, + * is there a parent + * above the current depth + * with the same value, + * making it circular? + * + * @memberOf Traverse + * @since 5.0.0 + * @private + * + * @param {number} depth current depth, to find parent >= + * @param {parent} value parent value to find + * @return {boolean} hasParent + * + * @example + * + * var obj = {eh: ['eh']} + * traverse(obj).addParent(0, obj) + * + */ +Traverse.prototype.hasParent = function(depth, value) { + // or array + return isObj(value) ? this.parents.has(value) : false +} - return result - } +/** + * @desc add parent, to prevent circular iterations + * @memberOf Traverse + * @since 5.0.0 + * @private + * + * @param {number} depth current depth, to add parent to >= + * @param {parent} value parent value to add + * @return {void} + * + * @example + * + * var obj = {eh: ['eh']} + * traverse(obj).addParent(0, obj) + * + */ +Traverse.prototype.addParent = function(depth, value) { + // && this.hasParent(value) === false + if (isObj(value)) this.parents.add(value) +} - /** - * @modifies this.isAlive = false - * - * @return {void} - * - * @example - * - * traverse({eh: true, arr: []}).forEach((key, val, t) => { - * if (isArray(val)) this.stop() - * }) - * - */ - ItOrAteOr.prototype.stop = function stop() { - this.isAlive = false - // this.done() - } +/** + * @desc remove all parents, reset the map + * + * @memberOf Traverse + * @since 5.0.0 + * @private + * + * @return {void} + * + * @example + * + * var obj = {eh: ['eh']} + * traverse(obj).forEach((key, value, t) => { + * t.parents + * //=> Set([obj]) + * t.clear() + * t.parents + * //=> Set[] + * }) + * + */ +Traverse.prototype.clear = function() { + // if (!isUndefined(this.parents)) + this.parents.clear() +} - /** - * @TODO skip 1 branch - * @return {void} - */ - ItOrAteOr.prototype.skip = function skip() { - this.skipBranch = true - } +/** + * @memberOf Traverse + * @since 5.0.0 + * @private + * + * @param {number} depth current depth, to find parents >= + * @param {parent} value parent value to remove + * @return {void} + * + * @example + * + * var obj = {eh: ['eh']} + * traverse(obj).removeParent(0, obj) + * + */ +Traverse.prototype.removeParent = function(depth, value) { + this.parents.delete(value) +} - /* prettier-ignore */ - /** - * @TODO move into the wrapper? if perf allows? - * - * @desc checks whether a node is iteratable - * @modifies this.isIteratable - * @modifies this.isLeaf - * @modifies this.isCircular - * - * @protected - * - * @param {*} node value to check - * @return {void} - * - * @example - * - * .checkIteratable({eh: true}) - * //=> this.isLeaf = false - * //=> this.isCircular = false - * //=> this.isIteratable = true - * - * .checkIteratable({} || []) - * //=> this.isLeaf = true - * //=> this.isCircular = false - * //=> this.isIteratable = false - * - * var circular = {} - * circular.circular = circular - * .checkIteratable(circular) - * //=> this.isLeaf = false - * //=> this.isCircular = true - * //=> this.isIteratable = true - * - */ - ItOrAteOr.prototype.checkIteratable = function check(node) { - this.isIteratable = isIteratable(node) - // just put these as an array? - if (isTrue(this.isIteratable)) { - // native = leaf if not root - this.isLeaf = false - - if (hasParent(this.path.join('.'), node)) { - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log('circular___________', {node, path: this.path}) - } - this.isCircular = true - } - // else if (ppHas(node)) { - // if (ENV_DEBUG) { - // console.log('PPHAS!!!!!!!!!!!', {node, path: this.path}) - // } - // this.isCircular = true - // } - else { - addParent(this.path.join('.'), node) - this.isCircular = false - } - } - else { - // --- - this.isLeaf = true - this.isCircular = false - } +/** + * @desc this is the main usage of Traverse + * @memberOf Traverse + * @since 3.0.0 + * @version 5.0.0 + * + * @param {Function} cb callback for each iteration + * @return {*} mapped result or original value, depends how it is used + * + * @example + * + * traverse([1, 2, 3]).forEach((key, value) => console.log({[key]: value})) + * //=> {'0': 1} + * //=> {'1': 2} + * //=> {'2': 3} + * + */ +Traverse.prototype.forEach = function iterateForEach(cb) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('\n forEach \n') } - /* prettier-ignore */ - /** - * Remove the current element from the output. - * If the node is in an Array it will be spliced off. - * Otherwise it will be deleted from its parent. - * - * @since 2.0.0 - * @param {undefined | Object} [arg] optional obj to use, defaults to this.iteratee - * @return {void} - * - * @example - * - * traverse([0]).forEach((key, val, it) => it.remove()) - * //=> [] - * - */ - ItOrAteOr.prototype.remove = function removes(arg) { - let obj = arg || this.iteratee + const result = this.iterate(cb) - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log({parent: this.parent}) - } + // TODO: HERE, WHEN THIS IS ADDED, CAN BREAK SOME TESTS? SCOPED PARENTS MAP? + Traverse.release(this) - removeParent(obj) + return result +} - if (isUndefined(obj)) { - // throw new Error('why?') - } - else if (isArray(obj)) { - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log('traverse:remove:array', obj, this.key) - } +/** + * @desc stop the iteration + * @modifies this.isAlive = false + * @memberOf Traverse + * + * @return {void} + * + * @example + * + * traverse({eh: true, arr: []}).forEach((key, val, t) => { + * if (isArray(val)) this.stop() + * }) + * + */ +Traverse.prototype.stop = function stop() { + this.isAlive = false + // this.release() +} - obj.splice(this.key, 1) - } - else if (isObjNotNull(obj)) { - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log('traverse:remove:obj', this.key) - } +/** + * @TODO skip 1 branch + * @version 5.0.0 + * @since 3.0.0 + * @memberOf Traverse + * + * @return {void} + * + * @example + * + * traverse([1, 2, 3, [4]]).forEach((key, val, t) => { + * if (isArray(val)) t.skip() + * }) + * + */ +Traverse.prototype.skip = function skip() { + this.skipBranch = true +} - delete obj[this.key] - } +/* prettier-ignore */ +/** + * @TODO move into the wrapper? if perf allows? + * + * @desc checks whether a node is iteratable + * @modifies this.isIteratable + * @modifies this.isLeaf + * @modifies this.isCircular + * + * @memberOf Traverse + * @protected + * + * @param {*} node value to check + * @return {void} + * + * @example + * + * .checkIteratable({eh: true}) + * //=> this.isLeaf = false + * //=> this.isCircular = false + * //=> this.isIteratable = true + * + * .checkIteratable({} || []) + * //=> this.isLeaf = true + * //=> this.isCircular = false + * //=> this.isIteratable = false + * + * var circular = {} + * circular.circular = circular + * .checkIteratable(circular) + * //=> this.isLeaf = false + * //=> this.isCircular = true + * //=> this.isIteratable = true + * + */ +Traverse.prototype.checkIteratable = function check(node) { + this.isIteratable = isIteratable(node) + // just put these as an array? + if (isTrue(this.isIteratable)) { + // native = leaf if not root + this.isLeaf = false + const path = this.path.join('.') - if (isObjNotNull(this.parent)) { - delete this.parent[this.key] + if (this.hasParent(path, node)) { /* istanbul ignore next: dev */ if (ENV_DEBUG) { - console.log('traverse:remove:parent', this.key) + console.log('circular___________', {node, path: this.path}) } + this.isCircular = true } - if (isObjNotNull(this.iteratee)) { - delete this.iteratee[this.key] - - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log('traverse:remove:iteratee', this.key) - } + else { + this.addParent(path, node) + this.isCircular = false } /* istanbul ignore next: dev */ if (ENV_DEBUG) { - console.log('traverse:remove:', this.key, {obj, iteratee: this.iteratee}) + // console.log('IS_CIRCULAR_JSON', isCircular(node), this.isCircular, node) } } - - /** - * @desc update the value for the current key - * @since 2.0.0 - * - * @param {*} value this.iteratee[this.key] = value - * @return {void} - * - * @example - * - * traverse({eh: true}) - * .forEach((key, val, traverser) => { - * if (this.isRoot) return - * traverser.update(false) - * }) - * //=> {eh: false} - * - */ - ItOrAteOr.prototype.update = function update(value) { - // if (!isUndefined(this.iteratee)) { - // this.iteratee[this.key] = value - // } - // // dot.set(this.iteratee, this.key, value) - dot.set(this.root, this.path, value) - // dot.set(this.iteratee, this.path, value) - - // dot.set(this.iteratee, this.key, value) - // console.log({traverser: this}) - - // @NOTE think about this more, but updating can change structure - // if (isTrue(clear)) clearParents() + else { + // --- + this.isLeaf = true + this.isCircular = false } +} - ItOrAteOr.prototype.clear = clearParents - - ItOrAteOr.prototype.done = function done() { - // throw new Error('how') - // this.iteratee = undefined - // this.key = undefined - // this.isCircular = undefined - // this.isLeaf = undefined - // this.isAlive = undefined - // this.path = undefined +/* prettier-ignore */ +/** + * Remove the current element from the output. + * If the node is in an Array it will be spliced off. + * Otherwise it will be deleted from its parent. + * + * @memberOf Traverse + * @version 5.0.0 + * @since 2.0.0 + * + * @param {undefined | Object} [arg] optional obj to use, defaults to this.node + * @return {void} + * + * @example + * + * traverse([0]).forEach((key, val, it) => it.remove()) + * //=> [] + * + * traverse({eh: true}).forEach((key, val, it) => it.remove()) + * //=> {} + * + * traverse({eh: true, str: 'stringy'}).forEach((key, val, it) => { + * if (!isString(val)) it.remove() + * }) + * //=> {str: 'stringy'} + * + */ +Traverse.prototype.remove = function removes(arg) { + // ignore undefined & non-object/arrays + if (isUndefined(this.key)) return + let obj = arg || this.node + if (!isObj(obj)) return - clearParents() + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('remove') + console.log({parent: this.parent, key: this.key, obj}) } - /* prettier-ignore */ - /** - * @TODO handler for Set & Map so they can be skipped or traversed, for example when cloning... - * @TODO add hook to add custom checking if isIteratable - * @TODO deal with .isRoot if needed - * @TODO examples with clone and stop - * - * @sig on(key: null | Primitive, val: any, instance: Traverse): any - * - * @param {Function} on callback fn for each iteration - * @return {*} this.iteratee - * - * @example - * - * iterate([]) - * //=> [] - * //=> on(null, []) - * - * @example - * - * iterate([1]) - * //=> [1] - * //=> on(null, [1]) - * //=> on('1', 1) - * - * @example - * //primitive - same for any number, string, symbol, null, undefined - * iterate(Symbol('eh')) - * //=> Symbol('eh') - * //=> on(Symbol('eh')) - * - * @example - * - * var deeper = {eh: 'canada', arr: [{moose: true}, 0]} - * iterate(deeper) - * //=> deeper // returns - * //=> on(null, deeper, this) // root - * - * //=> on('eh', 'canada', this) // 1st branch - * - * //=> on('arr', [{moose: true}, 0], this) - * //=> on('arr.0', [{moose: true}], this) - * //=> on('arr.0.moose', true, this) - * //=> on('arr.1', [0], this) - * - * - */ - ItOrAteOr.prototype.iterate = function iterate(on) { - // require('fliplog').bold(this.path.join('.')).data(parents).echo() - // require('fliplog').bold(this.path.join('.')).data(parents.keys()).echo() - - /* istanbul ignore next : dev */ - if (ENV_DEBUG) { - console.log('\n...iterate...\n') - } - - if (parents.size >= 100) { - clearParents() - } - - if (this.isAlive === false) { - /* istanbul ignore next : dev */ - if (ENV_DEBUG) { - console.log('DEAD') - } - - return this.done() - } + this.removeParent(obj) + this.skip() - let node = this.iteratee + delete obj[this.key] + delete this.parent[this.key] - // convert to iteratable - if (isMap(node)) { - node = reduce(node) - } - else if (isSet(node)) { - node = toarr(node) - } + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('traverse:remove:', this.key, {obj, iteratee: this.node}) + } +} - // @TODO: maybe only right before sub-loop - addParent(this.depth, node) - // ppAdd(node) +/** + * @desc update the value for the current key + * @version 5.0.0 + * @since 2.0.0 + * @memberOf Traverse + * + * @param {*} value this.node[this.key] = value + * @return {void} + * + * @example + * + * traverse({eh: true}) + * .forEach((key, val, traverser) => { + * if (this.isRoot) return + * traverser.update(false) + * }) + * //=> {eh: false} + * + */ +Traverse.prototype.update = function update(value) { + dotSet(this.root, this.path, value) +} - const nodeIsArray = isArray(node) - const nodeIsObj = nodeIsArray || isObj(node) +/** + * @desc mark the iteration as done, clear the map + * @NOTE this recycles the instance in the pooler to re-use allocated objects + * @memberOf Traverse + * @private + * @since 5.0.0 + * + * @return {void} + * + * @see Traverse.iterate + * + * @example + * + * traverse([]).destructor() + * + */ +Traverse.prototype.destructor = function destructor() { + this.node = undefined + this.parent = undefined + this.reset() - // --- + this.clear() +} - // @event - if (!isUndefined(this.onBefore)) { - // eslint-disable-next-line no-useless-call - this.onBefore(this) - } +/* prettier-ignore */ +/** + * @TODO handler for Set & Map so they can be skipped or traversed, for example when cloning... + * @TODO add hook to add custom checking if isIteratable + * @TODO deal with .isRoot if needed + * @TODO examples with clone and stop + * + * @memberOf Traverse + * @protected + * @sig on(key: null | Primitive, val: any, instance: Traverse): any + * + * @param {Function} on callback fn for each iteration + * @return {*} this.node + * + * @example + * + * iterate([]) + * //=> [] + * //=> on(null, []) + * + * @example + * + * iterate([1]) + * //=> [1] + * //=> on(null, [1]) + * //=> on('1', 1) + * + * @example + * + * //primitive - same for any number, string, symbol, null, undefined + * iterate(Symbol('eh')) + * //=> Symbol('eh') + * //=> on(Symbol('eh')) + * + * @example + * + * var deeper = {eh: 'canada', arr: [{moose: true}, 0]} + * iterate(deeper) + * //=> deeper // returns + * //=> on(null, deeper, this) // root + * + * //=> on('eh', 'canada', this) // 1st branch + * + * //=> on('arr', [{moose: true}, 0], this) + * //=> on('arr.0', [{moose: true}], this) + * //=> on('arr.0.moose', true, this) + * //=> on('arr.1', [0], this) + * + * + */ +Traverse.prototype.iterate = function iterate(on) { + /* istanbul ignore next : dev */ + if (ENV_DEBUG) { + // require('fliplog') + // .bold(this.path.join('.')) + // .data(parents.keys()) + // .echo() + console.log('\n...iterate...\n') + } + if (this.isAlive === false) { /* istanbul ignore next : dev */ if (ENV_DEBUG) { - // const str = require('pretty-format')({nodeIsObj, nodeIsArray, node}) - // require('fliplog').verbose(1).data({nodeIsObj, nodeIsArray, node}).echo() - // console.log(node, parents) - // console.log(str) - console.log({nodeIsObj, nodeIsArray, node}) - } - - /** - * call as root, helpful when we - * - iterate something with no keys - * - iterate a non-iteratable (symbol, error, native, promise, etc) - */ - if (isTrue(this.isRoot)) { - on.call(this, null, node, this) - this.isRoot = false - } - - - // -------------------- - // IF OBJWITHOUTKEYS, IF ARRAY WITHOUT LENGTH... - if (nodeIsArray && node.length === 0) { - on.call(this, this.key, node, this) - this.iteratee = node + console.log('DEAD') } - else if (nodeIsObj && ObjectKeys(node).length === 0) { - // eqValue(node, ) - on.call(this, this.key, node, this) - this.iteratee = node - } - // -------------------- - - else if (nodeIsObj || nodeIsArray) { - this.depth = this.path.length - - // if (isTrue(this.isRoot)) this.isRoot = false - - // @TODO SAFETY WITH `props(node)` <- fixes Error - let keys = nodeIsArray ? node : ObjectKeys(node) - - /* istanbul ignore next : dev */ - if (ENV_DEBUG) { - console.log({keys}) - // require('fliplog').verbose(1).data(this).echo() - } - - // @event - // if (!isUndefined(this.onBefore)) this.onBefore() - // @NOTE: safety here - // this.checkIteratable(node) - - // const last = keys[keys.length - 1] - - // @loop - for (let key = 0; key < keys.length; key++) { - // --- safety --- - if (this.isAlive === false) { - /* istanbul ignore next : dev */ - if (ENV_DEBUG) { - console.log('DEAD') - } + return Traverse.release(this) + } - return this.done() - } + let node = this.node - // @NOTE: look above add prev add parent - // addParent(this.depth, node) - // ppAdd(node) + // convert to iteratable + if (isMap(node)) { + node = reduce(node) + } + else if (isSet(node)) { + node = toarr(node) + } + // @TODO: maybe only right before sub-loop + this.addParent(this.depth, node) - // ----- setup our data ---- + const nodeIsArray = isArray(node) + const nodeIsObj = nodeIsArray || isObj(node) - // to make it deletable - if (node !== this.iteratee) this.parent = node + // --- - this.key = nodeIsArray ? key : keys[key] - // this.isLast = key === last + // @event + if (!isUndefined(this.onBefore)) { + // eslint-disable-next-line no-useless-call + this.onBefore(this) + } - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log('alive', this.key) - } + /* istanbul ignore next : dev */ + if (ENV_DEBUG) { + // const str = require('pretty-format')({nodeIsObj, nodeIsArray, node}) + // require('fliplog').verbose(1).data({nodeIsObj, nodeIsArray, node}).echo() + // console.log(node, parents) + // console.log(str) + console.log({nodeIsObj, nodeIsArray, node}) + } - // @event - if (!isUndefined(this.onPre)) { - // eslint-disable-next-line no-useless-call - this.onPre(this) - } + /** + * call as root, helpful when we + * - iterate something with no keys + * - iterate a non-iteratable (symbol, error, native, promise, etc) + */ + if (isTrue(this.isRoot)) { + on.call(this, null, node, this) + this.isRoot = false + } + const isObjOrArray = nodeIsArray || nodeIsObj - const value = node[this.key] + // if (isObjOrArray) { + // // @event + // if (!isUndefined(this.onBefore)) { + // // eslint-disable-next-line no-useless-call + // this.onBefore(this) + // } + // } - this.checkIteratable(value) - // addParent(value) - const pathBeforeNesting = this.path.slice(0) + // -------------------- + // IF OBJWITHOUTKEYS, IF ARRAY WITHOUT LENGTH... + if (isObjOrArray && isEmpty(node)) { + on.call(this, this.key, node, this) + this.node = node + } - // @NOTE: can go forward-backwards if this is after the nested iterating - this.path.push(this.key) - this.depth = this.path.length + // -------------------- - // ----- continue events, loop deeper when needed ---- + else if (isObjOrArray) { + this.depth = this.path.length - on.call(this, this.key, value, this) + // @TODO SAFETY WITH `props(node)` <- fixes Error + let keys = nodeIsArray ? node : ObjectKeys(node) - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - // require('fliplog').data(parents).echo() - // require('fliplog').data(this).echo() - } + /* istanbul ignore next : dev */ + if (ENV_DEBUG) { + console.log({keys}) + // require('fliplog').verbose(1).data(this).echo() + } - // handle data - if (isTrue(this.isCircular)) { - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log('(((circular)))', this.key) - } - - // on.call(this, this.key, value, this) - // this.path.pop() - this.path = pathBeforeNesting - - // this.isCircular = false - // break - continue - // return - } + // @event + // if (!isUndefined(this.onBefore)) this.onBefore() + // @NOTE: safety here + // this.checkIteratable(node) - // && - if (isTrue(this.isIteratable)) { - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log('(((iteratable)))', this.key) - } + // const last = keys[keys.length - 1] - this.iteratee = value - this.iterate(on) - this.path = pathBeforeNesting - } + // @loop + for (let key = 0; key < keys.length; key++) { + // if (ENV_DEBUG) + // console.log('iterating:', {key}) - /* istanbul ignore next: dev */ + // --- safety --- + if (this.isAlive === false) { + /* istanbul ignore next : dev */ if (ENV_DEBUG) { - if (this.isIteratable === false) { - console.log('not iteratable', this.key) - } + console.log('DEAD') } - - // console.log('----------------- post ----------', node) - - - // @event - if (!isUndefined(this.onPost)) { - // eslint-disable-next-line no-useless-call - this.onPost(this) - } - - // cleanup, backup 1 level - this.path.pop() - - // ppPop() - removeParent(node) + return Traverse.release(this) } - // this.path.pop() - this.depth = this.path.length - } - else { - // this.isLast = false - on.call(this, this.depth, node, this) - } + // @NOTE: look above add prev add parent + // addParent(this.depth, node) - // @NOTE: careful - // removeParent(node) - // @NOTE: just for .after ? - this.iteratee = node + // ----- setup our data ---- - // @event - if (!isUndefined(this.onAfter)) { - // eslint-disable-next-line no-useless-call - this.onAfter(this) - } + // to make it deletable + if (node !== this.node) this.parent = node - this.path.pop() - - return this.iteratee - } + this.key = nodeIsArray ? key : keys[key] + // this.isLast = key === last - // is smaller - // function onEvent(property) { - // return function(fn) { - // this[property] = function - // } - // } - // when it's some sort of itertable object, loop it further - // @TODO: need to handle these better without totally messing with bad scope - ItOrAteOr.prototype.pre = function(fn) { - this.onPre = fn - } - ItOrAteOr.prototype.post = function(fn) { - this.onPost = fn - } - ItOrAteOr.prototype.before = function(fn) { - this.onBefore = fn - } - ItOrAteOr.prototype.after = function(fn) { - this.onAfter = fn - } - - // ----------------------- - - /** - * @TODO merge with dopemerge? - * @TODO needs tests converted back for this (observe tests do cover somewhat) - * - * @param {*} arg defaults to this.iteratee - * @return {*} cloned - * - * @example - * - * var obj = {} - * var cloned = traverse().clone(obj) - * obj.eh = true - * eq(obj, cloned) - * //=> false - * - */ - ItOrAteOr.prototype.clone = clone - - /** - * @todo ugh, how to clone better with *recursive* objects? - * @param {any} src wip - * @return {any} wip - */ - ItOrAteOr.prototype.copy = copy - - // end factory - return ItOrAteOr -} - -/* prettier-ignore */ -function copy(src) { - if (isObjNotNull(src)) { - let dst - - // if (isPrimitive(src)) { - // if (isNullOrUndefined(src)) { - // dst = src - // } - - // @TODO @IMPORTANT @FIXME @!IMPORTANT - COVER THIS OR NOT? - // for string value number boolean objects... - // if (isString(src)) { - // dst = src + '' - // } - // else if (isNumber(src)) { - // dst = src + 0 - // } - // else if (isBoolean(src)) { - // dst = !!src - // } - // else - - // lists... <- needs to have dot-prop support on Map/Set - // if (isMap(src)) { - // dst = new Map() - // const obj = reduce(src) - // // src.clear() - // ObjectKeys(obj).forEach(key => dst.set(key, obj[key])) - // return dst - // } - // else if (isSet(src)) { - // dst = new Set() - // // could clone here too - // const obj = toarr(src) - // // src.clear() - // obj.forEach(value => dst.add(value)) - // return dst - // } - - // ------ - if (isArray(src)) { - dst = [] - } - else if (isDate(src)) { - dst = new Date(src.getTime ? src.getTime() : src) - } - else if (isRegExp(src)) { - dst = new RegExp(src) - } - else if (isError(src)) { - dst = new Error(src.message) - dst.stack = src.stack - } - else { - dst = Object.create(Object.getPrototypeOf(src)) - } - - // @TODO: copy descriptor - // eslint-disable-next-line - for (var prop in src) { - dst[prop] = src - // const desc = Object.getOwnPropertyDescriptor(src, prop) - // Object.defineProperty(dst, prop, desc) - } - return dst - } - else { - // require('fliplog').red('is NOT OBJ').echo() - return src - } -} - -function clone(arg) { - const obj = isUndefined(arg) ? this.iteratee : arg - if (isPrimitive(obj)) return obj - let cloned = isArray(obj) ? [] : {} - let current = cloned - - traverse(obj).forEach((key, value, traverser) => { - // t.isRoot - if (key === null) return - // require('fliplog').bold(key).data({value, traverser, current}).echo() - // if (isSet(value)) { - // const copied = copy(value) - // dot.set(current, traverser.path, copied) - // - // // require('fliplog') - // // .red('copy:') - // // .data({value, path: traverser.path, current, copied}) - // // .exit() - // } + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('alive', this.key) + } - let copied = copy(value) - if (traverser.isCircular && isArray(value)) copied = value.slice(0) - dot.set(current, traverser.path, copied) + // @event + if (!isUndefined(this.onPre)) { + // eslint-disable-next-line no-useless-call + this.onPre(this) + } - // current[key] = traverser.copy(value) - // if (isObj(value)) current = current[key] - }) - return cloned -} + const value = node[this.key] -/* prettier-ignore */ -/** - * @since 4.1.0 - * - * @protected - * @TODO !!!!!! USE ENUM FLAGS ON LOOSE TO ALLOW MORE CONFIG FOR ==, COMPARATOR, VALUEOF, walk proto (check ownProps...)... - * - * @param {*} x compare to y - * @param {*} y compare to x - * @param {boolean | number} [loose=false] use == checks when typof != - * @return {boolean} - * - * @example - * eqValue(1, 1) //=> true - * eqValue('1', 1) //=> false - * eqValue('1', 1, true) //=> true - * eqValue({}, {}) //=> true - */ -function eqValue(x, y, loose) { - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log('eqValue', {x, y, loose}) - } + this.checkIteratable(value) + // addParent(value) + const pathBeforeNesting = this.path.slice(0) - // if (x === y) { - // if (ENV_DEBUG) { - // console.log('===', {x, y}) - // } - // // noop - // } - // else + // @NOTE: can go forward-backwards if this is after the nested iterating + this.path.push(this.key) + this.depth = this.path.length - if (isNullOrUndefined(x) || isNullOrUndefined(y)) { - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log('null or undef !=', {x, y}) - } + // ----- continue events, loop deeper when needed ---- - if (x !== y) { - return false - } - } - else if (typeof x !== typeof y) { - // eslint-disable-next-line - if (isTrue(loose) && x == y) { - // ignore - } - else { - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log('typeof !=', {x, y}) + // @NOTE since we check isAlive at the beginning of each loop + // could use .skip alongisde .stop + // @TODO @IMPORTANT @HACK @FIXME right here it should also handle the .stop + on.call(this, this.key, value, this) + if (isTrue(this.skipBranch)) { + this.skipBranch = false + continue } - return false - } - } - else if (isObjNotNull(x)) { - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log('isObjNotNull', {x}) - } - - // if (isArray(x)) { - // if (x.length !== y.length) { - // return false - // } - // } - - // @NOTE .toString will be covered for functions and regexes in objStrict - if (isRegExp(x) || isRegExp(y)) { /* istanbul ignore next: dev */ if (ENV_DEBUG) { - console.log('regexp', {x, y}) + // require('fliplog').data(parents).echo() + // require('fliplog').data(this).echo() } - if (!x || !y || x.toString() !== y.toString()) { + // handle data + if (isTrue(this.isCircular)) { /* istanbul ignore next: dev */ if (ENV_DEBUG) { - console.log('regexp !=', {x, y}) + console.log('(((circular)))', this.key) } - return false - } - } - else if (isDate(x) || isDate(y)) { - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log('dates', {x, y}) - } - - if (!isDate(x) || !isDate(y) || x.getTime() !== y.getTime()) { - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log('!= dates', {x, y}) - } + // on.call(this, this.key, value, this) + // this.path.pop() + this.path = pathBeforeNesting - return false - } - } - else if (isError(x) || isError(y)) { - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log('isError', {x, y}) + // this.isCircular = false + // break + continue + // return } - if (!isError(x) || !isError(y) || x.stack !== y.stack) { + + // && + if (isTrue(this.isIteratable)) { /* istanbul ignore next: dev */ if (ENV_DEBUG) { - console.log('!= errors', {x, y}) + console.log('(((iteratable)))', this.key) } - return false - } - } - else if (isArray(x) && !isArray(y)) { - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log('isArray(x) || isArray(y)!') + this.node = value + this.iterate(on) + this.path = pathBeforeNesting } - return false - } - else if (!isArray(x) && isArray(y)) { /* istanbul ignore next: dev */ if (ENV_DEBUG) { - console.log('!isArray(x) && isArray(y):') - } - - return false - } - else { - // @NOTE it will traverse through values if they are == here - const xKeys = ObjectKeys(x) - const yKeys = ObjectKeys(y).length - - if (xKeys.length !== yKeys) { - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log('!= obj key length', {xKeys, yKeys}) + if (this.isIteratable === false) { + console.log('not iteratable', this.key) } - return false + console.log('----------------- post ----------', node) } - for (let k = 0; k < xKeys.length; k++) { - if (!hasOwnProperty(y, xKeys[k])) { - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log('!= obj property', {y, val: xKeys[k]}) - } - - return false - } + // @event + if (!isUndefined(this.onPost)) { + // eslint-disable-next-line no-useless-call + this.onPost(this) } - } - } - else if (toS(x) === toS(y) && x !== y) { - // isString(x) || isBoolean(x) || isNumber(x) || isIterator(x) - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log('same str types - diff values', {s: toS(x), x, y}) - } - return false - } - else if (toS(x) !== toS(y)) { - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log('diff str types', {x: toS(x), y: toS(y)}) - } - - return false - } + // cleanup, backup 1 level + this.path.pop() - // go deeper - else if (isFunction(x) || isFunction(y)) { - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log('isFunction(x) && isFunction(y):') - console.log(x.toString()) - console.log(y.toString()) + this.removeParent(node) } - if (!x || !y || x.toString() !== y.toString()) { - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log('x.toString() !== y.toString()', x.toString() !== y.toString()) - } - return false - } - else { - return true - } + // this.path.pop() + this.depth = this.path.length } - - else if (isObj(x) && isObj(y)) { - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log('isObj(x) && isObj(y):') - } - - return false - } - // else { - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log('eqeqeq:', {[toS(x) + 'X']: x, [toS(y) + 'Y']: y}) - } - return true - // } -} - -/* prettier-ignore */ -function eq(a, b, loose, scoped) { - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log('\n') + else { + // this.isLast = false + on.call(this, this.depth, node, this) } - let equal = true - let node = b + // @NOTE: careful + // removeParent(node) - // @TODO can be helpful? for left to right in 1 traverse for faster eq? - // let _node = b + // @NOTE: just for .after ? + this.node = node - const instance = traverse(a) - const notEqual = () => { - // throw new Error() - equal = false - instance.stop() + // @event + if (!isUndefined(this.onAfter)) { + // eslint-disable-next-line no-useless-call + this.onAfter(this) } - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log('eq?') - } + this.path.pop() - instance.forEach(function(key, y, traverser) { - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log('eq: iterating:') - } + return this.node +} - // BREAKS ANY BUT OBJ - // if (!isObjLoose(node)) { - // node = _node - // return notEqual() - // } - // else { - // _node = node - // } - - if (isObjNotNull(node)) { - // _node = node - node = node[traverser.key] - } +// is smaller, but probably slower +// function onEvent(property) { +// return function(fn) { +// this[property] = function +// } +// } - // node = node ? node[traverser.key] : node +// when it's some sort of itertable object, loop it further +// @TODO: need to handle these better without totally messing with bad scope +Traverse.prototype.pre = function(fn) { + this.onPre = fn +} +Traverse.prototype.post = function(fn) { + this.onPost = fn +} +Traverse.prototype.before = function(fn) { + this.onBefore = fn +} +Traverse.prototype.after = function(fn) { + this.onAfter = fn +} - let x = node - x = dot.get(b, traverser.path.join('.'), b) +// ----------------------- - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log({key, y, x, a, b}) - } +/** + * @TODO merge with dopemerge? + * @TODO needs tests converted back for this (observe tests do cover somewhat) + * + * @param {*} arg defaults to this.node + * @return {*} cloned + * + * @example + * + * var obj = {} + * var cloned = traverse().clone(obj) + * obj.eh = true + * eq(obj, cloned) + * //=> false + * + */ +Traverse.prototype.clone = clone - const eqv = eqValue(x, y, loose) +/** + * @todo ugh, how to clone better with *recursive* objects? + * @param {any} src wip + * @return {any} wip + */ +Traverse.prototype.copy = copy - /* istanbul ignore next: dev */ - if (ENV_DEBUG) { - console.log({eqv}) - } +/** + * @desc clone any value + * @version 5.0.0 + * @since 4.0.0 + * @memberOf Traverse + * @extends copy + * @extends Traverse + * + * @param {*} arg argument to clone + * @return {*} cloned value + * + * @see dopemerge + * @example + * + * var obj = {eh: true} + * clone(obj) === obj //=> false + * + * var obj = {eh: true} + * var obj2 = clone(obj) + * obj.eh = false + * console.log(obj2.eh) //=> true + * + */ +function clone(arg) { + const obj = isUndefined(arg) ? this.node : arg + if (isPrimitive(obj)) return obj + let cloned = emptyTarget(obj) + let current = cloned - if (eqv === false) { - // equal - notEqual() - } - // } + traverse(obj).forEach((key, value, traverser) => { + // t.isRoot + if (isNull(key)) return + + let copied = copy(value) + if (traverser.isCircular && isArray(value)) copied = value.slice(0) + dotSet(current, traverser.path, copied) }) - if (equal === false && scoped === false) return eq(b, a, loose, true) - else return equal + return cloned } +// @TODO could just have traverse = Traverse.getPooled ? +addPoolingTo(Traverse) function traverse(value) { - const ItOrAteOr = makeIterator() - return new ItOrAteOr(value) + return Traverse.getPooled(value) } +traverse.eq = eq(traverse) +traverse.clone = clone +traverse.copy = copy module.exports = traverse -module.exports.eq = eq -module.exports.clone = clone -module.exports.copy = copy diff --git a/src/deps/traversers/_eq.js b/src/deps/traversers/_eq.js new file mode 100644 index 0000000..3a0f9e3 --- /dev/null +++ b/src/deps/traversers/_eq.js @@ -0,0 +1,146 @@ +// conditionals +/* eslint complexity: "OFF" */ + +// not iterating on empty root +/* eslint consistent-return: "OFF" */ + +// const traverse = require('../traverse') +// const get = require('../dot/get') +const isObjNotNull = require('../is/objNotNull') +const isNull = require('../is/null') +const isEmpty = require('../is/empty') +const ENV_DEBUG = require('../env/debug') +const eqValue = require('./eqValue') + +/* prettier-ignore */ +/** + * @name eq + * @since 3.0.0 + * @version 5.0.0 + * @memberOf Traverse + * + * {@link https://github.com/facebook/react/blob/master/src/__mocks__/deepDiffer.js react-deep-differ} + * {@link https://github.com/substack/js-traverse/blob/master/test/lib/deep_equal.js traverse-deep-equal} + * {@link https://github.com/jashkenas/underscore/blob/master/underscore.js#L1183 underscore-equal} + * {@link https://github.com/angular/angular.js/blob/master/src/Angular.js angular-is-equal} + * {@link https://lodash.com/docs/4.17.4#isEqual lodash-is-equal} + * {@link http://ramdajs.com/docs/#equals ramda-equals} + * {@link https://github.com/substack/node-deep-equal node-deep-equal} + * {@link https://github.com/facebook/immutable-js/blob/master/src/utils/deepEqual.js immutable-js-deep-equal} + * @see {@link immutable-js-deep-equal} + * @see {@link node-deep-equal} + * @see {@link ramda-equals} + * @see {@link lodash-is-equal} + * @see {@link angular-is-equal} + * @see {@link underscore-equal} + * @see {@link traverse-deep-equal} + * @see {@link react-deep-differ} + * + * @param {Traverse} traverse traversejs (scoped, @FIXME @HACK) + * @param {*} a compare to b + * @param {*} b compare to a + * @param {boolean} [loose] compare loosely + * @return {boolean} isEqual: a === b + * + * @extends eqValue + * + * @example + * + * eq(1, 1) //=> true + * eq(1, '1') //=> false + * eq(1, '1', true) //=> true + * eq([1], [1]) //=> true + * + */ +module.exports = traverse => function eq(a, b, loose) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('\n') + } + + let equal = true + let node = b + let nodes = [node] + + const instance = traverse(a) + + const notEqual = () => { + equal = false + instance.stop() + } + + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('eq?') + } + + instance.forEach(function(key, y, traverser) { + // @NOTE do base comparisons on values that are not actually iteratable + // aka, .isRoot + if (isNull(key)) { + // always-valid state opionion vs always-invalid + // so it only returns false when it is !== fosho + if (eqValue(node, y, loose) === false) return notEqual() + else return + } + + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('eq: iterating:') + } + + // could use it as a fallback if undefined && y !== undefined + // const xyz = get(b, traverser.path.join('.'), b) + + let x = node + + // isNotLeafAndIsObj + if (isObjNotNull(node) && !isEmpty(node)) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('is leaf, is not empty node, going deeper') + } + + // so x is our current one, + // if node is not empty, use the key, push the value + // and when it is empty, and it is not a leaf but has nodes, pop back up + x = node[key] + nodes.push(x) + } + + // ENV_DEBUG + // console.log({[key]: {x, xyz, y, nodes, path: traverser.path.join('.')}}) + + // for next loop!!! + if (!traverser.isLeaf && !isEmpty(nodes)) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('is not leaf, has nodes stack, pop') + } + node = nodes.pop() + } + + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log({key, y, x, a, b}) + } + + const eqv = eqValue(x, y, loose) + + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log({eqv}) + } + + if (eqv === false) { + // equal + notEqual() + } + }) + + // cleanup + nodes = undefined + node = undefined + + return equal +} diff --git a/src/deps/traversers/copy.js b/src/deps/traversers/copy.js new file mode 100644 index 0000000..50ab66e --- /dev/null +++ b/src/deps/traversers/copy.js @@ -0,0 +1,108 @@ +const isObjNotNull = require('../is/objNotNull') +const isRegExp = require('../is/regexp') +const isError = require('../is/error') +const isDate = require('../is/date') +const isArray = require('../is/array') +const newRegExp = require('../construct/regexp') +const ENV_DEBUG = require('../env/debug') + +/* prettier-ignore */ +/** + * @desc copy any primitive value, part of clone + * @version 5.0.0 + * @since 3.0.0 + * @name copy + * @see clone + * @memberOf Traverse + * + * @param {*} src value to copy + * @return {*} copied + * + * @example + * + * copy(/eh/gmi) //=> new RegExp('eh', 'gmi') + * copy(new Error('eh')) // => new Error with copied stack + msg + * copy([1]) // => [1] + * copy({}) // => {} + * + */ +module.exports = function copy(src) { + if (isObjNotNull(src)) { + let dst + + // if (isPrimitive(src)) { + // if (isNullOrUndefined(src)) { + // dst = src + // } + + // @TODO @IMPORTANT @FIXME @!IMPORTANT - COVER THIS OR NOT? + // for string value number boolean objects... + // if (isString(src)) { + // dst = src + '' + // } + // else if (isNumber(src)) { + // dst = src + 0 + // } + // else if (isBoolean(src)) { + // dst = !!src + // } + // else + + // lists... <- needs to have dot-prop support on Map/Set + // if (isMap(src)) { + // dst = new Map() + // const obj = reduce(src) + // // src.clear() + // ObjectKeys(obj).forEach(key => dst.set(key, obj[key])) + // return dst + // } + // else if (isSet(src)) { + // dst = new Set() + // // could clone here too + // const obj = toarr(src) + // // src.clear() + // obj.forEach(value => dst.add(value)) + // return dst + // } + + // ------ + if (isArray(src)) { + dst = [] + } + // @TODO also would just be isPrimitive + // was new date(src.getTime()) + // || isBoolean(src) || isNumber(src) || isString(src) + else if (isDate(src)) { + dst = new src.constructor(src.valueOf()) + } + else if (isRegExp(src)) { + // dst = new RegExp(src) + dst = newRegExp(src.src, src.toString().match(/[^/]*$/)[0]) + // dst = new RegExp(src.src, src.toString().match(/[^/]*$/)[0]) + dst.lastIndex = src.lastIndex + } + // @TODO this should just be handled by the next condition... + // else if (isError(src)) { + // dst = new Error(src.message) + // dst.stack = src.stack + // } + else { + dst = Object.create(Object.getPrototypeOf(src)) + } + + // @TODO: copy descriptor + // eslint-disable-next-line + for (var prop in src) { + dst[prop] = src + // const desc = Object.getOwnPropertyDescriptor(src, prop) + // Object.defineProperty(dst, prop, desc) + } + return dst + } + else { + if (ENV_DEBUG) { + console.log('is not obj', src) + } + return src + } +} diff --git a/src/deps/traversers/eqValue.js b/src/deps/traversers/eqValue.js new file mode 100644 index 0000000..836951c --- /dev/null +++ b/src/deps/traversers/eqValue.js @@ -0,0 +1,266 @@ +// conditionals +/* eslint complexity: "OFF" */ +// debugging +/* eslint max-depth: "OFF" */ + +const isObjNotNull = require('../is/objNotNull') +const isNullOrUndefined = require('../is/nullOrUndefined') +const isFunction = require('../is/function') +const isRegExp = require('../is/regexp') +const isError = require('../is/error') +const isTrue = require('../is/true') +const isDate = require('../is/date') +const isArray = require('../is/array') +const isObj = require('../is/obj') +const toS = require('../is/toS') +const hasOwnProperty = require('../util/hasOwnProperty') +const ObjectKeys = require('../util/keys') +const ObjectOrArrayKeys = require('../util/keysObjOrArray') +const ENV_DEBUG = require('../env/debug') + +// const ENV_DEBUG = true + +const isNotRealOrNotEqToString = (x, y) => + !x || !y || x.toString() !== y.toString() + +/* prettier-ignore */ +/** + * @desc checks value equality, used by eq which compares all types + * @since 4.1.0 + * @memberOf Traverse + * @protected + * + * @TODO !!!!!! USE ENUM FLAGS ON LOOSE TO ALLOW MORE CONFIG FOR ==, COMPARATOR, VALUEOF, walk proto (check ownProps...)... + * + * @param {*} x compare to y + * @param {*} y compare to x + * @param {boolean | number} [loose=false] use == checks when typof != + * @return {boolean} + * + * @example + * + * eqValue(1, 1) //=> true + * eqValue('1', 1) //=> false + * eqValue('1', 1, true) //=> true + * eqValue({}, {}) //=> true + * + */ +module.exports = function eqValue(x, y, loose) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('eqValue', {x, y, loose}) + } + + // if (x === y) { + // if (ENV_DEBUG) { + // console.log('===', {x, y}) + // } + // // noop + // } + // else + + if (isNullOrUndefined(x) || isNullOrUndefined(y)) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('null or undef !=', {x, y}) + } + + if (x !== y) { + return false + } + } + else if (typeof x !== typeof y) { + // eslint-disable-next-line + if (isTrue(loose) && x == y) { + // ignore + } + else { + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('typeof !=', {x, y}) + } + + return false + } + } + // @TODO put this up first? + else if (toS(x) !== toS(y)) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('diff str types', {x: toS(x), y: toS(y)}) + } + + return false + } + else if (isObjNotNull(x)) { + // use .equals if the method exists + if (hasOwnProperty(x, 'equals')) { + return x.equals(y) + } + + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('isObjNotNull', {x}) + } + + // if (isArray(x)) { + // if (x.length !== y.length) { + // return false + // } + // } + + // @NOTE .toString will be covered for functions and regexes in objStrict + if (isRegExp(x) || isRegExp(y)) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('regexp', {x, y}) + } + + if (isNotRealOrNotEqToString(x, y)) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('regexp !=', {x, y}) + } + + return false + } + } + else if (isDate(x) || isDate(y)) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('dates', {x, y}) + } + + if (!isDate(x) || !isDate(y) || x.getTime() !== y.getTime()) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('!= dates', {x, y}) + } + + return false + } + } + else if (isError(x) || isError(y)) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('isError', {x, y}) + } + + if (!isError(x) || !isError(y) || x.stack !== y.stack) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('!= errors', {x, y}) + } + + return false + } + } + + // @NOTE this is covered by toString != toString + // else if (isArray(x) && !isArray(y)) { + // /* istanbul ignore next: dev */ + // if (ENV_DEBUG) { + // console.log('isArray(x) || isArray(y)!') + // } + // + // return false + // } + // else if (!isArray(x) && isArray(y)) { + // /* istanbul ignore next: dev */ + // if (ENV_DEBUG) { + // console.log('!isArray(x) && isArray(y):') + // } + // + // return false + // } + + // @TODO considering, we already know it is not null & undefined + // if (isPrimitive(x) || isPrimitive(y)) { + // return x.valueOf() === y.valueOf() + // } + + else { + // @TODO ObjectOrArrayKeys, but have to have else where they are both array + // + // @NOTE it will traverse through values if they are == here + const xKeys = ObjectKeys(x) + const yKeys = ObjectKeys(y).length + + // diff length + if (xKeys.length !== yKeys) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('!= obj key length', {xKeys, yKeys}) + } + + return false + } + + for (let k = 0; k < xKeys.length; k++) { + if (!hasOwnProperty(y, xKeys[k])) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('!= obj property', {y, val: xKeys[k]}) + } + + return false + } + } + } + } + else if (toS(x) === toS(y) && x !== y) { + // isString(x) || isBoolean(x) || isNumber(x) || isIterator(x) + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('same str types - diff values', {s: toS(x), x, y}) + } + + return false + } + // // @TODO put this up first? + // else if (toS(x) !== toS(y)) { + // /* istanbul ignore next: dev */ + // if (ENV_DEBUG) { + // console.log('diff str types', {x: toS(x), y: toS(y)}) + // } + // + // return false + // } + + // go deeper + else if (isFunction(x) || isFunction(y)) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('isFunction(x) && isFunction(y):') + console.log(x.toString()) + console.log(y.toString()) + } + + if (isNotRealOrNotEqToString(x, y)) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('x.toString() !== y.toString()', x.toString() !== y.toString()) + } + return false + } + else { + return true + } + } + // @TODO why? + else if (isObj(x) && isObj(y)) { + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('isObj(x) && isObj(y):') + } + + return false + } + // else { + /* istanbul ignore next: dev */ + if (ENV_DEBUG) { + console.log('eqeqeq:', {[toS(x) + 'X']: x, [toS(y) + 'Y']: y}) + } + return true + // } +} diff --git a/src/deps/traversers/traverse-comments.js b/src/deps/traversers/traverse-comments.js new file mode 100644 index 0000000..3d51758 --- /dev/null +++ b/src/deps/traversers/traverse-comments.js @@ -0,0 +1,225 @@ +// need some thin wrapper around values to go up and down path +// +// +// const ValueObject = { +// node: value, +// kind: typeof, +// isRoot: false, +// isLeaf: false, +// isPrimitive: false, +// branches: [], +// isFirst: false, +// isLast: false, +// parent: {}, +// } +// +// class It { +// constructor(x) { +// // this.tree = { +// // parent: {}, +// // } +// +// // this.root = x +// +// // this.previous = x +// this.current = x +// +// this.depth = 0 +// this.all = new Set() +// // this.path +// // this.key +// } +// +// get node() { +// return this.current +// } +// +// addBranch() {} +// +// // for updating +// branchHead() {} +// +// goUp() { +// this.depth-- +// } +// goDown(current) { +// this.parent = this.current +// this.depth++ +// this.current = current +// } +// // not needed but conceptually +// // goNext() {} +// +// find() {} +// path() {} +// } +// const it = x => new It(x) + + +// return Array.from(parents.values()).indexOf(value) !== -1 +// const keys = Array.from(parents.keys()) +// console.log('___pk', {keys}) +// for (let k = 0; k < keys.length; k++) { +// const key = keys[k] +// const matches = +// depth.includes(key) || (key.includes && key.includes(depth)) +// console.log({key, matches, depth}) +// // .has(value) +// if (matches) { +// let has = false +// parents.get(key).forEach(haz => { +// if (value === haz) has = true +// }) +// return has +// } +// } + +// for (let i = depth; i >= depth; i--) { +// if (parents.get(i).has(value)) return true +// } + +// return false + + +// const pps = [] +// const ppHas = value => { +// for (let i = 0; i < pps.length; i++) { +// if (pps[i] === value) { +// return true +// } +// } +// } +// const ppAdd = value => pps.push(value) +// const ppPop = () => pps.pop() + +// else if (ppHas(node)) { +// if (ENV_DEBUG) { +// console.log('PPHAS!!!!!!!!!!!', {node, path: this.path}) +// } +// this.isCircular = true +// } + + +// ----- clear/update ---- +// if (!isUndefined(this.iteratee)) { +// this.iteratee[this.key] = value +// } +// // dot.set(this.iteratee, this.key, value) + +// dot.set(this.iteratee, this.path, value) + +// dot.set(this.iteratee, this.key, value) +// console.log({traverser: this}) + +// @NOTE think about this more, but updating can change structure +// if (isTrue(clear)) clearParents() + +// ----- parents +// if (!this.parents.has(depth)) this.parents.set(depth, new Set()) +// this.parents.get(depth).add(value) + +// (isObj(value) ? parents.add(value) : parents.add(value)) +// const removeLastParent = () => parents.delete(lastParent) + +// parents.forEach(parent => (parent.has(value) ? parent.delete(value) : null)) +// parents.delete(value) + + +// ---- eq ---- + +// from underscore.js & ramda +// +// Assume equality for cyclic structures. The algorithm for detecting cyclic +// structures is adapted from ES 5.1 section 15.12.3, abstract operation `JO`. +// +// Initializing stack of traversed objects. +// It's done here since we only need them for objects and arrays comparison. +// let length = stackA.length +// while (length--) { +// // Linear search. Performance is inversely proportional to the number of +// // unique nested structures. +// if (stackA[length] === a) return stackB[length] === b +// } +// +// // Add the first object to the stack of traversed objects. +// stackA.push(a) +// stackB.push(b) + +// BREAKS ANY BUT OBJ +// if (!isObjLoose(node)) { +// node = _node +// return notEqual() +// } +// else { +// _node = node +// } + +// if (isObjNotNull(node)) { +// // _node = node +// // nodes.push(node) +// // node = node[key] +// } +// else { +// // node = nodes.pop() +// } + +// node = node ? node[traverser.key] : node +// instance.before(traverser => { +// // node = traverser.iteratee +// // if (!isObjNotNull(x)) return +// // // nodes.push(x) +// // x = x[key] +// // nodes.push(x) +// }) +// instance.after(() => { +// // x = node +// // console.log('x before pop', {x}) +// // node = +// // nodes.pop() +// // x = node +// // console.log('x after pop, nodes', {x}) +// }) + + +// ----- remove ----- +// if (isObj(obj)) deleteFromObjOrArray(obj, this.key) +// else deleteFromObjOrArray(this.parent, this.key) +// deleteFromObjOrArray(this.parent, this.key) +// deleteFromObjOrArray(this.iteratee, this.key) + +// if (isUndefined(obj)) { +// // throw new Error('why?') +// } +// else if (isArray(obj)) { +// /* istanbul ignore next: dev */ +// if (ENV_DEBUG) { +// console.log('traverse:remove:array', obj, this.key) +// } +// +// obj.splice(this.key, 1) +// } +// else if (isObjNotNull(obj)) { +// /* istanbul ignore next: dev */ +// if (ENV_DEBUG) { +// console.log('traverse:remove:obj', this.key) +// } +// +// delete obj[this.key] +// } +// +// if (isObjNotNull(this.parent)) { +// delete this.parent[this.key] +// +// /* istanbul ignore next: dev */ +// if (ENV_DEBUG) { +// console.log('traverse:remove:parent', this.key) +// } +// } +// if (isObjNotNull(this.iteratee)) { +// delete this.iteratee[this.key] +// +// /* istanbul ignore next: dev */ +// if (ENV_DEBUG) { +// console.log('traverse:remove:iteratee', this.key) +// } +// } diff --git a/src/deps/util/assign.js b/src/deps/util/assign.js index d0fa64c..17ea164 100644 --- a/src/deps/util/assign.js +++ b/src/deps/util/assign.js @@ -1 +1,94 @@ -module.exports = Object.assign \ No newline at end of file +/** + * @memberOf util + * + * {@link https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Object/assign mozilla-object-assign} + * {@link https://esdiscuss.org/topic/object-assign-with-several-source-objects esdiscuss-object-assign} + * {@link https://github.com/facebook/react/blob/4b2eac3de7e1dbf5c2dd742fd9989974a83972cb/scripts/babel/transform-object-assign-require.js react-object-assign} + * {@link https://github.com/lodash/lodash/blob/master/.internal/assignValue.js lodash-assign} + * {@link https://github.com/ramda/ramda/blob/master/src/internal/_objectAssign.js ramda-assign} + * @see {@link react-object-assign} + * @see {@link ramda-assign} + * @see {@link lodash-assign} + * @see {@link esdiscuss-object-assign} + * @see {@link mozilla-object-assign} + * + * @type {Function} + */ +module.exports = Object.assign + +// @TODO polyfil + +// --- check +// function shouldUseNative() { +// try { +// if (!Object.assign) { +// return false +// } +// +// // Detect buggy property enumeration order in older V8 versions. +// +// // https://bugs.chromium.org/p/v8/issues/detail?id=4118 +// var test1 = new String('abc') // eslint-disable-line no-new-wrappers +// test1[5] = 'de' +// if (Object.getOwnPropertyNames(test1)[0] === '5') { +// return false +// } +// +// // https://bugs.chromium.org/p/v8/issues/detail?id=3056 +// var test2 = {} +// for (var i = 0; i < 10; i++) { +// test2['_' + String.fromCharCode(i)] = i +// } +// var order2 = Object.getOwnPropertyNames(test2).map(function(n) { +// return test2[n] +// }) +// if (order2.join('') !== '0123456789') { +// return false +// } +// +// // https://bugs.chromium.org/p/v8/issues/detail?id=3056 +// var test3 = {} +// 'abcdefghijklmnopqrst'.split('').forEach(function(letter) { +// test3[letter] = letter +// }) +// if ( +// Object.keys(Object.assign({}, test3)).join('') !== 'abcdefghijklmnopqrst' +// ) { +// return false +// } +// +// return true +// } +// catch (err) { +// // We don't expect any of the above to throw, but better to be safe. +// return false +// } +// } + +// --- handle +// function ObjectAssign(target, source) { +// var from +// var to = toObject(target) +// var symbols +// +// for (var s = 1; s < arguments.length; s++) { +// from = Object(arguments[s]) +// +// for (var key in from) { +// if (hasOwnProperty.call(from, key)) { +// to[key] = from[key] +// } +// } +// +// if (getOwnPropertySymbols) { +// symbols = getOwnPropertySymbols(from) +// for (var i = 0; i < symbols.length; i++) { +// if (propIsEnumerable.call(from, symbols[i])) { +// to[symbols[i]] = from[symbols[i]] +// } +// } +// } +// } +// +// return to +// } diff --git a/src/deps/util/flatten.js b/src/deps/util/flatten.js index 5201630..e60693a 100644 --- a/src/deps/util/flatten.js +++ b/src/deps/util/flatten.js @@ -1,8 +1,12 @@ /** * @desc flatten multi-dimensional arrays in 1 line - * @see https://stackoverflow.com/questions/10865025/merge-flatten-an-array-of-arrays-in-javascript - * @param {Array} arr array(s) to flatten + * @since 4.0.0 + * @memberOf util + * + * @param {Array} x array(s) to flatten * @return {Array} flattened arrays + * + * @see https://stackoverflow.com/questions/10865025/merge-flatten-an-array-of-arrays-in-javascript * @example * * flatten([[1], [2]]) diff --git a/src/deps/util/hasOwnProperty.js b/src/deps/util/hasOwnProperty.js index d608a53..5d43089 100644 --- a/src/deps/util/hasOwnProperty.js +++ b/src/deps/util/hasOwnProperty.js @@ -1,6 +1,11 @@ -module.exports = (haystack, needle) => - Object.prototype.hasOwnProperty.call(haystack, needle) +const curry = require('../fp/curry') +const isNill = require('../is/nullOrUndefined') +const hasOwnProperty = require('../native/hasOwnProperty') +const hasOwnPropertyNotNill = (haystack, needle) => + !isNill(haystack) && hasOwnProperty.call(haystack, needle) + +module.exports = curry(2, hasOwnPropertyNotNill) // function(obj, key) { // return key in obj // } diff --git a/src/deps/util/index.js b/src/deps/util/index.js new file mode 100644 index 0000000..37007fa --- /dev/null +++ b/src/deps/util/index.js @@ -0,0 +1 @@ +module.exports = require('./util') diff --git a/src/deps/util/keysObjOrArray.js b/src/deps/util/keysObjOrArray.js new file mode 100644 index 0000000..5c87c72 --- /dev/null +++ b/src/deps/util/keysObjOrArray.js @@ -0,0 +1,53 @@ +const isObj = require('../is/obj') +const isArray = require('../is/array') +const ObjectKeys = require('./keys') +const lengthFromZero = require('./lengthFromZero') + +/** + * Creates an array of the own enumerable property names of `object`. + * **Note:** Non-object values are coerced to objects. See the + * [ES spec](http://ecma-international.org/ecma-262/7.0/#sec-object.keys) + * for more details. + * + * @since 0.1.0 + * @category Object + * @name keysObjOrArray + * + * @param {Object} obj The object to query. + * @return {Array} Returns the array of property names. + * + * @see deps/util/lengthFromZero + * @see deps/util/props + * @see values, valuesIn + * + * {@link https://github.com/lodash/lodash/blob/master/keys.js lodash-keys} + * {@link https://github.com/lodash/lodash/blob/master/.internal/getAllKeys.js lodash-get-all-keys} + * @see {@link lodash-keys} + * @see {@link lodash-get-all-keys} + * + * @TODO https://github.com/lodash/lodash/blob/master/.internal/arrayLikeKeys.js + * + * @example + * + * function Foo() { + * this.a = 1 + * this.b = 2 + * } + * + * Foo.prototype.c = 3 + * + * keys(new Foo) + * // => ['a', 'b'] (iteration order is not guaranteed) + * + * keys('hi') + * // => ['0', '1'] + * + */ +module.exports = function keys(obj) { + return isArray(obj) + ? new Array(lengthFromZero(obj)) + : isObj(obj) ? ObjectKeys(obj) : [] + + // for (var key in obj) gathered.push(key) + // return gathered +} diff --git a/src/deps/util/keywords.js b/src/deps/util/keywords.js new file mode 100644 index 0000000..ad8d83e --- /dev/null +++ b/src/deps/util/keywords.js @@ -0,0 +1,5 @@ +// https://github.com/facebook/immutable-js/blob/master/src/TrieUtils.js#L10 +// Used for setting prototype methods that IE8 chokes on. +// module.exports = { +// 'DELETE': 'delete', +// } diff --git a/src/deps/util/length.js b/src/deps/util/length.js index d7d9907..9c262af 100644 --- a/src/deps/util/length.js +++ b/src/deps/util/length.js @@ -1,2 +1,4 @@ +const prop = require('../fp/prop') + // reduces size by hundreds of bytes gzipped... -module.exports = x => x.length +module.exports = prop('length') diff --git a/src/deps/util/lengthFromZero.js b/src/deps/util/lengthFromZero.js new file mode 100644 index 0000000..d36fe0f --- /dev/null +++ b/src/deps/util/lengthFromZero.js @@ -0,0 +1,29 @@ +/** + * when length > 1, use length-1 + * otherwise, when length == 1, use 0 + * default, use length + * + * @memberOf util + * @since 5.0.0-beta.2 + * @name lengthFromZero + * + * @TODO lense to use an object, or transform it to one with .length? + * const len = prop('length') + * // when isObj, use len, otherwise, value + * const coerceLength = lense([isObj, len]) + * + * @param {Array | Object | number} obj with length + * @return {number} obj length from 0 + * + * @see util/length + * @see util/lengthMinusOne + * + * @example + * + * lengthFromZero([1]) //=> 1 + * lengthFromZero([]) //=> 0 + * lengthFromZero([1, 2, 3]) //=> 2 + * + */ +module.exports = obj => + (obj.length > 1 ? obj.length - 1 : obj.length === 1 ? 1 : 0) diff --git a/src/deps/util/localGlobal.js b/src/deps/util/localGlobal.js new file mode 100644 index 0000000..24b6526 --- /dev/null +++ b/src/deps/util/localGlobal.js @@ -0,0 +1,4 @@ +const isBrowser = require('../is/browser') +const isNode = require('../is/nodejs') + +module.exports = isBrowser() ? window : global diff --git a/src/deps/util/noop.js b/src/deps/util/noop.js new file mode 100644 index 0000000..282fb6b --- /dev/null +++ b/src/deps/util/noop.js @@ -0,0 +1,20 @@ +/** + * @name noop + * + * @func + * @since 5.0.0 + * @return {void} + * + * {@link https://github.com/sindresorhus/noop3 noop3} + * @see {@link noop3} + * + * @example + * + * noop + * + * @example + * + * noop() + * + */ +module.exports = function noop() { /* noop */ } diff --git a/src/deps/util/props.js b/src/deps/util/props.js index e9dbfa6..3276612 100644 --- a/src/deps/util/props.js +++ b/src/deps/util/props.js @@ -8,9 +8,17 @@ const getOwnPropertySymbols = Object.getOwnPropertySymbols * @desc properties, property symbols, object keys * ^ all again for prototype * + * @since 3.0.0 * @param {Object} obj object to get properties & symbols from * @return {Array} properties * + * only used in gc (as of 5.0.0-beta.4) + * @see deps/gc + * @see deps/utils/nonEnumerableTypes + * @see http://2ality.com/2011/07/js-properties.html + * @TODO https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/getOwnPropertyDescriptors + * `const getOwnPropertyDescriptors = Object.getOwnPropertyDescriptors` + * * @example * var obj = {key: true} * allProperties(obj) @@ -28,13 +36,20 @@ const getOwnPropertySymbols = Object.getOwnPropertySymbols * */ function allProperties(obj) { - const proto = getPrototypeOf(obj) - return [].concat( - getOwnPropertyNames(obj), - getOwnPropertySymbols(obj), - ObjectKeys(obj), - proto ? allProperties(proto) : [] - ) + return getOwnPropertyNames(obj).concat(getOwnPropertySymbols(obj)) + + // const result = [] + // for (const prop in obj) result.push(prop) + // return result + + // flatten(getOwnPropertyNames, getOwnPropertySymbols) + // const proto = getPrototypeOf(obj) + // return [].concat( + // getOwnPropertyNames(obj), + // getOwnPropertySymbols(obj) + // // ObjectKeys(obj), + // // proto ? allProperties(proto) : [] + // ) } module.exports = allProperties diff --git a/src/deps/util/simpleKindOf.js b/src/deps/util/simpleKindOf.js index 9cc70f0..f6ba807 100644 --- a/src/deps/util/simpleKindOf.js +++ b/src/deps/util/simpleKindOf.js @@ -6,8 +6,20 @@ const isNull = require('../is/null') * @desc when Array -> 'array' * when null -> 'null' * else `typeof x` - * @param {any} x + * + * @since 4.0.0 + * @param {any} x value for type * @return {string} type + * + * split at space, replace brackets and space, lowercase + * @TODO `type.split(' ').pop().replace(/\s\[\]/g, '').toLowerCase()` + * + * @example + * + * simpleKindOf([]) //=> 'array' + * simpleKindOf(null) //=> 'null' + * simpleKindOf({}) //=> 'object' + * */ module.exports = x => { return isArray(x) diff --git a/src/deps/util/util.js b/src/deps/util/util.js new file mode 100644 index 0000000..960d8e9 --- /dev/null +++ b/src/deps/util/util.js @@ -0,0 +1,45 @@ +const assign = require('./assign') +const flatten = require('./flatten') +const from = require('./from') +const charCodeAtZero = require('./charCodeAtZero') +const getDescriptor = require('./getDescriptor') +const getPrototypeOf = require('./getPrototypeOf') +const hasOwnProperty = require('./hasOwnProperty') +const keys = require('./keys') +const props = require('./props') +const keysObjOrArray = require('./keysObjOrArray') +const keywords = require('./keywords') +const length = require('./length') +const lengthFromZero = require('./lengthFromZero') +const lengthMinusOne = require('./lengthMinusOne') +const localGlobal = require('./localGlobal') +const nonEnumerableTypes = require('./nonEnumerableTypes') +const noop = require('./noop') +const simpleKindOf = require('./simpleKindOf') +const _typeof = require('./typeof') + +/** + * @member util + * @type {Object} + */ +module.exports = { + assign, + flatten, + from, + charCodeAtZero, + getDescriptor, + getPrototypeOf, + hasOwnProperty, + keys, + props, + keysObjOrArray, + keywords, + 'len': length, + lengthFromZero, + lengthMinusOne, + localGlobal, + nonEnumerableTypes, + noop, + simpleKindOf, + 'typeof': _typeof, +} diff --git a/src/deps/validators/schemaBuilder.js b/src/deps/validators/schemaBuilder.js index 95e095e..2fb55ff 100644 --- a/src/deps/validators/schemaBuilder.js +++ b/src/deps/validators/schemaBuilder.js @@ -1,20 +1,9 @@ const ENV_DEVELOPMENT = require('../env/dev') const dotPropPaths = require('../dot/paths') const dotGet = require('../dot/get') -const isStringOrNumber = require('../is/stringOrNumber') -const isReal = require('../is/real') -const isBoolean = require('../is/boolean') -const isRegExp = require('../is/regexp') -const isError = require('../is/error') +const isNotNested = require('../is/notNested') const validationBuilder = require('./validatorBuilder') -const isNotNested = x => - isStringOrNumber(x) || - isBoolean(x) || - !isReal(x) || - isError(x) || - isRegExp(x) - const validateType = (type, value, nestedSchema) => { const validator = nestedSchema || validationBuilder(type) return validator(value) diff --git a/src/deps/validators/validatorBuilder.js b/src/deps/validators/validatorBuilder.js index 345a8ae..da3be32 100644 --- a/src/deps/validators/validatorBuilder.js +++ b/src/deps/validators/validatorBuilder.js @@ -8,21 +8,20 @@ const ChainedMap = require('../../ChainedMapBase') const ENV_DEBUG = require('../env/debug') const is = require('../is') -const isArray = require('../is/array') -const isReal = require('../is/real') const isString = require('../is/string') const isFunction = require('../is/function') const dopemerge = require('../dopemerge') -const camelCase = require('../camel-case') +const camelCase = require('../string/camelCase') const not = require('../conditional/not') -const and = require('../conditional/and') const or = require('../conditional/or') -const all = require('../conditional/all') +const isArrayOf = require('../is/arrayOf') +const isNotRealOrIsEmpty = require('../is/notRealOrIsEmpty') +const replace = require('../fp/replace') let validators = new ChainedMap() // eslint-disable-next-line -const stripArithmeticSymbols = x => x.replace(/[?\[\]!\|]/g, '') +const stripArithmeticSymbols = replace(/[?\[\]!\|]/g, '') const escapedKey = x => camelCase('is-' + x) const enummy = enums => x => enums === x || enums.includes(x) @@ -77,15 +76,6 @@ const addTypes = types => addTypes(is) -// ---- -// @NOTE: putting these as functions increased size 20 bytes: worth it -// ---- - -// @SIZE: another 10bytes for these fns -const isNotRealOrIsEmptyString = and(not(isReal), x => x === '') - -// const isArrayOf = predicate => x => isArray(x) && x.every(predicate) -const isArrayOf = predicate => and(isArray, all(predicate)) const includesAndOr = x => x.includes('|') || x.includes('&') /** @@ -186,7 +176,7 @@ function arithmeticTypeFactory(fullKey) { const typeOrArrayOrType = `${key}[]` const notType = `!${key}` - const isValidOrNotRealOrEmptyStr = or(fn, isNotRealOrIsEmptyString) + const isValidOrNotRealOrEmptyStr = or(fn, isNotRealOrIsEmpty) const isValidOrArrayOfValid = or(fn, isArrayOf(fn)) if (doesNotHave(optionalType)) { set(optionalType, isValidOrNotRealOrEmptyStr) diff --git a/src/index.js b/src/index.js index d5df80e..7e08b88 100644 --- a/src/index.js +++ b/src/index.js @@ -13,11 +13,12 @@ const FactoryChain = require('./FactoryChain') const MethodChain = require('./MethodChain') // composer const compose = require('./compose') +const construct = require('./deps/fp/construct') // export const exp = compose() -exp.chainable = parent => new exp(parent) -exp.builder = obj => new MethodChain(obj) +exp.chainable = construct(1, exp) +exp.builder = construct(1, MethodChain) exp.Chain = exp exp.compose = compose @@ -26,7 +27,7 @@ exp.traverse = traverse exp.addMethodFactories = MethodChain.add exp.toArr = require('./deps/to-arr') // exp.toarr = -exp.camelCase = require('./deps/camel-case') +exp.camelCase = require('./deps/string/camelCase') exp.dot = require('./deps/dot') exp.matcher = require('./deps/matcher') exp.reduce = require('./deps/reduce') @@ -34,6 +35,9 @@ exp.clean = require('./deps/reduce/clean') exp.meta = require('./deps/meta') exp.eq = require('./deps/traversers/eq') exp.types = require('./deps/validators') +exp.encase = require('./deps/encase') +exp.curry = require('./deps/fp/curry') +exp.replace = require('./deps/fp/replace') exp.addTypes = exp.types.addTypes diff --git a/src/plugins/schema.js b/src/plugins/schema.js index 6a7b985..ff9d73c 100644 --- a/src/plugins/schema.js +++ b/src/plugins/schema.js @@ -43,10 +43,7 @@ module.exports = function schema(obj) { const key = keys[k] const value = obj[key] - // parent.method - // ? parent.method(key) - // : - // + // parent.method ? parent.method(key) : let builder = this.newThis().name(key) // MethodChain // @TODO: PLUCK METHOD FOR USING VALID KEYS diff --git a/test/TraverseChain.js b/test/TraverseChain.js index 76d766c..8ab9c22 100644 --- a/test/TraverseChain.js +++ b/test/TraverseChain.js @@ -1,5 +1,5 @@ const log = require('fliplog') -const {Chain, matcher} = require('../src') +const {Chain, matcher, isNumber} = require('../src') const TraverseChain = require('../src/TraverseChain') test('traversal with function callback for vals and keys', () => { @@ -109,6 +109,7 @@ test('.traverse(true)', () => { }, matchme: 'minime', notme: 'eh', + num: 100, }, }, } @@ -119,7 +120,7 @@ test('.traverse(true)', () => { .merge(eh) .traverse(true) .keys([/super/, /parser/, /store/, /meta/, /className/]) - .vals([/minime/]) + .vals([/minime/, isNumber]) .call(true) expect(cleaned).toEqual({ diff --git a/test/_traverse.js b/test/_traverse.js index 6225f63..b129d0f 100644 --- a/test/_traverse.js +++ b/test/_traverse.js @@ -6,10 +6,33 @@ const log = require('fliplog') const traverse = require('../src/deps/traverse') const isArray = require('../src/deps/is/array') const isObj = require('../src/deps/is/obj') +const isNumber = require('../src/deps/is/number') +const isReal = require('../src/deps/is/real') -const {eq} = traverse +const {eq, copy} = traverse const deepEqual = eq +test('pre-copy eq to themselves invariant for environment', () => { + const date = new Date(0, 0, 0, 0) + expect(date).toBe(date) + + const error = new Error('ehror') + expect(error).toBe(error) + + const regexp = new RegExp('../', 'gmi') + expect(regexp).toBe(regexp) +}) +test('copy', () => { + const date = new Date(0, 0, 0, 0) + expect(copy(date)).not.toBe(date) + + const error = new Error('ehror') + expect(copy(error)).not.toBe(error) + + const regexp = new RegExp('../', 'gmi') + expect(copy(regexp)).not.toBe(regexp) +}) + test('deepDates', () => { expect.assertions(2) @@ -349,8 +372,8 @@ test('stringify', () => { // console.log('before', t.key, t.path.join(''), '\n\n') // s += '\nbefore\n' - if (isArray(t.iteratee)) s += '[' - else if (isObj(t.iteratee)) s += '{' + if (isArray(t.node)) s += '[' + else if (isObj(t.node)) s += '{' }) trav.pre(traverser => { @@ -358,7 +381,7 @@ test('stringify', () => { // console.log('pre', traverser.key, traverser.path.join(''), '\n\n') const key = traverser.key || traverser.path.join('') - if (key && isObj(traverser.iteratee) && !isArray(traverser.iteratee)) { + if (key && isObj(traverser.node) && !isArray(traverser.node)) { s += '"' + key + '"' + ':' } }) @@ -367,8 +390,8 @@ test('stringify', () => { // console.log('after') if (s.endsWith(',')) s = s.slice(0, -1) // s += '\nafter\n' - if (isArray(t.iteratee)) s += ']' - else if (isObj(t.iteratee)) s += '}' + if (isArray(t.node)) s += ']' + else if (isObj(t.node)) s += '}' }) trav.post(child => { // console.log('post', child) @@ -486,6 +509,44 @@ test('stop', () => { // expect(acc.join(' ')).toEqual('9 30 22') // }) +// ----- remove +test('traverse no argument', () => { + traverse().forEach(() => {}) +}) + +test('remove arr', () => { + traverse([]).forEach((key, val, it) => {}) + + const arr = [0] + traverse(arr).forEach((key, val, it) => it.remove()) + expect(arr.filter(isReal)).toEqual([]) + + let arrString = [0, 100, 10, 100, 'not number', 200, 1000] + traverse(arrString).forEach((key, val, it) => { + log.bold(key).data(val).echo() + if (isNumber(val)) it.remove() + }) + + expect(arrString.filter(isReal)).toEqual(['not number']) +}) + +test('remove obj', () => { + const emptyObj = {} + traverse(emptyObj).forEach((key, val, it) => {}) + expect(emptyObj).toEqual(emptyObj) + + const obj = {eh: true} + traverse(obj).forEach((key, val, it) => it.remove()) + expect(obj).toEqual({}) + + const objNumber = {eh: true, num: 100} + traverse(objNumber).forEach((key, val, it) => { + if (!isNumber(val)) it.remove() + }) + + expect(objNumber).toEqual({num: 100}) +}) + // --- leaves.js test('leaves test', () => { var acc = [] @@ -613,15 +674,15 @@ test.skip('circClone - @FIXME', () => { console.log(clone.x[3][2] !== obj) }) -// test('circMapScrub', () => { -// var obj = {a: 1, b: 2} -// obj.c = obj -// -// var scrubbed = traverse(obj).map(function(node) { -// if (this.circular) this.remove() -// }) -// expect(Object.keys(scrubbed).sort()).toEqual(['a', 'b']) -// expect(deepEqual(scrubbed, {a: 1, b: 2}, true)).toBeTruthy() -// -// expect(deepEqual(obj.c, obj, true)).toBeTruthy() -// }) +test.skip('circMapScrub', () => { + var obj = {a: 1, b: 2} + obj.c = obj + + var scrubbed = traverse(obj).map(function(node) { + if (this.circular) this.remove() + }) + expect(Object.keys(scrubbed).sort()).toEqual(['a', 'b']) + expect(deepEqual(scrubbed, {a: 1, b: 2}, true)).toBeTruthy() + + expect(deepEqual(obj.c, obj, true)).toBeTruthy() +}) diff --git a/test/deps/_mergedopemaps.js b/test/deps/_mergedopemaps.js new file mode 100644 index 0000000..684ca61 --- /dev/null +++ b/test/deps/_mergedopemaps.js @@ -0,0 +1,15 @@ +const dopemergeMap = require('../../src/deps/dopemerge/map') + +test.skip('dopemerge map & set', () => { + // test + var targetMap = new Map() + targetMap.set('true', false) + targetMap.set('obj', {obj: []}) + targetMap.set('arr', [1]) + var srcMap = new Map() + srcMap.set('true', true) + srcMap.set('obj', {obj: [Symbol]}) + srcMap.set('arr', [2]) + srcMap.set('emptyArr', []) + var mergedMap = dopemergeMap(targetMap, srcMap, {clone: true}) +}) diff --git a/test/deps/camelcase.js b/test/deps/camelcase.js index 385b91a..5a0551a 100644 --- a/test/deps/camelcase.js +++ b/test/deps/camelcase.js @@ -1,6 +1,6 @@ // https://github.com/substack/camelize/blob/master/test/camel.js -const log = require('fliplog'); -const camelize = require('../../src/deps/camel-case') +const log = require('fliplog') +const camelize = require('../../src/deps/string/camelCase') test('camelCase', () => { expect(camelize('one two') == 'oneTwo').toBe(true) diff --git a/test/deps/escape.js b/test/deps/escape.js new file mode 100644 index 0000000..d68a89e --- /dev/null +++ b/test/deps/escape.js @@ -0,0 +1,7 @@ +const escapeStringRegExp = require('../../src/deps/matcher/escape-string-regex') + +test('excape string regexp', () => { + const actual = escapeStringRegExp('\\ ^ $ * + ? . ( ) | { } [ ]') + const escaped = '\\\\ \\^ \\$ \\* \\+ \\? \\. \\( \\) \\| \\{ \\} \\[ \\]' + expect(actual).toEqual(escaped) +}) diff --git a/test/deps/pooler.js b/test/deps/pooler.js new file mode 100644 index 0000000..1cb5d5a --- /dev/null +++ b/test/deps/pooler.js @@ -0,0 +1,55 @@ +const addPoolingTo = require('../../src/deps/cache/pooler') +const isFunction = require('../../src/deps/is/function') +const isArray = require('../../src/deps/is/array') +const isNumber = require('../../src/deps/is/number') + +test('pooling', () => { + // expect.assertions(5) + let count = 0 + + function Eh() { + this.count = this.count || count + count = count + 1 + this.canada = true + } + + // expect this is called + Eh.prototype.destructor = function() { + this.canada = undefined + // expect(this.canada).toBe(undefined) + } + + addPoolingTo(Eh) + + expect(isFunction(Eh.release)).toBe(true) + expect(isFunction(Eh.getPooled)).toBe(true) + expect(isArray(Eh.instancePool)).toBe(true) + expect(isNumber(Eh.poolSize)).toBe(true) + + const eh = Eh.getPooled() + const eh2 = Eh.getPooled() + expect(Eh.instancePool.length).toBe(0) + + // back into the pool + Eh.release(eh) + expect(Eh.instancePool.length).toBe(1) + + // again + Eh.release(eh2) + expect(Eh.instancePool.length).toBe(2) + + // back out of the pool + const eh3 = Eh.getPooled() + expect(Eh.instancePool.length).toBe(1) + expect(eh3 instanceof Eh).toBe(true) + + Eh.release(eh3) + + // we used 3 times + expect(count).toBe(3) + + // but we actually created only 2 of them + // usually we would not leave leftover props, but this is for the test + expect(Eh.instancePool[0].count).toBe(0) + expect(Eh.instancePool[1].count).toBe(1) +}) diff --git a/test/fp/always.js b/test/fp/always.js new file mode 100644 index 0000000..74451ac --- /dev/null +++ b/test/fp/always.js @@ -0,0 +1,18 @@ +const always = require('../../src/deps/fp/always') + +test('works with various types', function() { + expect(always(false)()).toEqual(false) + expect(always('abc')()).toEqual('abc') + + expect(always({a: 1, b: 2})()).toEqual({a: 1, b: 2}) + + var obj = {a: 1, b: 2} + expect(always(obj)()).toEqual(obj) + + var now = new Date(1776, 6, 4) + expect(always(now)()).toEqual(now) + + expect(always(undefined)()).toEqual(undefined) + expect(always(null)()).toEqual(null) + expect(always(100)()).toEqual(100) +}) diff --git a/test/fp/construct.js b/test/fp/construct.js new file mode 100644 index 0000000..3dfd779 --- /dev/null +++ b/test/fp/construct.js @@ -0,0 +1,106 @@ +const construct = require('../../src/deps/fp/construct') + +const eq = (a, b) => expect(a).toEqual(b) + +describe('construct', function() { + const Rectangle = function(w, h) { this.width = w; this.height = h } + Rectangle.prototype.area = function() { return this.width * this.height } + + it('turns a constructor function into one that can be called without `new`', function() { + const rect = construct(Rectangle) + const r1 = rect(3, 4) + eq(r1.constructor, Rectangle) + eq(r1.width, 3) + eq(r1.area(), 12) + + const regex = construct(RegExp) + const word = regex('word', 'gi') + eq(word.constructor, RegExp) + eq(word.source, 'word') + eq(word.global, true) + }) + + it('can be used to create Date object', function() { + const date = construct(Date)(1984, 3, 26, 0, 0, 0, 0) + eq(date.constructor, Date) + eq(date.getFullYear(), 1984) + }) + + it('supports constructors with no arguments', function() { + function Foo() {} + const foo = construct(Foo)() + eq(foo.constructor, Foo) + }) + + it.skip('does not support constructor with greater than ten arguments', function() { + const over10 = function() { + function Foo($0, $1, $2, $3, $4, $5, $6, $7, $8, $9, $10) { + this.eleventh = $10 + } + construct(Foo) + } + expect(over10).toThrow(/Constructor with greater than ten arguments/) + }) + + it('returns a curried function', function() { + const rect = construct(Rectangle) + const rect3 = rect(3) + const r1 = rect3(4) + eq(r1.constructor, Rectangle) + eq(r1.width, 3) + eq(r1.height, 4) + eq(r1.area(), 12) + + const regex = construct(RegExp) + const word = regex('word') + const complete = word('gi') + eq(complete.constructor, RegExp) + eq(complete.source, 'word') + eq(complete.global, true) + }) +}) + +describe('constructN', function() { + const Circle = function(r) { + this.r = r + this.colors = Array.prototype.slice.call(arguments, 1) + } + Circle.prototype.area = function() { return Math.PI * Math.pow(this.r, 2) } + + it('turns a constructor function into a function with n arguments', function() { + const circle = construct(2, Circle) + const c1 = circle(1, 'red') + eq(c1.constructor, Circle) + eq(c1.r, 1) + eq(c1.area(), Math.PI) + eq(c1.colors, ['red']) + + const regex = construct(1, RegExp) + const pattern = regex('[a-z]') + eq(pattern.constructor, RegExp) + eq(pattern.source, '[a-z]') + }) + + it('can be used to create Date object', function() { + const date = construct(3, Date)(1984, 3, 26) + eq(date.constructor, Date) + eq(date.getFullYear(), 1984) + }) + + it('supports constructors with no arguments', function() { + function Foo() {} + const foo = construct(0, Foo)() + eq(foo.constructor, Foo) + }) + + // is not curried + it.skip('is curried', function() { + function G(a, b, c) { this.a = a; this.b = b; this.c = c } + const construct2 = construct(2) + eq(typeof construct2, 'function') + const g2 = construct2(G) + eq(typeof g2, 'function') + eq(g2('a', 'b').constructor, G) + eq(g2('a')('b').constructor, G) + }) +}) diff --git a/test/fp/curry.js b/test/fp/curry.js new file mode 100644 index 0000000..65eb66d --- /dev/null +++ b/test/fp/curry.js @@ -0,0 +1,113 @@ +var curryN = require('../../src/deps/fp/curry') + +describe('curryN', function() { + function source(a, b, c, d) { + void d + return a * b * c + } + it('accepts an arity', function() { + var curried = curryN(3, source) + expect(curried(1)(2)(3)).toEqual(6) + expect(curried(1, 2)(3)).toEqual(6) + expect(curried(1)(2, 3)).toEqual(6) + expect(curried(1, 2, 3)).toEqual(6) + }) + + it.skip('can be partially applied', function() { + var curry3 = curryN(3) + var curried = curry3(source) + expect(curried.length, 3) + expect(curried(1)(2)(3)).toEqual(6) + expect(curried(1, 2)(3)).toEqual(6) + expect(curried(1)(2, 3)).toEqual(6) + expect(curried(1, 2, 3)).toEqual(6) + }) + + it('preserves context', function() { + var ctx = {x: 10} + var f = function(a, b) { + return a + b * this.x + } + var g = curryN(2, f) + + expect(g.call(ctx, 2, 4)).toEqual(42) + expect(g.call(ctx, 2).call(ctx, 4)).toEqual(42) + }) + + it('supports R.__ placeholder', function() { + var f = function() { + return Array.from(arguments) + } + var g = curryN(3, f) + var _ = '_' // R.__ + + expect(g(1)(2)(3)).toEqual([1, 2, 3]) + expect(g(1)(2, 3)).toEqual([1, 2, 3]) + expect(g(1, 2)(3)).toEqual([1, 2, 3]) + expect(g(1, 2, 3)).toEqual([1, 2, 3]) + + expect(g(_, 2, 3)(1)).toEqual([1, 2, 3]) + expect(g(1, _, 3)(2)).toEqual([1, 2, 3]) + expect(g(1, 2, _)(3)).toEqual([1, 2, 3]) + + expect(g(1, _, _)(2)(3)).toEqual([1, 2, 3]) + expect(g(_, 2, _)(1)(3)).toEqual([1, 2, 3]) + expect(g(_, _, 3)(1)(2)).toEqual([1, 2, 3]) + + expect(g(1, _, _)(2, 3)).toEqual([1, 2, 3]) + expect(g(_, 2, _)(1, 3)).toEqual([1, 2, 3]) + expect(g(_, _, 3)(1, 2)).toEqual([1, 2, 3]) + + expect(g(1, _, _)(_, 3)(2)).toEqual([1, 2, 3]) + expect(g(_, 2, _)(_, 3)(1)).toEqual([1, 2, 3]) + expect(g(_, _, 3)(_, 2)(1)).toEqual([1, 2, 3]) + + expect(g(_, _, _)(_, _)(_)(1, 2, 3)).toEqual([1, 2, 3]) + expect(g(_, _, _)(1, _, _)(_, _)(2, _)(_)(3)).toEqual([1, 2, 3]) + }) + + it('supports @@functional/placeholder', function() { + var f = function() { + return Array.from(arguments) + } + var g = curryN(3, f) + var _ = '_' //{'@@functional/placeholder': true, 'x': Math.random()} + + expect(g(1)(2)(3)).toEqual([1, 2, 3]) + expect(g(1)(2, 3)).toEqual([1, 2, 3]) + expect(g(1, 2)(3)).toEqual([1, 2, 3]) + expect(g(1, 2, 3)).toEqual([1, 2, 3]) + + expect(g(_, 2, 3)(1)).toEqual([1, 2, 3]) + expect(g(1, _, 3)(2)).toEqual([1, 2, 3]) + expect(g(1, 2, _)(3)).toEqual([1, 2, 3]) + + expect(g(1, _, _)(2)(3)).toEqual([1, 2, 3]) + expect(g(_, 2, _)(1)(3)).toEqual([1, 2, 3]) + expect(g(_, _, 3)(1)(2)).toEqual([1, 2, 3]) + + expect(g(1, _, _)(2, 3)).toEqual([1, 2, 3]) + expect(g(_, 2, _)(1, 3)).toEqual([1, 2, 3]) + expect(g(_, _, 3)(1, 2)).toEqual([1, 2, 3]) + + expect(g(1, _, _)(_, 3)(2)).toEqual([1, 2, 3]) + expect(g(_, 2, _)(_, 3)(1)).toEqual([1, 2, 3]) + expect(g(_, _, 3)(_, 2)(1)).toEqual([1, 2, 3]) + + expect(g(_, _, _)(_, _)(_)(1, 2, 3)).toEqual([1, 2, 3]) + expect(g(_, _, _)(1, _, _)(_, _)(2, _)(_)(3)).toEqual([1, 2, 3]) + }) + + it('forwards extra arguments', function() { + var f = function() { + return Array.from(arguments) + } + var g = curryN(3, f) + + expect(g(1, 2, 3)).toEqual([1, 2, 3]) + expect(g(1, 2, 3, 4)).toEqual([1, 2, 3, 4]) + expect(g(1, 2)(3, 4)).toEqual([1, 2, 3, 4]) + expect(g(1)(2, 3, 4)).toEqual([1, 2, 3, 4]) + expect(g(1)(2)(3, 4)).toEqual([1, 2, 3, 4]) + }) +}) diff --git a/test/fp/firstLast.js b/test/fp/firstLast.js new file mode 100644 index 0000000..bfbda97 --- /dev/null +++ b/test/fp/firstLast.js @@ -0,0 +1,32 @@ +const log = require('fliplog') +const isFunction = require('../../src/deps/is/function') +const findLast = require('../../src/deps/fp/last') +const findLastIndex = require('../../src/deps/fp/lastIndex') +const findFirst = require('../../src/deps/fp/first') + +test('can find last & last index in array', () => { + expect(isFunction(findLast)).toBe(true) + expect(isFunction(findLastIndex)).toBe(true) + + const array = [0, 1, 2, 3] + const index = findLastIndex(array) + const last = findLast(array) + + expect(array[index]).toEqual(last) + expect(index).toBe(3) +}) + +test('can find last & last index in object', () => { + const obj = {0: 0, 1: 1, 2: 2, 3: 3} + const index = findLastIndex(obj) + const last = findLast(obj) + + expect(obj[index]).toEqual(last) + expect(index).toBe('3') +}) + +test('can find first', () => { + const array = [0, 1, 2, 3] + const first = findFirst(array) + expect(first).toEqual(0) +}) diff --git a/test/fp/flip.js b/test/fp/flip.js new file mode 100644 index 0000000..810a209 --- /dev/null +++ b/test/fp/flip.js @@ -0,0 +1,23 @@ +const flip = require('../../src/deps/fp/flip') + +function threeArgs(one, two, three) { + return [one, two, three] +} + +test('flips fosho', function() { + const oneTwoThree = function($1, $2, $3) { + const flipped = flip(threeArgs) + const actual = flipped($1, $2, $3) + const usual = threeArgs($1, $2, $3) + + // flipped 1 & 2 (same as .slice.reverse) + // expect(actual[0]).toEqual(usual[1]) + // expect(actual[1]).toEqual(usual[2]) + + // only flips 2 <- disabled this + // expect(actual[2]).toEqual(usual[2]) + expect(actual.reverse()).toEqual(usual) + } + + oneTwoThree(1, 2, 3) +}) diff --git a/test/fp/flip2.js b/test/fp/flip2.js new file mode 100644 index 0000000..906fb33 --- /dev/null +++ b/test/fp/flip2.js @@ -0,0 +1,33 @@ +const flip2 = require('../../src/deps/fp/flip2') + +function threeArgs(one, two, three) { + return [one, two, three] +} + +test('returns a function which inverts the first two arguments to the supplied function', function() { + const f = function(a, b, c) { return a + ' ' + b + ' ' + c } + const g = flip2(f) + expect(f('a', 'b', 'c')).toEqual('a b c') + expect(g('a', 'b', 'c')).toEqual('b a c') +}) +test('returns a curried function', function() { + const f = function(a, b, c) { return a + ' ' + b + ' ' + c } + const g = flip2(f)('a') + expect(g('b', 'c')).toEqual('b a c') +}) +test('flip2 fosho', function() { + const oneTwoThree = function($1, $2, $3) { + const flipped = flip2(threeArgs) + const actual = flipped($1, $2, $3) + const usual = threeArgs($1, $2, $3) + + // flipped 1 & 2 (same as .slice.reverse) + expect(actual[0]).toEqual(usual[1]) + expect(actual[1]).toEqual(usual[0]) + + // only flips 2 <- disabled this + // expect(actual[2]).toEqual(usual[2]) + } + + oneTwoThree(1, 2, 3) +}) diff --git a/test/fp/path.js b/test/fp/path.js new file mode 100644 index 0000000..8b3749a --- /dev/null +++ b/test/fp/path.js @@ -0,0 +1,47 @@ +var eq = (actual, expected) => expect(actual).toEqual(expected) +var path = require('../../src/deps/fp/path') + +describe('path', function() { + var deepObject = {a: {b: {c: 'c'}}, falseVal: false, nullVal: null, undefinedVal: undefined, arrayVal: ['arr']} + it('takes a path and an object and returns the value at the path or undefined', function() { + var obj = { + a: { + b: { + c: 100, + d: 200, + }, + e: { + f: [100, 101, 102], + g: 'G', + }, + h: 'H', + }, + i: 'I', + j: ['J'], + } + eq(path(['a', 'b', 'c'], obj), 100) + eq(path([], obj), obj) + eq(path(['a', 'e', 'f', 1], obj), 101) + eq(path(['j', 0], obj), 'J') + eq(path(['j', 1], obj), undefined) + }) + + it('gets a deep property\'s value from objects', function() { + eq(path(['a', 'b', 'c'], deepObject), 'c') + eq(path(['a'], deepObject), deepObject.a) + }) + + it('returns undefined for items not found', function() { + eq(path(['a', 'b', 'foo'], deepObject), undefined) + eq(path(['bar'], deepObject), undefined) + eq(path(['a', 'b'], {a: null}), undefined) + }) + + it('works with falsy items', function() { + eq(path(['toString'], false), Boolean.prototype.toString) + }) + + it('is curried', function() { + eq(path(['arrayVal', '0'])(deepObject), 'arr') + }) +}) diff --git a/test/fp/pipe.js b/test/fp/pipe.js new file mode 100644 index 0000000..1333d27 --- /dev/null +++ b/test/fp/pipe.js @@ -0,0 +1,63 @@ +const assert = require('assert') +const isFunction = require('../../src/deps/is/function') +const pipe = require('../../src/deps/fp/pipeTwo') +const pipeAll = require('../../src/deps/fp/pipe') + +describe('pipe', function() { + it('is in correct order', function() { + function x(val) { + return val + 'x' + } + function y(val) { + return val + 'y' + } + function z(val) { + return val + 'z' + } + + expect(pipeAll(x, y, z)('w')).toBe('wxyz') + }) + it('is a variadic function', function() { + expect(isFunction(pipe)).toBe(true) + expect(isFunction(pipeAll)).toBe(true) + + // is a smaller version just 2 args + // expect(pipe.length).toBe(0) + }) + + it('passes context to functions', function() { + function x(val) { + return this.x * val + } + function y(val) { + return this.y * val + } + function z(val) { + return this.z * val + } + var context = { + a: pipe(pipe(x, y), z), + x: 4, + y: 2, + z: 1, + } + expect(context.a(5)).toBe(40) + }) + + it.skip('throws if given no arguments', function() { + assert.throws( + function() { pipe() }, + function(err) { + return err.constructor === Error && + err.message === 'pipe requires at least one argument' + } + ) + }) + + it('can be applied to one argument, (with 2 fns)', function() { + var f = function(a, b, c) { return [a, b, c] } + var g = pipe(f, x => x) + // expect(g.length).toEqual(3) + expect(g(1, 2, 3)).toEqual([1, 2, 3]) + }) +}) diff --git a/test/fp/remove.js b/test/fp/remove.js new file mode 100644 index 0000000..78b06d2 --- /dev/null +++ b/test/fp/remove.js @@ -0,0 +1,25 @@ +const remove = require('../../src/deps/fp/remove') +const stress = require('../_stress') + +test('can remove obj and arr', function() { + expect(typeof remove).toBe('function') + + const arr = [0, 1, 2] + remove(arr, 0) + expect(arr.length).toBe(2) + expect(arr).toEqual([1, 2]) + + const obj = {0: 0, 1: 1, 2: 2} + remove(obj, 0) + expect(Object.keys(obj).length).toBe(2) + expect(Object.values(obj)).toEqual([1, 2]) + + + // and handles stress + // cannot handle this yet, because of `Array` + // stress(obj => + // stress(key => + // remove(obj, key) + // ) + // ) +}) diff --git a/test/fp/replace.js b/test/fp/replace.js new file mode 100644 index 0000000..8c273f6 --- /dev/null +++ b/test/fp/replace.js @@ -0,0 +1,18 @@ +const replace = require('../../src/deps/fp/replace') + +test('replaces substrings of the input string', () => { + expect(replace('1', 'one', '1 two three')).toEqual('one two three') +}) + +test('replaces regex matches of the input string', () => { + expect(replace(/\d+/g, 'num', '1 2 three')).toEqual('num num three') +}) + +test('is curried up to 3 arguments', () => { + expect(replace('').constructor, Function) + expect(replace('', '').constructor, Function) + + var replaceSemicolon = replace(';') + var removeSemicolon = replaceSemicolon('') + expect(removeSemicolon('return 42;')).toEqual('return 42') +}) diff --git a/test/fp/reverse.js b/test/fp/reverse.js new file mode 100644 index 0000000..35ad7f8 --- /dev/null +++ b/test/fp/reverse.js @@ -0,0 +1,17 @@ +var reverse = require('../../src/deps/fp/reverse') + +var eq = (x, y) => expect(x).toEqual(y) + +test('reverses arrays', function() { + eq(reverse([]), []) + eq(reverse([1]), [1]) + eq(reverse([1, 2]), [2, 1]) + eq(reverse([1, 2, 3]), [3, 2, 1]) +}) + +test('reverses strings', function() { + eq(reverse(''), '') + eq(reverse('a'), 'a') + eq(reverse('ab'), 'ba') + eq(reverse('abc'), 'cba') +}) diff --git a/test/is/empty.js b/test/is/empty.js new file mode 100644 index 0000000..eff5985 --- /dev/null +++ b/test/is/empty.js @@ -0,0 +1,49 @@ +const isEmpty = require('../../src/deps/is/empty') + +test('returns false for null', function() { + expect(isEmpty(null)).toBe(false) +}) + +test('returns false for undefined', function() { + expect(isEmpty(undefined)).toBe(false) +}) + +test('returns true for empty string', function() { + console.log(isEmpty(''), isEmpty(''), isEmpty('')) + expect(isEmpty('')).toBe(true) + expect(isEmpty(' ')).toBe(false) +}) + +test('returns true for empty array', function() { + expect(isEmpty([])).toBe(true) + // expect(isEmpty([[]])).toBe(false) +}) + +test('returns true for empty object', function() { + expect(isEmpty({})).toBe(true) + expect(isEmpty({x: 0})).toBe(false) +}) + +test('returns true for empty arguments object', function() { + expect( + isEmpty( + (function() { + return arguments + })() + ) + ).toBe(true) + + expect( + isEmpty( + (function() { + return arguments + })(0) + ) + ).toBe(false) +}) + +test('returns false for every other value', function() { + expect(isEmpty(0)).toBe(false) + expect(isEmpty(NaN)).toBe(false) + expect(isEmpty([''])).toBe(false) +}) diff --git a/test/is/is.js b/test/is/is.js index 5dbd020..7ea6d3a 100644 --- a/test/is/is.js +++ b/test/is/is.js @@ -6,13 +6,7 @@ const isAsyncish = require('../../src/deps/is/asyncish') const isNative = require('../../src/deps/is/native') const ObjectDefine = require('../../src/deps/define') const stress = require('../_stress') -const { - isMap, - isSet, - isFunction, - isObjWithKeys, - isPrototypeOf, -} = require('./') +const {isMap, isSet, isFunction, isObjWithKeys, isPrototypeOf} = require('./') test('stress', () => { stress() @@ -124,7 +118,7 @@ test('objWithKeys', () => { test('isPrototypeOf', () => { class SuperProto {} class SubProto extends SuperProto {} - var sub = new SubProto() + const sub = new SubProto() // SuperProto.isPrototypeOf(sub) expect(isPrototypeOf(Object.getPrototypeOf(sub), sub)).toBe(true) @@ -139,7 +133,7 @@ test('isPrototypeOf on instance', () => { enumerable: false, value: instance => isPrototypeOf(SubProto.prototype, instance), }) - var sub = new SubProto() + const sub = new SubProto() expect(new RegExp() instanceof SubProto).toBe(false) expect(sub instanceof SubProto).toBe(true) diff --git a/test/is/json.js b/test/is/json.js new file mode 100644 index 0000000..19dba4f --- /dev/null +++ b/test/is/json.js @@ -0,0 +1,88 @@ +var isJSON = require('../../src/deps/is/JSON') + +var jsun = `{ + "links": { + "self": "http://example.com/articles", + "next": "http://example.com/articles?page[offset]=2", + "last": "http://example.com/articles?page[offset]=10" + }, + "data": [{ + "type": "articles", + "id": "1", + "attributes": { + "title": "JSON API paints my bikeshed!" + }, + "relationships": { + "author": { + "links": { + "self": "http://example.com/articles/1/relationships/author", + "related": "http://example.com/articles/1/author" + }, + "data": { "type": "people", "id": "9" } + }, + "comments": { + "links": { + "self": "http://example.com/articles/1/relationships/comments", + "related": "http://example.com/articles/1/comments" + }, + "data": [ + { "type": "comments", "id": "5" }, + { "type": "comments", "id": "12" } + ] + } + }, + "links": { + "self": "http://example.com/articles/1" + } + }], + "included": [{ + "type": "people", + "id": "9", + "attributes": { + "first-name": "Dan", + "last-name": "Gebhardt", + "twitter": "dgeb" + }, + "links": { + "self": "http://example.com/people/9" + } + }, { + "type": "comments", + "id": "5", + "attributes": { + "body": "First!" + }, + "relationships": { + "author": { + "data": { "type": "people", "id": "2" } + } + }, + "links": { + "self": "http://example.com/comments/5" + } + }, { + "type": "comments", + "id": "12", + "attributes": { + "body": "I like XML better" + }, + "relationships": { + "author": { + "data": { "type": "people", "id": "9" } + } + }, + "links": { + "self": "http://example.com/comments/12" + } + }] +}` + +test('isJSON', () => { + expect(isJSON(jsun)).toBe(true) + expect(isJSON('[{}]')).toBe(true) + + expect(isJSON({json: false})).toBe(false) + expect(isJSON([{a: [1]}])).toBe(false) + expect(isJSON('{malformed: {true}, oops},')).toBe(false) + expect(isJSON('{malformed: {true}, oops}')).toBe(false) +}) diff --git a/test/is/not-exported-in-entry.js b/test/is/not-exported-in-entry.js new file mode 100644 index 0000000..f588a52 --- /dev/null +++ b/test/is/not-exported-in-entry.js @@ -0,0 +1,134 @@ +const isUndefinedLike = require('../../src/deps/is/undefinedLike') +const isBrowser = require('../../src/deps/is/browser') +const isCircular = require('../../src/deps/is/circular') +const isTrue = require('../../src/deps/is/true') +const isNumber = require('../../src/deps/is/number') +const isArrayOf = require('../../src/deps/is/arrayOf') +const isWeakMap = require('../../src/deps/is/weakMap') +const isWeakSet = require('../../src/deps/is/weakSet') +const isInstanceOf = require('../../src/deps/is/instanceOf') +const always = require('../../src/deps/fp/always') +const localGlobal = require('../../src/deps/util/localGlobal') +const hasInMatching = require('../../src/deps/fp/hasInMatching') +// const isFormData = require('../../src/deps/is/formData') +const stress = require('../_stress') + +test('localGlobal', () => { + expect(localGlobal).toBe(global) +}) + +test('isUndefinedLike', () => { + const stringy = isUndefinedLike('undefined') + const native = isUndefinedLike(undefined) + const void0 = isUndefinedLike(void 0) + const falsey = isUndefinedLike('eh') + + expect(stringy).toBe(true) + expect(native).toBe(true) + expect(void0).toBe(true) + expect(falsey).toBe(false) + stress(isUndefinedLike) +}) + +test('isBrowser', () => { + // @NOTE jest seems to polyfil it + const window = global.window + delete global.window + + expect(isBrowser()).toBe(false) + + global.window = window +}) + +// mocked window by default by jest o.o dangerous magic +test('isBrowser - mock window', () => { + // global.window = {} + // global.window.window = global.window + // console.log('undefinedLike window', typeof window, !isUndefinedLike(typeof window)) + // console.log('is!undefinedLike window.window', !isUndefinedLike(window.window)) + // console.log('isbrowser:', !isUndefinedLike(typeof window) && !isUndefinedLike(window.window)) + expect(isBrowser()).toBe(true) +}) + +test('isCircular', () => { + const a = {} + a.b = a + + expect(isCircular(a)).toBe(true) + + const eh = {} + eh.b = { + c: eh, + } + expect(isCircular(eh)).toBe(true) + + + const four = {} + four.b = { + c: 4, + } + expect(isCircular(four)).toBe(false) + + const array = [] + array.push(array) + + expect(isCircular(array)).toBe(true) + + expect(isCircular([])).toBe(false) + expect(isCircular({})).toBe(false) + expect(isCircular(undefined)).toBe(false) + expect(isCircular(null)).toBe(false) + expect(isCircular('eh')).toBe(false) +}) + +test('isInstanceOf', () => { + const isObjInstance = isInstanceOf(Object) + expect(isObjInstance({})).toBe(true) + expect(isObjInstance(undefined)).toBe(false) + + const isArrInstance = isInstanceOf(Array) + expect(isArrInstance({})).toBe(false) + + expect(isArrInstance(new Array())).toBe(true) +}) + +test('hasInMatching', () => { + const obj = {prop: true} + const hasTrueProp = hasInMatching(isTrue, '_', 'prop') + expect(hasTrueProp(obj)).toBe(true) + expect(hasInMatching(isTrue, obj, 'prop')).toBe(true) + + const array = [100] + const firstIsNumber = hasInMatching(isNumber, '_', 0) + expect(firstIsNumber(array)).toBe(true) + expect(hasInMatching(isNumber, array, 0)).toBe(true) + + expect(hasInMatching(isNumber, array, 1)).toBe(false) + expect(hasInMatching(isNumber, obj, 'prop')).toBe(false) + expect(hasInMatching(isNumber, obj, 'nope')).toBe(false) + expect(hasInMatching(always(false), obj, 'prop')).toBe(false) +}) + +test('isArrayOf', () => { + const nums = [0, 1, 2, 3] + const truths = [true, true, true] + const mixed = [true, true, true, 0, true, 100, false] + const allNums = isArrayOf(isNumber) + const allTrue = isArrayOf(isTrue) + + expect(allNums(nums)).toBe(true) + expect(allTrue(truths)).toBe(true) + + expect(allTrue(mixed)).toBe(false) + expect(allNums(mixed)).toBe(false) +}) + +test('isWeak', () => { + expect(isWeakMap(new WeakMap())).toBe(true) + expect(isWeakMap(new Map())).toBe(false) + expect(isWeakMap({})).toBe(false) + + expect(isWeakSet(new WeakSet())).toBe(true) + expect(isWeakSet(new Set())).toBe(false) + expect(isWeakSet({})).toBe(false) +}) diff --git a/typings/FantasyLand.d.ts b/typings/FantasyLand.d.ts new file mode 100644 index 0000000..b8bcad6 --- /dev/null +++ b/typings/FantasyLand.d.ts @@ -0,0 +1,134 @@ +// Fantasyland export interfaces + +// TODO: incorporate generalized inheritance e.g.: ``; possibly needs [rank 2 +// polymorphism](https://github.com/Microsoft/TypeScript/issues/1213). + +import {Primitive} from './generic' + +export interface Setoid { + equals(b: Setoid): boolean; +} + +export interface Semigroup { + concat(b: Semigroup): Semigroup; +} + +export interface Monoid extends Semigroup { + /* static */ empty(): Monoid; +} + +export interface Functor { + map(fn: (t: T) => U): Functor; +} + +export interface Apply extends Functor { + apply(fn: Apply<(t: T) => U>): Apply; +} + +export interface Applicative extends Apply { + /* static */ of(a: U): Applicative; +} + +export interface Alt extends Functor { + alt(b: T): Alt; +} + +export interface Plus extends Alt { + /* static */ zero(): Plus; +} + +export interface Alternative extends Plus, Applicative { +} + +export interface Foldable { + reduce(fn: (u: U, t: T) => U, u: U): U; +} + +export interface FantasyTraversable extends Functor, Foldable { + traverse(fn: (t: T) => Applicative, of: (v: V) => Applicative): Applicative>; +} + +export interface FantasyChain extends Apply { + chain(fn: (t: T) => FantasyChain): FantasyChain; +} + +export interface FantasyChainRec extends FantasyChain { + /* static */ chainRec(f: (next: (a: A) => C, done: (b: B) => C, value: A) => FantasyChainRec, i: A): FantasyChainRec; +} + +export interface Monad extends Applicative, FantasyChain { +} + +export interface Extend { + extend(f: (v: Extend) => U): Extend; +} + +export interface Comonad extends Functor, Extend { + extract(): U; // 'same U as in extend's f -- how to bind? +} + +export interface Bifunctor extends Functor /*, Functor*/ { + bimap(f: (v: T) => B, g: (v: U) => D): Bifunctor; +} + +export interface Profunctor extends Functor /*, Functor*/ { + promap(f: (v: T) => B, g: (v: U) => D): Profunctor; +} + +// simple types + +type Index = string | number; +// type Primitive = string | number | boolean; +type Ord = string | number | boolean | Date; + +export interface Dictionary { + [index: string]: T; +} + +type ObjF = Dictionary; +type List = T[] | ArrayLike; +type StringLike = string | StringRepresentable; +type Prop = Index | StringRepresentable; +type Path = List; +type Struct = ObjF | List; +type AccOpts = List|ObjF|Transformer; +type Pred = (v: T) => boolean; +type ObjFPred = (value: T, key: string) => boolean; + +// Ramda export interfaces + +export interface Type extends Function { + new (...args: any[]): T; +} + +export interface Variadic { + (...args: any[]): T; +} + +export interface KeyValuePair extends Array { 0 : K; 1 : V; } + +export interface Transformer { + step: (acc: Acc, v: T) => Acc; + init: () => Acc; + result: (acc: Acc) => Res; // = R.identity +} + +export interface NumericDictionary { + [index: number]: T; +} + +export interface StringRepresentable { + toString(): T; +} + +export interface NestedObj { + [index: string]: T|NestedObj; +} + +// export interface RecursiveArray extends Array> {} +// export interface ListOfRecursiveArraysOrValues extends List> {} +export interface NestedArray { + [index: number]: T | NestedArray; + length: number; +} diff --git a/typings/FantasyLandCurry.d.ts b/typings/FantasyLandCurry.d.ts new file mode 100644 index 0000000..4691140 --- /dev/null +++ b/typings/FantasyLandCurry.d.ts @@ -0,0 +1,100 @@ +import {Variadic} from './FantasyLand' + +// https://github.com/types/npm-ramda/blob/master/index.d.ts +// @see https://gist.github.com/donnut/fd56232da58d25ceecf1, comment by @albrow + +// interface CurriedFunction1 { +// (v1: T1): FP; +// } +type CurriedFunction1 = (v1: T1) => FP; + +interface CurriedFunction2 { + (v1: T1): (v2: T2) => FP; + (v1: T1, v2: T2): FP; +} +interface CurriedFunction3 { + (v1: T1): CurriedFunction2; + (v1: T1, v2: T2): (v3: T3) => FP; + (v1: T1, v2: T2, v3: T3): FP; +} +interface CurriedFunction4 { + (v1: T1): CurriedFunction3; + (v1: T1, v2: T2): CurriedFunction2; + (v1: T1, v2: T2, v3: T3): (v4: T4) => FP; + (v1: T1, v2: T2, v3: T3, v4: T4): FP; +} +interface CurriedFunction5 { + (v1: T1): CurriedFunction4; + (v1: T1, v2: T2): CurriedFunction3; + (v1: T1, v2: T2, v3: T3): CurriedFunction2; + (v1: T1, v2: T2, v3: T3, v4: T4): (v5: T5) => FP; + (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5): FP; +} +interface CurriedFunction6 { + (v1: T1): CurriedFunction5; + (v1: T1, v2: T2): CurriedFunction4; + (v1: T1, v2: T2, v3: T3): CurriedFunction3; + (v1: T1, v2: T2, v3: T3, v4: T4): CurriedFunction2; + (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5): (v6: T6) => FP; + (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6): FP; +} +interface CurriedFunction7 { + (v1: T1): CurriedFunction6; + (v1: T1, v2: T2): CurriedFunction5; + (v1: T1, v2: T2, v3: T3): CurriedFunction4; + (v1: T1, v2: T2, v3: T3, v4: T4): CurriedFunction3; + (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5): CurriedFunction2; + (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6): (v7: T7) => FP; + (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6, v7: T7): FP; +} +interface CurriedFunction8 { + (v1: T1): CurriedFunction7; + (v1: T1, v2: T2): CurriedFunction6; + (v1: T1, v2: T2, v3: T3): CurriedFunction5; + (v1: T1, v2: T2, v3: T3, v4: T4): CurriedFunction4; + (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5): CurriedFunction3; + (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6): CurriedFunction2; + (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6, v7: T7): (v8: T8) => FP; + (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6, v7: T7, v8: T8): FP; +} +interface CurriedFunction9 { + (v1: T1): CurriedFunction8; + (v1: T1, v2: T2): CurriedFunction7; + (v1: T1, v2: T2, v3: T3): CurriedFunction6; + (v1: T1, v2: T2, v3: T3, v4: T4): CurriedFunction5; + (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5): CurriedFunction4; + (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6): CurriedFunction3; + (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6, v7: T7): CurriedFunction2; + (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6, v7: T7, v8: T8): (v9: T9) => FP; + (v1: T1, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6, v7: T7, v8: T8, v9: T9): FP; +} + +/** + * Returns a curried equivalent of the provided function. + */ +export declare function curry(fn: (a: T1) => TResult): CurriedFunction1; +export declare function curry(fn: (a: T1, b: T2) => TResult): CurriedFunction2; +export declare function curry(fn: (a: T1, b: T2, c: T3) => TResult): CurriedFunction3; +export declare function curry(fn: (a: T1, b: T2, c: T3, d: T4) => TResult): CurriedFunction4; +export declare function curry(fn: (a: T1, b: T2, c: T3, d: T4, e: T5) => TResult): CurriedFunction5; +export declare function curry(fn: (a: T1, b: T2, c: T3, d: T4, e: T5, f: T6) => TResult): CurriedFunction6; +export declare function curry(fn: (a: T1, b: T2, c: T3, d: T4, e: T5, f: T6, g: T7) => TResult): CurriedFunction7; +export declare function curry(fn: (a: T1, b: T2, c: T3, d: T4, e: T5, f: T6, g: T7, h: T8) => TResult): CurriedFunction8; +export declare function curry(fn: (a: T1, b: T2, c: T3, d: T4, e: T5, f: T6, g: T7, h: T8, i: T9) => TResult): CurriedFunction9; +// curry(fn: Function): Function + + +/** + * Returns a curried equivalent of the provided function, with the specified arity. + */ +export declare function curryN(length: number, fn: Variadic): Variadic; +// curryN: CurriedFunction2, Variadic>; + + +/** + * Wraps a function of any arity (including nullary) in a function that accepts exactly n parameters. + * Any extraneous parameters will not be passed to the supplied function. + */ +export declare function nAry(n: number, fn: Variadic): Variadic; +export declare function nAry(n: number): (fn: Variadic) => Variadic; +// nAry: CurriedFunction2, Variadic>; diff --git a/typings/conditional.d.ts b/typings/conditional.d.ts new file mode 100644 index 0000000..2c9787a --- /dev/null +++ b/typings/conditional.d.ts @@ -0,0 +1,31 @@ +import {List, Pred} from './FantasyLand' + +/** + * Returns true if all elements of the list match the predicate, false if there are any that don't. + */ +export declare function all(pred: Pred, list: List): boolean; +export declare function all(pred: Pred): (list: List) => boolean; +// all: CurriedFunction2, List, boolean>; + +/* + * A function that returns the first argument if it's falsy otherwise the second argument. Note that this is + * NOT short-circuited, meaning that if expressions are passed they are both evaluated. + */ +// no generics: +export declare function and(v1: any, v2: any): boolean; +export declare function and(v1: any): (v2: any) => boolean; +// and: CurriedFunction2; + +/** + * Returns true if at least one of elements of the list match the predicate, false otherwise. + */ +export declare function any(pred: Pred, list: List): boolean; +export declare function any(fnpred: Pred): (list: List) => boolean; + +// any: CurriedFunction2, List, boolean>; +// dispatch to some `or` method: +export declare function or T|U;}, U>(fn1: T, val2: U): T|U; +export declare function or T|U;}, U>(fn1: T): (val2: U) => T|U; + + +export declare function not(value: any): boolean; diff --git a/typings/deps.cache.pooler.ts b/typings/deps.cache.pooler.ts new file mode 100644 index 0000000..e0930da --- /dev/null +++ b/typings/deps.cache.pooler.ts @@ -0,0 +1,19 @@ +// can be class or obj +export declare interface PoolableClass { + (args: any): any + destructor(): any + + // decorated + release(instance: PoolableClass): any + instancePool: Array + getPooled(): PoolableClass +} + +// calls .destructor +export declare function standardReleaser(instance: PoolableClass): void + +// draws from pool or instantiates +export declare function oneArgumentPooler(copyFieldsFrom: PoolableClass): PoolableClass + +// default export +export declare function addPoolingTo(CopyConstructor: PoolableClass, pooler: Function): void diff --git a/typings/deps.d.ts b/typings/deps.d.ts index 8d1d0ea..5bdc5d0 100644 --- a/typings/deps.d.ts +++ b/typings/deps.d.ts @@ -14,30 +14,32 @@ import { SchemaType, ValidMap, } from './generic' -import {ChainedMapI, Composable, MethodChain} from './_mediator' -import {MergeChain, dopemerge} from './merge' +import { ChainedMapI, Composable, MethodChain } from './_mediator' +import { MergeChain, dopemerge } from './merge' +import { List } from './FantasyLand' +import { Traverse } from './traverse' export declare function camelCase(str: string): string export declare function toarr(arr: Arr): Arr +export declare function noop(): void +export declare function simpleKindOf(x: any): string export interface Dot { has(object: Obj, path: strings): boolean get(object: Obj, path: strings): any set(object: Obj, path: strings, value: any): void delete(object: Obj, path: strings): void + escape(patgh: strings): strings } export interface DotPropSegments { (paths: strings): Array } -export interface DotPropPaths { +export interface DotPropPaths extends Traverse { (key: Primitive, value: Traversable, longest?: boolean): Array } -// undefined and null values are removed -export declare function clean(obj: Obj): Obj +// ------------ -// map iterator -> obj -export declare function reduce(map: ValidMap): Obj export declare function argumentor(...args: Arguments[]): Array export interface FnTap { diff --git a/typings/deps.encase.d.ts b/typings/deps.encase.d.ts new file mode 100644 index 0000000..1a1e283 --- /dev/null +++ b/typings/deps.encase.d.ts @@ -0,0 +1,15 @@ +import { onValid, onInvalid } from './MethodChain' + +export interface EncaseObj { + onInvalid(fn: onInvalid): EncaseObj + catch(fn: onInvalid): EncaseObj + + onValid(fn: onValid): EncaseObj + then(fn: onValid): EncaseObj +} + +export interface Encased { + (a: any, b: any, c: any): boolean | any +} +export declare function encase(call, encaser): EncaseObj +export declare function tryCatch(call, onValid: onValid, onInvalid: onInvalid): Encased diff --git a/typings/deps.reduce.d.ts b/typings/deps.reduce.d.ts new file mode 100644 index 0000000..6e396f7 --- /dev/null +++ b/typings/deps.reduce.d.ts @@ -0,0 +1,40 @@ +import { + Arr, + ArrOrObj, + Obj, + Fn, + ValidMap, +} from './generic' +import {List} from './FantasyLand' + +// undefined and null values are removed +export declare function clean(obj: Obj): Obj + +// ----------- + +export interface Reduced {} + +/** + * Returns a value wrapped to indicate that it is the final value of the reduce and + * transduce functions. The returned value should be considered a black box: the internal + * structure is not guaranteed to be stable. + */ +export type reduced(elem: T): Reduced; + +// map iterator -> obj +export declare function reduce(map: ValidMap): Obj +/** + * Returns a single item by iterating through the list, successively calling the iterator + * function and passing it an accumulator value and the current value from the array, and + * then passing the result to the next call. + */ +export declare function reduce>(fn: (acc: TResult, elem: T, idx: number, list: R) => TResult|Reduced, acc: TResult, list: R): TResult; +export declare function reduce>(fn: (acc: TResult, elem: T, idx: number, list: R) => TResult|Reduced, acc: TResult):{ + (list: R): TResult; +}; +export declare function reduce>(fn: (acc: TResult, elem: T, idx: number, list: R) => TResult|Reduced):{ + (acc: TResult, list: R): TResult; + (acc: TResult):{ + (list: R): TResult; + }; +}; diff --git a/typings/fp.d.ts b/typings/fp.d.ts new file mode 100644 index 0000000..9053884 --- /dev/null +++ b/typings/fp.d.ts @@ -0,0 +1,87 @@ +import {Variadic, List, Struct, Prop} from './FantasyLand' + +// https://github.com/ramda/ramda/issues/1617 +export function always(x: any): any + +// -------- + +/** + * Returns the first element in a list. + * In some libraries this function is named `first`. + */ +export declare function first>(list: T): T[0] | undefined; +export declare function first(list: string): string; +// tuple attempts; it doesn't like these. +export declare function first(list: [T]): T; +export declare function first(list: [T0, T1]): T0; +export declare function first(list: [T0, T1, T2]): T0; + +/** + * Returns the index of the last element of the list which matches the predicate, or + * `-1` if no element matches. + */ +export declare function findLastIndex(fn: (a: T) => boolean, list: List): number; +export declare function findLastIndex(fn: (a: T) => boolean): (list: List) => number; +// findLastIndex: CurriedFunction2<(a: T) => boolean, List, number>; + +/** + * Returns the last element of the list which matches the predicate, or `undefined` if no + * element matches. + */ +export declare function findLast(fn: (a: T) => boolean, list: List): T; +export declare function findLast(fn: (a: T) => boolean): (list: List) => T; +// findLast: CurriedFunction2<(a: T) => boolean, List, T>; + + +// -------- + +/** + * Returns a function that when supplied an object returns the indicated export declare function property of that object, if it exists. + */ + +// keyof version +export declare function prop(p: K, obj: T): T[K]; +// export declare function prop(p: K): (obj: T) => T[K]; // T info late +// export declare function prop: CurriedFunction2; +// export declare function prop(p: K): (obj: T) => T[K]; // K redefined, fails +// export declare function prop: CurriedFunction2; + +// Record version, more curry-friendly +export declare function prop>(p: K, obj: T): V; // uncurried adds value only for {} from e.g. degeneration +// export declare function prop(p: K): >(obj: T) => V; +// export declare function prop>: CurriedFunction2; + +// manually type with explicit generic +export declare function prop(p: Prop, obj: Struct): T; +// export declare function prop(p: Prop): (obj: Struct) => T; +// export declare function prop: CurriedFunction2, T>; + +// mixed for currying: +export declare function prop(p: K): { + // Record version + >(obj: T): V; + // manually typed + (obj: Struct): T; +}; + +/** + * Replace a substring or regex match in a string with a replacement. + */ +// replace(pattern: RegExp|Prop, replacement: Prop, str: string): string; +// replace(pattern: RegExp|Prop, replacement: Prop): (str: string) => string; +// replace(pattern: RegExp|Prop): CurriedFunction2; +// // replace(pattern: RegExp|Prop): (replacement: Prop, str: string) => string; +// // replace(pattern: RegExp|Prop): (replacement: Prop) => (str: string) => string; +// // replace: CurriedFunction3; + +// base +export declare function replace(pattern: RegExp|Prop, replacement: Prop, str: string): string; +export declare function replace(pattern: RegExp|Prop, replacement: Prop):{ + (str: string): string; +}; +export declare function replace(pattern: RegExp|Prop):{ + (replacement: Prop, str: string): string; + (replacement: Prop):{ + (str: string): string; + }; +}; diff --git a/typings/index.d.ts b/typings/index.d.ts index e19addf..3a278be 100644 --- a/typings/index.d.ts +++ b/typings/index.d.ts @@ -1,5 +1,7 @@ export * from './generic' export * from './deps' +export * from './deps.cache.pooler' +export * from './deps.reduce' export * from './is' export * from './traverse' export * from './interfaces' @@ -14,7 +16,11 @@ export * from './ChainedMapBase' export * from './FactoryChain' export * from './compose' export * from './schema' +export * from './FantasyLand' +export * from './FantasyLandCurry' +export * from './fp' +export * from './conditional' -import {Chain} from './chain' +import { Chain } from './chain' export default Chain diff --git a/typings/is.d.ts b/typings/is.d.ts index 94bd11b..3c81169 100644 --- a/typings/is.d.ts +++ b/typings/is.d.ts @@ -34,16 +34,21 @@ export type notEmptyArray = [any] export function toArray(arg): any[] export function isNotEmptyArray(o: any): o is notEmptyArray -export function isString(o: any): o is string -export function isNumber(o: any): o is number +export function isStringPrimitive(o: any): o is number +export function isString(o: any): o is string | String +export function numberPrimitive(o: any): o is number +export function isNumber(o: any): o is Number | number export function isStringOrNumber(o: any): o is string | number export function isNull(o: any): o is null export function isUndefined(o: any): o is undefined -export function isNullOrUndef(o: any): o is undefined | null +export function isNullOrUndefined(o: any): o is undefined | null export function isFunction(o: any): o is Function -export function isObj(o: any): o is object +export function isObj(o: any): o is object | Array | Function +export function isObjNotNull(o: any): o is object // !null +export function objTypeof(o: any): o is object | null +export function objPure(o: any): o is object // !Array export function isObjWithKeys(o: any): o is ObjectWithKeys export function isPrototypeOf(o: any, prop: any): PrototypeOf @@ -72,6 +77,32 @@ export function isObjLoose(o: any): 'o is typeof Obj' | boolean export function isClass(o: any): 'o.toString().includes(class)' | boolean export function isMapish(o: any): o is Mapish +export type Property = 'property in Object' | boolean | string | any +export function hasIn(o: any, prop: any): prop is Property +// no generics +// hasIn(s: Prop, obj: Struct): boolean; +// hasIn(s: Prop): (obj: Struct) => boolean; + +export function isNotNested(o: any): boolean +export function isIteratable(o: any): boolean +export function isPrimitive(o: any): boolean +export function isEmpty(o: any): boolean +export function isGenerator(o: any): boolean +export function isJSON(o: any): o is JSON +export function isNative(o: any): boolean +export function isPromise(o: any): o is Promise +export function isAsyncish(o: any): o is Promise +export function isIn(obj: Object | any, prop: any): boolean +export function isBuffer(o: any): o is Buffer +export function isArguments(o: any): o is Arguments + +// function(x) => x.every() +export function isArrayOf(predicate: Function): boolean + +// o is !isEmpty || o is !isReal +export function isNotRealOrIsEmpty(o: any): boolean + + export const is = { isArray, isString, @@ -99,7 +130,8 @@ export const is = { // @example `chain-able/deps/is/stringOrNumber`, `chain-able/deps/is/dot` isNotEmptyArray, isStringOrNumber, - isNullOrUndef, + isNullOrUndefined, + isNill: isNullOrUndefined, isFalse, isDot, isMapish, diff --git a/typings/matcher.d.ts b/typings/matcher.d.ts index 9b1e030..739cfdd 100644 --- a/typings/matcher.d.ts +++ b/typings/matcher.d.ts @@ -1,3 +1,5 @@ +import {Primitive, Arr, Matchable} from './generic' + export function escapeStringRegExp(str: string): string // calls escapeStringRegExp export function toRegExp(str: string): string diff --git a/typings/schema.d.ts b/typings/schema.d.ts index adf1e4b..4c4d936 100644 --- a/typings/schema.d.ts +++ b/typings/schema.d.ts @@ -3,11 +3,9 @@ export interface ValidationFunction { } // all `is` validators, or any custom added ones -export type Type = +export type ValidatableType = | ValidationFunction - | '?' - | '|' - | '[]' + | '? | [] ! &' | 'string' | 'number' | 'date' @@ -21,6 +19,7 @@ export type Type = | 'array' | 'symbol' | 'real' + | 'empty' | 'iterator' | 'objWithKeys' | 'null' @@ -30,4 +29,4 @@ export interface Schemable { (key: string | any): T } -export type Schema = Schemable | Type +export type Schema = Schemable | ValidatableType diff --git a/typings/traverse.d.ts b/typings/traverse.d.ts index a90d454..23000af 100644 --- a/typings/traverse.d.ts +++ b/typings/traverse.d.ts @@ -1,4 +1,4 @@ -import {ArrOrObj, Primitive, Traversable, Matchable, Obj, Fn} from './generic' +import {Arr, ArrOrObj, Primitive, Traversable, Matchable, Obj, Fn} from './generic' export type TraverseValue = any @@ -8,37 +8,38 @@ export declare function TraverseCallback( ): TraverseContext | any export interface TraverseContext { - node: any - circular: boolean - path: undefined | string[] + node: any // aka iteratee + isCircular: boolean + isRoot: boolean + isLeaf: boolean + path: string[] + depth: number parent: undefined | any + parents: Set key: undefined | Primitive - notRoot: boolean - root: boolean - isLeaf: boolean - notLeaf: boolean - level: number update(value: Primitive, stopHere?: boolean): void remove(stopHere?: boolean): void - delete(stopHere?: boolean): void // events before(fn: Fn): void after(fn: Fn): void pre(fn: Fn): void post(fn: Fn): void } -export interface Traverse { +export interface Traverse extends TraverseContext { value: TraverseValue - nodes(): ArrOrObj - map(fn: Fn): any + path: Array forEach(x: TraverseValue, fn: (t: Traverse) => any): void - reduce(fn: Fn, init: Obj | Arr | any): ArrOrObj - paths(): ArrOrObj - set(path: Primitive, value: any): boolean - has(path: Primitive): boolean - get(path: Primitive): any - clone(): Obj + nodes(): ArrOrObj + // all removed for now + // map(fn: Fn): any + // reduce(fn: Fn, init: Obj | Arr | any): ArrOrObj + // paths(): ArrOrObj + // set(path: Primitive, value: any): boolean + // has(path: Primitive): boolean + // get(path: Primitive): any } // loose = false export declare function eq(one: any, two: any, loose?: boolean): boolean +export declare function eqValue(one: any, two: any, loose?: boolean): boolean +export declare function clone(value: any): any diff --git a/yarn.lock b/yarn.lock index ccde1ea..4ea9b70 100644 --- a/yarn.lock +++ b/yarn.lock @@ -324,6 +324,10 @@ arrify@^1.0.0, arrify@^1.0.1: version "1.0.1" resolved "https://registry.yarnpkg.com/arrify/-/arrify-1.0.1.tgz#898508da2226f380df904728456849c1501a4b0d" +asap@~2.0.3: + version "2.0.6" + resolved "https://registry.yarnpkg.com/asap/-/asap-2.0.6.tgz#e50347611d7e690943208bbdafebcbc2fb866d46" + asn1.js@^4.0.0: version "4.9.1" resolved "https://registry.yarnpkg.com/asn1.js/-/asn1.js-4.9.1.tgz#48ba240b45a9280e94748990ba597d216617fd40" @@ -344,7 +348,7 @@ assert-plus@^0.2.0: version "0.2.0" resolved "https://registry.yarnpkg.com/assert-plus/-/assert-plus-0.2.0.tgz#d74e1b87e7affc0db8aadb7021f3fe48101ab234" -assert@^1.1.1: +assert@^1.1.1, assert@^1.3.0: version "1.4.1" resolved "https://registry.yarnpkg.com/assert/-/assert-1.4.1.tgz#99912d591836b5a6f5b345c0f07eefc08fc65d91" dependencies: @@ -1259,7 +1263,7 @@ block-stream@*: dependencies: inherits "~2.0.0" -bluebird@^3.0.0: +bluebird@^3.0.0, bluebird@^3.0.5: version "3.5.0" resolved "https://registry.yarnpkg.com/bluebird/-/bluebird-3.5.0.tgz#791420d7f551eea2897453a8a77653f96606d67c" @@ -1736,6 +1740,13 @@ concordance@^2.0.0: semver "^5.3.0" well-known-symbols "^1.0.0" +config-chain@~1.1.5: + version "1.1.11" + resolved "https://registry.yarnpkg.com/config-chain/-/config-chain-1.1.11.tgz#aba09747dfbe4c3e70e766a6e41586e1859fc6f2" + dependencies: + ini "^1.3.4" + proto-list "~1.2.1" + configstore@3.0.0: version "3.0.0" resolved "https://registry.yarnpkg.com/configstore/-/configstore-3.0.0.tgz#e1b8669c1803ccc50b545e92f8e6e79aa80e0196" @@ -1811,6 +1822,10 @@ core-assert@^0.2.0: buf-compare "^1.0.0" is-error "^2.2.0" +core-js@^1.0.0: + version "1.2.7" + resolved "https://registry.yarnpkg.com/core-js/-/core-js-1.2.7.tgz#652294c14651db28fa93bd2d5ff2983a4f08c636" + core-js@^2.0.0, core-js@^2.4.0: version "2.4.1" resolved "https://registry.yarnpkg.com/core-js/-/core-js-2.4.1.tgz#4de911e667b0eae9124e34254b53aea6fc618d3e" @@ -1862,6 +1877,14 @@ create-hmac@^1.1.0, create-hmac@^1.1.2, create-hmac@^1.1.4: safe-buffer "^5.0.1" sha.js "^2.4.8" +create-react-class@^15.6.0: + version "15.6.0" + resolved "https://registry.yarnpkg.com/create-react-class/-/create-react-class-15.6.0.tgz#ab448497c26566e1e29413e883207d57cfe7bed4" + dependencies: + fbjs "^0.8.9" + loose-envify "^1.3.1" + object-assign "^4.1.1" + cross-spawn-async@^2.1.1: version "2.2.5" resolved "https://registry.yarnpkg.com/cross-spawn-async/-/cross-spawn-async-2.2.5.tgz#845ff0c0834a3ded9d160daca6d390906bb288cc" @@ -2073,6 +2096,10 @@ diffie-hellman@^5.0.0: miller-rabin "^4.0.0" randombytes "^2.0.0" +discontinuous-range@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/discontinuous-range/-/discontinuous-range-1.0.0.tgz#e38331f0844bba49b9a9cb71c771585aab1bc65a" + dive@^0.5.0: version "0.5.0" resolved "https://registry.yarnpkg.com/dive/-/dive-0.5.0.tgz#06d0e07edd25da849598bacab44d51f2809bec47" @@ -2171,6 +2198,15 @@ ecc-jsbn@~0.1.1: dependencies: jsbn "~0.1.0" +editorconfig@^0.13.2: + version "0.13.2" + resolved "https://registry.yarnpkg.com/editorconfig/-/editorconfig-0.13.2.tgz#8e57926d9ee69ab6cb999f027c2171467acceb35" + dependencies: + bluebird "^3.0.5" + commander "^2.9.0" + lru-cache "^3.2.0" + sigmund "^1.0.1" + ee-first@1.1.1: version "1.1.1" resolved "https://registry.yarnpkg.com/ee-first/-/ee-first-1.1.1.tgz#590c61156b0ae2f4f0255732a158b266bc56b21d" @@ -2770,6 +2806,10 @@ express@^4.14.0: utils-merge "1.0.0" vary "~1.1.1" +extend@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/extend/-/extend-2.0.1.tgz#1ee8010689e7395ff9448241c98652bc759a8260" + extend@~3.0.0: version "3.0.1" resolved "https://registry.yarnpkg.com/extend/-/extend-3.0.1.tgz#a755ea7bc1adfcc5a31ce7e762dbaadc5e636444" @@ -2825,6 +2865,18 @@ fb-watchman@^2.0.0: dependencies: bser "^2.0.0" +fbjs@^0.8.9: + version "0.8.12" + resolved "https://registry.yarnpkg.com/fbjs/-/fbjs-0.8.12.tgz#10b5d92f76d45575fd63a217d4ea02bea2f8ed04" + dependencies: + core-js "^1.0.0" + isomorphic-fetch "^2.1.1" + loose-envify "^1.0.0" + object-assign "^4.1.0" + promise "^7.1.1" + setimmediate "^1.0.5" + ua-parser-js "^0.7.9" + figures@^1.3.5: version "1.7.0" resolved "https://registry.yarnpkg.com/figures/-/figures-1.7.0.tgz#cbe1e3affcf1cd44b80cadfed28dc793a9701d2e" @@ -3561,7 +3613,7 @@ inherits@2.0.1: version "2.0.1" resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.1.tgz#b17d08d326b4423e568eff719f91b0b1cbdf69f1" -ini@~1.3.0: +ini@^1.3.4, ini@~1.3.0: version "1.3.4" resolved "https://registry.yarnpkg.com/ini/-/ini-1.3.4.tgz#0537cb79daf59b59a1a517dff706c86ec039162e" @@ -3881,6 +3933,13 @@ isobject@^2.0.0: dependencies: isarray "1.0.0" +isomorphic-fetch@^2.1.1: + version "2.2.1" + resolved "https://registry.yarnpkg.com/isomorphic-fetch/-/isomorphic-fetch-2.2.1.tgz#611ae1acf14f5e81f729507472819fe9733558a9" + dependencies: + node-fetch "^1.0.1" + whatwg-fetch ">=0.10.0" + isstream@~0.1.2: version "0.1.2" resolved "https://registry.yarnpkg.com/isstream/-/isstream-0.1.2.tgz#47e63f7af55afa6f92e1500e690eb8b8529c099a" @@ -4176,6 +4235,15 @@ jest@^20.0.4: dependencies: jest-cli "^20.0.4" +js-beautify@^1.6.14: + version "1.6.14" + resolved "https://registry.yarnpkg.com/js-beautify/-/js-beautify-1.6.14.tgz#d3b8f7322d02b9277d58bd238264c327e58044cd" + dependencies: + config-chain "~1.1.5" + editorconfig "^0.13.2" + mkdirp "~0.5.0" + nopt "~3.0.1" + js-string-escape@^1.0.1: version "1.0.1" resolved "https://registry.yarnpkg.com/js-string-escape/-/js-string-escape-1.0.1.tgz#e2625badbc0d67c7533e9edc1068c587ae4137ef" @@ -4299,6 +4367,24 @@ jsprim@^1.2.2: json-schema "0.2.3" verror "1.3.6" +jssmartcheck@^0.2.3: + version "0.2.3" + resolved "https://registry.yarnpkg.com/jssmartcheck/-/jssmartcheck-0.2.3.tgz#fb81ce25cd96b0be4179cdaedc399f0a3b133284" + dependencies: + assert "^1.3.0" + discontinuous-range "^1.0.0" + extend "^2.0.0" + ret "^0.1.10" + +jsverify@^0.8.2: + version "0.8.2" + resolved "https://registry.yarnpkg.com/jsverify/-/jsverify-0.8.2.tgz#9c7daa72cc1b1542cc8a53af78b42ef5f5293a38" + dependencies: + lazy-seq "^1.0.0" + rc4 "~0.1.5" + trampa "^1.0.0" + typify-parser "^1.1.0" + jsx-ast-utils@^1.0.0, jsx-ast-utils@^1.3.4, jsx-ast-utils@^1.4.0, jsx-ast-utils@^1.4.1: version "1.4.1" resolved "https://registry.yarnpkg.com/jsx-ast-utils/-/jsx-ast-utils-1.4.1.tgz#3867213e8dd79bf1e8f2300c0cfc1efb182c0df1" @@ -4335,6 +4421,10 @@ lazy-req@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/lazy-req/-/lazy-req-2.0.0.tgz#c9450a363ecdda2e6f0c70132ad4f37f8f06f2b4" +lazy-seq@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/lazy-seq/-/lazy-seq-1.0.0.tgz#880cb8aab256026382e02f53ec089682a74c5b6a" + lcid@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/lcid/-/lcid-1.0.0.tgz#308accafa0bc483a3867b4b6f2b9506251d1b835" @@ -4488,7 +4578,7 @@ longest@^1.0.1: version "1.0.1" resolved "https://registry.yarnpkg.com/longest/-/longest-1.0.1.tgz#30a0b2da38f73770e8294a0d22e6625ed77d0097" -loose-envify@^1.0.0: +loose-envify@^1.0.0, loose-envify@^1.1.0, loose-envify@^1.3.1: version "1.3.1" resolved "https://registry.yarnpkg.com/loose-envify/-/loose-envify-1.3.1.tgz#d1a8ad33fa9ce0e713d65fdd0ac8b748d478c848" dependencies: @@ -4505,6 +4595,12 @@ lowercase-keys@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/lowercase-keys/-/lowercase-keys-1.0.0.tgz#4e3366b39e7f5457e35f1324bdf6f88d0bfc7306" +lru-cache@^3.2.0: + version "3.2.0" + resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-3.2.0.tgz#71789b3b7f5399bec8565dda38aa30d2a097efee" + dependencies: + pseudomap "^1.0.1" + lru-cache@^4.0.0, lru-cache@^4.0.1: version "4.1.1" resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-4.1.1.tgz#622e32e82488b49279114a4f9ecf45e7cd6bba55" @@ -4798,6 +4894,13 @@ node-fetch@1.6.3: encoding "^0.1.11" is-stream "^1.0.1" +node-fetch@^1.0.1: + version "1.7.1" + resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-1.7.1.tgz#899cb3d0a3c92f952c47f1b876f4c8aeabd400d5" + dependencies: + encoding "^0.1.11" + is-stream "^1.0.1" + node-int64@^0.4.0: version "0.4.0" resolved "https://registry.yarnpkg.com/node-int64/-/node-int64-0.4.0.tgz#87a9065cdb355d3182d8f94ce11188b825c68a3b" @@ -4864,6 +4967,12 @@ nopt@^4.0.1: abbrev "1" osenv "^0.1.4" +nopt@~3.0.1: + version "3.0.6" + resolved "https://registry.yarnpkg.com/nopt/-/nopt-3.0.6.tgz#c6465dbf08abcd4db359317f79ac68a646b28ff9" + dependencies: + abbrev "1" + normalize-package-data@^2.3.2, normalize-package-data@^2.3.4: version "2.4.0" resolved "https://registry.yarnpkg.com/normalize-package-data/-/normalize-package-data-2.4.0.tgz#12f95a307d58352075a04907b84ac8be98ac012f" @@ -4968,7 +5077,7 @@ obj-chain-plugin-config@0.0.5: dependencies: configstore "3.0.0" -object-assign@^4.0.1, object-assign@^4.1.0: +object-assign@^4.0.1, object-assign@^4.1.0, object-assign@^4.1.1: version "4.1.1" resolved "https://registry.yarnpkg.com/object-assign/-/object-assign-4.1.1.tgz#2109adc7965887cfc05cbbd442cac8bfbb360863" @@ -5339,6 +5448,10 @@ postcss@^6.0.1: source-map "^0.5.6" supports-color "^4.0.0" +preact@^8.2.1: + version "8.2.1" + resolved "https://registry.yarnpkg.com/preact/-/preact-8.2.1.tgz#674243df0c847884d019834044aa2fcd311e72ed" + prelude-ls@~1.1.2: version "1.1.2" resolved "https://registry.yarnpkg.com/prelude-ls/-/prelude-ls-1.1.2.tgz#21932a549f5e52ffd9a827f570e04be62a97da54" @@ -5411,6 +5524,23 @@ progress@^2.0.0: version "2.0.0" resolved "https://registry.yarnpkg.com/progress/-/progress-2.0.0.tgz#8a1be366bf8fc23db2bd23f10c6fe920b4389d1f" +promise@^7.1.1: + version "7.3.1" + resolved "https://registry.yarnpkg.com/promise/-/promise-7.3.1.tgz#064b72602b18f90f29192b8b1bc418ffd1ebd3bf" + dependencies: + asap "~2.0.3" + +prop-types@^15.5.10: + version "15.5.10" + resolved "https://registry.yarnpkg.com/prop-types/-/prop-types-15.5.10.tgz#2797dfc3126182e3a95e3dfbb2e893ddd7456154" + dependencies: + fbjs "^0.8.9" + loose-envify "^1.3.1" + +proto-list@~1.2.1: + version "1.2.4" + resolved "https://registry.yarnpkg.com/proto-list/-/proto-list-1.2.4.tgz#212d5bfe1318306a420f6402b8e26ff39647a849" + proxy-addr@~1.1.4: version "1.1.4" resolved "https://registry.yarnpkg.com/proxy-addr/-/proxy-addr-1.1.4.tgz#27e545f6960a44a627d9b44467e35c1b6b4ce2f3" @@ -5422,7 +5552,7 @@ prr@~0.0.0: version "0.0.0" resolved "https://registry.yarnpkg.com/prr/-/prr-0.0.0.tgz#1a84b85908325501411853d0081ee3fa86e2926a" -pseudomap@^1.0.2: +pseudomap@^1.0.1, pseudomap@^1.0.2: version "1.0.2" resolved "https://registry.yarnpkg.com/pseudomap/-/pseudomap-1.0.2.tgz#f052a28da70e618917ef0a8ac34c1ae5a68286b3" @@ -5488,6 +5618,10 @@ range-parser@~1.2.0: version "1.2.0" resolved "https://registry.yarnpkg.com/range-parser/-/range-parser-1.2.0.tgz#f49be6b487894ddc40dcc94a322f611092e00d5e" +rc4@~0.1.5: + version "0.1.5" + resolved "https://registry.yarnpkg.com/rc4/-/rc4-0.1.5.tgz#08c6e04a0168f6eb621c22ab6cb1151bd9f4a64d" + rc@^1.0.1, rc@^1.1.6, rc@^1.1.7: version "1.2.1" resolved "https://registry.yarnpkg.com/rc/-/rc-1.2.1.tgz#2e03e8e42ee450b8cb3dce65be1bf8974e1dfd95" @@ -5497,6 +5631,16 @@ rc@^1.0.1, rc@^1.1.6, rc@^1.1.7: minimist "^1.2.0" strip-json-comments "~2.0.1" +react@^15.6.1: + version "15.6.1" + resolved "https://registry.yarnpkg.com/react/-/react-15.6.1.tgz#baa8434ec6780bde997cdc380b79cd33b96393df" + dependencies: + create-react-class "^15.6.0" + fbjs "^0.8.9" + loose-envify "^1.1.0" + object-assign "^4.1.0" + prop-types "^15.5.10" + read-pkg-up@^1.0.1: version "1.0.1" resolved "https://registry.yarnpkg.com/read-pkg-up/-/read-pkg-up-1.0.1.tgz#9d63c13276c065918d57f002a57f40a1b643fb02" @@ -5783,6 +5927,10 @@ restore-cursor@^2.0.0: onetime "^2.0.0" signal-exit "^3.0.2" +ret@^0.1.10: + version "0.1.14" + resolved "https://registry.yarnpkg.com/ret/-/ret-0.1.14.tgz#58c636837b12e161f8a380cf081c6a230fd1664e" + right-align@^0.1.1: version "0.1.3" resolved "https://registry.yarnpkg.com/right-align/-/right-align-0.1.3.tgz#61339b722fe6a3515689210d24e14c96148613ef" @@ -6025,7 +6173,7 @@ set-immediate-shim@^1.0.1: version "1.0.1" resolved "https://registry.yarnpkg.com/set-immediate-shim/-/set-immediate-shim-1.0.1.tgz#4b2b1b27eb808a9f8dcc481a58e5e56f599f3f61" -setimmediate@^1.0.4: +setimmediate@^1.0.4, setimmediate@^1.0.5: version "1.0.5" resolved "https://registry.yarnpkg.com/setimmediate/-/setimmediate-1.0.5.tgz#290cbb232e306942d7d7ea9b83732ab7856f8285" @@ -6065,6 +6213,10 @@ shorthash@0.0.2: version "0.0.2" resolved "https://registry.yarnpkg.com/shorthash/-/shorthash-0.0.2.tgz#59b268eecbde59038b30da202bcfbddeb2c4a4eb" +sigmund@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/sigmund/-/sigmund-1.0.1.tgz#3ff21f198cad2175f9f3b781853fd94d0d19b590" + signal-exit@^2.0.0: version "2.1.2" resolved "https://registry.yarnpkg.com/signal-exit/-/signal-exit-2.1.2.tgz#375879b1f92ebc3b334480d038dc546a6d558564" @@ -6453,6 +6605,10 @@ tr46@~0.0.3: version "0.0.3" resolved "https://registry.yarnpkg.com/tr46/-/tr46-0.0.3.tgz#8184fd347dac9cdc185992f3a6622e14b9d9ab6a" +trampa@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/trampa/-/trampa-1.0.0.tgz#5247347ac334807fa6c0000444cb91b639840ad5" + "traverse@>=0.3.0 <0.4": version "0.3.9" resolved "https://registry.yarnpkg.com/traverse/-/traverse-0.3.9.tgz#717b8f220cc0bb7b44e40514c22b2e8bbc70d8b9" @@ -6558,6 +6714,14 @@ typescript@next: version "2.5.0-dev.20170629" resolved "https://registry.yarnpkg.com/typescript/-/typescript-2.5.0-dev.20170629.tgz#ebdcdab19a7d109bf2ca0545761b0410430c8ae0" +typify-parser@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/typify-parser/-/typify-parser-1.1.0.tgz#ac73bfa5f25343468e2d0f3346c6117bc03d3c99" + +ua-parser-js@^0.7.9: + version "0.7.14" + resolved "https://registry.yarnpkg.com/ua-parser-js/-/ua-parser-js-0.7.14.tgz#110d53fa4c3f326c121292bbeac904d2e03387ca" + uc.micro@^1.0.1, uc.micro@^1.0.3: version "1.0.3" resolved "https://registry.yarnpkg.com/uc.micro/-/uc.micro-1.0.3.tgz#7ed50d5e0f9a9fb0a573379259f2a77458d50192" @@ -6820,6 +6984,10 @@ whatwg-encoding@^1.0.1: dependencies: iconv-lite "0.4.13" +whatwg-fetch@>=0.10.0: + version "2.0.3" + resolved "https://registry.yarnpkg.com/whatwg-fetch/-/whatwg-fetch-2.0.3.tgz#9c84ec2dcf68187ff00bc64e1274b442176e1c84" + whatwg-url@^4.3.0: version "4.8.0" resolved "https://registry.yarnpkg.com/whatwg-url/-/whatwg-url-4.8.0.tgz#d2981aa9148c1e00a41c5a6131166ab4683bbcc0"