ksjs v1.8.1

ksjs

This repo contains a bunch of plain JavaScript functions that come in handy while working on various projects. They are mostly provided as ES modules, but a subset of them are also offered as CommonJS modules so they can easily be used in an older node.js environment.

Install

From the command line, run:

npm install ksjs

or

yarn add ksjs

ES Modules

Preferred: For any of the modules, you can import functions like so:

import {example1, example2} from 'ksjs/example.mjs'
// Depending on your project, ES modules are available in
// files with the .js extension, too. For example:
// import {example1, example2} from 'ksjs/example.js'

example1('foo');
example2('bar');

Not recommended: If your bundler supports ES module tree shaking, you might be able to import functions from various files like so (for Webpack, you might need to configure it to treat bamfjs as ES6+):

import {$, debounce, deepCopy} from 'bamfjs';

CommonJS Modules

The following modules & their corresponding functions can be used in a node.js environment:

• array
• color
• math
• object
• promise
• string
• timer
• url

Preferred: You can require them from their respective files with the .cjs extension, like so:

const {example1} = require('ksjs/example.cjs');

example1('foo');

or like so:

const examples = require('ksjs/example.cjs');

examples.example1('foo');

Otherwise: You could require them from the cjs directory, like so (Note the ".js" extension here):

const {example1} = require('ksjs/cjs/example.js');

example1('foo');

or like so:

const examples = require('ksjs/cjs/example.js');

examples.example1('foo');

Modules

• ajax
• array
• color
• cookie
• dom
• event
• form
• jsonp
• math
• object
• promise
• selection
• storage
• string
• timer
• url

ajax

ESM Import Example:

import {getJSON} from 'ksjs';

// or:
import {getJSON} from 'ksjs/ajax.js';
// or:
import {getJSON} from 'ksjs/ajax.mjs';

• ajax
  • ajax([url], options) ⇒ Promise
  • getJSON([url], [options]) ⇒ Promise
  • postJSON([url], [options]) ⇒ Promise
  • postFormData([url], [options]) ⇒ Promise
  • fetchHTML(url, selector) ⇒ Promise

ajax(url, options) ⇒ Promise

Low-level ajax request

Returns: Promise - A resolved or rejected Promise from the server

getJSON(url, options) ⇒ Promise

Send a GET request and return parsed JSON response from the resolved Promise

Returns: Promise - A resolved or rejected Promise from the server

See: ajax

postJSON(url, options) ⇒ Promise

Send a POST request and return parsed JSON response from the resolved Promise

Returns: Promise - A resolved or rejected Promise from the server

See: ajax

postFormData(url, options) ⇒ Promise

Send a POST request with FormData derived from form element provided by options.form

Returns: Promise - A resolved or rejected Promise from the server

See: ajax

fetchHTML(url, selector) ⇒ Promise

Fetch an HTML document and return the html string (or a subset of it) from the resolved Promise

Returns: Promise - A resolved or rejected Promise, resolving to an HTML string

array

ESM Import Example:

import {isArray} from 'ksjs';

// or:
import {isArray} from 'ksjs/array.mjs';
// or:
import {isArray} from 'ksjs/array.js';

CommonJS Require Example:

const {isArray} = require('ksjs/array.cjs');
// or:
const {isArray} = require('ksjs/cjs/array.js');

• array
  • isArray(arr) ⇒ boolean
  • inArray(el, arr) ⇒ boolean
  • objectToArray(obj) ⇒ array
  • makeArray(value, [delimiter], [wrapObject]) ⇒ array
  • randomItem(arr) ⇒ any
  • pluck(arr, prop) ⇒ array
  • shuffle(els) ⇒ array
  • merge(...arrays) ⇒ array
  • collapse()
  • intersect(array1, array2, [prop]) ⇒ array
  • unique(arr, [prop]) ⇒ array
  • diff(array1, array2, [prop]) ⇒ array
  • chunk(arr, n) ⇒ array
  • range(a, [b]) ⇒ array
  • pad(arr, size, value) ⇒ array
  • sort(arr, [prop], [options]) ⇒ array

isArray(arr) ⇒ boolean

Determine whether "arr" is a true array

Returns: boolean - true if arr is array, false if not

Example

import {isArray} from 'ksjs/array.js';

if (isArray(window.foo)) {
  window.foo.push('bar');
}

inArray(el, arr) ⇒ boolean

Determine whether item "el" is in array "arr"

Returns: boolean - Boolean (true if el is in array, false if not)

objectToArray(obj) ⇒ array

Convert an object to an array of objects with name and value properties

Returns: array - An array of objects with name and value properties

Example

import {objectToArray} from 'ksjs/array.js';

const obj = {
  foo: 'bar',
  baz: 'qux'
};

const arr = objectToArray(obj);
 // arr = [
//   {name: 'foo', value: 'bar'},
//   {name: 'baz', value: 'qux'}
// ];

makeArray(value, delimiter, wrapObject) ⇒ array

Return an array based on the given value: a) Strings are split by a delimiter (defaults to /\s+/). b) Plain objects are converted to an array of objects with name and value properties. b2) …unless wrapObject is true in which case they are just wrapped in an array c) Undefined and null are returned as an empty array. d) Arrays are returned as is. e) Anything else is wrapped in an array.

Returns: array - The value converted to an array

Example

import {makeArray} from 'ksjs/array.js';
const foo = makeArray('one two three');
// foo is now ['one', 'two', 'three']

const bar = makeArray('one,two,three', ',');
// bar is now ['one', 'two', 'three']

const baz = makeArray(['one', 'two', 'three']);
// baz is still ['one', 'two', 'three']

const quz = makeArray({foo: 'bar'});
// quz is now [{name: 'foo': value: 'bar'}]

const quuz = makeArray(null);
// quuz is now []

randomItem(arr) ⇒ any

Return a random item from the provided array

Returns: any - A random element from the provided array

pluck(arr, prop) ⇒ array

Take an array of objects and a property and return an array of values of that property

Returns: array - Array of values of the property (if the value is undefined, returns null instead)

Example

import {pluck} from 'ksjs/array.js';

let family = [
  {
    id: 'dad',
    name: 'Karl'
  },
  {
    id: 'mom',
    name: 'Sara',
    color: 'blue'
  },
  {
    id: 'son',
    name: 'Ben',
    color: 'green'
  },
  {
    id: 'daughter',
    name: 'Lucy'
  }
];

let names = pluck(family, 'name');
let ids = pluck(family, 'id');
let colors = pluck(family, 'color');

console.log(names);
// Logs: ['Karl', 'Sara', 'Ben', 'Lucy']

console.log(ids);
// Logs: ['dad', 'mom', 'son', 'daughter']

console.log(colors);
// Logs: [null, 'blue', 'green', null]

shuffle(els) ⇒ array

Fisher-Yates (aka Knuth) shuffle. Takes an array of elements and returns the same array, but with its elements shuffled

Returns: array - The array passed to arr, shuffled

See: knuth-shuffle

merge(...arrays) ⇒ array

Merge two or more arrays into a single, new array.

Returns: array - A new merged array

collapse()

Deprecated

See: merge instead

intersect(array1, array2, prop) ⇒ array

Return a subset of array1, only including elements from array2 that are also in array1.

• If prop is provided, only that property of an element needs to match for the two arrays to be considered intersecting at that element

Returns: array - A new filtered array

Example

const array1 = [{name: 'Foo', id: 'a'}, {name: 'Bar', id: 'b'}];
const array2 = [{name: 'Foo', id: 'z'}, {name: 'Zippy', id: 'b'}];

console.log(intersect(array1, array2, 'name'));
// Logs [{name: 'Foo', id: 'a'}]

console.log(intersect(array1, array2, 'id'));
// Logs [{name: 'Bar', id: 'b'}]

unique(arr, prop) ⇒ array

Take an array of elements and return an array containing unique elements. If an element is an object or array:

• when prop is undefined, uses JSON.stringify() when checking the elements
• when prop is provided, only that property needs to match for the element to be considered a duplicate and thus excluded from the returned array

Returns: array - A new filtered array

Example

const array1 = [1, 2, 3, 2, 5, 1];
const uniq = unique(array1);
console.log(uniq);
// Logs: [1, 2, 3, 5]

diff(array1, array2, prop) ⇒ array

Return a subset of array1, only including elements that are NOT also in array2. The returned array won't include any elements from array2. If an element is an object or array:

• when prop is undefined, uses JSON.stringify() when performing the comparison on an object or array
• when prop is provided, only that property needs to match for the item to be excluded fom the returned array

Returns: array - A filtered array

Example

const array1 = [1, 2, 3, 4];
const array2 = [2, 3, 5, 6, -1];
console.log(diff(array1, array2));
// Logs: [1, 4]

chunk(arr, n) ⇒ array

From an array passed into the first argument, create an array of arrays, each one consisting of n items. (The final nested array may have fewer than n items.)

Returns: array - A new, chunked, array

range(a, b) ⇒ array

Create an array of numbers from 0 to a - 1 (if b not provided) or from a to b (if b is provided).

Returns: array - A new array of numbers

pad(arr, size, value) ⇒ array

Pad an array with value until its length equals size

Returns: array - The array passed to arr, padded

sort(arr, prop, options) ⇒ array

Sort an array with sensible defaults: numbers (or numeric strings) before letters and case and diacritics ignored

Returns: array - The sorted array

color

ESM Import Example

import {rgb2Hex} from 'ksjs'

// or:
import {rgb2Hex} from 'ksjs/color.mjs'
// or:
import {rgb2Hex} from 'ksjs/color.js'

CJS Require Example

const {rgb2Hex} = require('ksjs/color.cjs');
// or:
const {rgb2Hex} = require('ksjs/cjs/color.js');

• color
  • static
    • hex2Rgb
  • inner
    • rgb2Hex(rgb) ⇒ string
    • rgba2Hex(rgba) ⇒ string
    • rgb2Luminance(rgb) ⇒ number
    • getContrastColor(bgColor, [darkColor], [lightColor]) ⇒ string

hex2Rgb

Convert a hex value to an rgb or rgba value

rgb2Hex(rgb) ⇒ string

Convert an rgb value to a 6-digit hex value. If an rgba value is passed, the opacity is ignored

Returns: string - Hex value (e.g. #ff780a)

Example

rgb2Hex('rgb(255, 136, 0)')
// => '#ff8800'

rgb2Hex([255, 136, 0])
// => '#ff8800'

rgb2Hex('rgba(255, 136, 0, .8)')
// => '#ff8800'

rgba2Hex(rgba) ⇒ string

Convert an rgba value to an 8-digit hex value, or an rgb value to a 6-digit hex value

Returns: string - Hex value (e.g. #ff780a80)

Example

rgba2Hex('rgba(255, 136, 0, .8)')
// => '#ff8800cc'

rgba2Hex([255, 136, 0, .8])
// => '#ff8800cc'

rgba2Hex('rgb(255, 136, 0)')
// => '#ff8800'

rgb2Luminance(rgb) ⇒ number

Convert an RGB color to a luminance value. You probably don't want to use this on its own

Returns: number - The luminance value

See

• getContrastColor()
• StackOverflow for more information

getContrastColor(bgColor, darkColor, lightColor) ⇒ string

Return darkColor if bgColor is light and lightColor if bgColor is dark. "Light" and "dark" are determined by the rgb2Luminance algorithm

Returns: string - Contrasting color

• Warning: untested

cookie

ESM Import Example:

import {getCookie} from 'ksjs';

// or:
import {getCookie} from 'ksjs/cookie.mjs';
// or:
import {getCookie} from 'ksjs/cookie.js';

• cookie
  • getCookie(name) ⇒ string
  • setCookie(name, value, [options]) ⇒ string
  • removeCookie(name, [path])

getCookie(name) ⇒ string

Get the value of a cookie

Returns: string - value The value of the cookie

setCookie(name, value, options) ⇒ string

Set the value of a cookie. Use either expires or maxAge (or max-age). NOT BOTH.

Returns: string - The new cookie

removeCookie(name, path)

Remove a cookie

dom

ESM Import Example:

import {addClass} from 'ksjs';

// or:
import {addClass} from 'ksjs/dom.mjs';
// or:
import {addClass} from 'ksjs/dom.js';

• dom
  • toNodes(element(s)) ⇒ array
  • \$(selector, [context]) ⇒ Array
  • \$1(selector, [context]) ⇒ Element
  • addClass(el, className, [...classNameN]) ⇒ string
  • removeClass(el, className, [...classNameN]) ⇒ string
  • toggleClass(el, className, [toggle]) ⇒ string
  • replaceClass(el, oldClass, newClass) ⇒ string
  • getOffset(el) ⇒ Object
  • setStyles(el, styles) ⇒ Element
  • setAttrs(el, attrs) ⇒ Element
  • getAttrs(el, attrs) ⇒ Object
  • toggleAttr(el, attribute, [toggle]) ⇒ string
  • insertHTML(element, position, toInsert)
  • prepend(el, toInsert) ⇒ Element
  • append(el, toInsert) ⇒ Element
  • before(el, toInsert) ⇒ Element
  • after(el, toInsert) ⇒ Element
  • createTree(options) ⇒ Element(s)
  • createHTML(options) ⇒ Element(s)
  • remove(el) ⇒ Element
  • empty(el) ⇒ Element
  • replace(oldEl, replacement)
  • loadScript(options) ⇒ Promise

toNodes(element(s)) ⇒ array

Converts a selector string, DOM element, or collection of DOM elements into an array of DOM elements

Returns: array - An array of DOM elements

$(selector, context) ⇒ Array

Return an array of DOM Nodes within the document or provided element/nodelist

Returns: Array - Array of DOM nodes matching the selector within the context

$1(selector, context) ⇒ Element

Return the first found DOM Element within the document or provided element/nodelist/HTMLCollection

Returns: Element - First DOM Element matching the selector within the context

addClass(el, className, ...classNameN) ⇒ string

Add one or more classes to an element

Returns: string - the resulting class after classes have been removed

removeClass(el, className, ...classNameN) ⇒ string

Remove one or more classes from an element

Returns: string - the resulting class after classes have been removed

toggleClass(el, className, toggle) ⇒ string

Add a class if it's not present (or if toggle is true); remove the class if it is present (or if toggle is false)

Returns: string - The className property of the element after the class has been toggled

replaceClass(el, oldClass, newClass) ⇒ string

Replace oldClass with newClass

Returns: string - The className property of the element after the class has been replaced

getOffset(el) ⇒ Object

Get the top and left distance to the element (from the top of the document)

Returns: Object - Object with top and left properties representing the top and left offset of the element

• Warning: untested

setStyles(el, styles) ⇒ Element

Set one or more styles on an element.

Returns: Element - The original element, with the styles set

setAttrs(el, attrs) ⇒ Element

Set one or more attributes on an element. For boolean attributes ('async', 'required', etc.), set the element's property to either true or false

Returns: Element - The original element, with the attributes set

getAttrs(el, attrs) ⇒ Object

Given an array of attribute names, get an object containing attribute names/values for an element

Returns: Object - Object of attribute names along with their values

toggleAttr(el, attribute, toggle) ⇒ string

Add an attribute to an element if it's not present (or if toggle is true); remove the attribute if it is present (or if toggle is false)

Returns: string - The attribute name if it has been added, undefined if it has been removed

insertHTML(element, position, toInsert)

prepend(el, toInsert) ⇒ Element

Insert an element as the first child of el

Returns: Element - The inserted element

append(el, toInsert) ⇒ Element

Insert an element as the last child of el

Returns: Element - The inserted element

before(el, toInsert) ⇒ Element

Insert an element as the previous sibling of el

Returns: Element - The inserted element

after(el, toInsert) ⇒ Element

Insert an element as the next sibling of el

Returns: Element - The inserted element

createTree(options) ⇒ Element(s)

Provide an object, along with possible child objects, to create a node tree ready to be inserted into the DOM.

Returns: Element(s) - The created Element node tree

createHTML(options) ⇒ Element(s)

Provide an object, along with possible child objects, to create an HTML string that can be inserted into the DOM.

Returns: Element(s) - The created Element node tree

remove(el) ⇒ Element

Remove an element from the DOM

Returns: Element - DOM element removed from the DOM

empty(el) ⇒ Element

Empty an element's children from the DOM

Returns: Element - DOM element provided by el argument

replace(oldEl, replacement)

Replace a DOM element with one or more other elements

loadScript(options) ⇒ Promise

Insert a script into the DOM with reasonable default properties, returning a promise. If options.id is set, will avoid loading script if the id is already in the DOM.

Returns: Promise - Promise that is either resolved or rejected. If options.id is NOT provided or if no element exists with id of options.id, promise is resolved when script is loaded. If options.id IS provided and element with same id exists, promise is resolved or rejected (depending on options.onDuplicateId) with no attempt to load new script.

event

ESM Import Example:

import {addEvent} from 'ksjs';

// or:
import {addEvent} from 'ksjs/event.mjs';
// or:
import {addEvent} from 'ksjs/event.js';

• event
  • addEvent(el, type, handler(event), [options])
  • removeEvent(el, type, [handler], [options])
  • triggerEvent(el, type, detail)

addEvent(el, type, handler(event), options)

A wrapper around addEventListener that deals with browser inconsistencies (e.g. capture, passive, once props on options param; see param documentation below for details) and handles window load similar to how jQuery handles document ready by triggering handler immediately if called after the event has already fired. For triggering window load, this file MUST be imported before window.load occurs.

removeEvent(el, type, handler, options)

A wrapper around removeEventListener that naïvely deals with oldIE inconsistency.

triggerEvent(el, type, detail)

Trigger a custom event on an element for which a listener has been set up

Derived from emitEvent(): (c) 2019 Chris Ferdinandi, MIT License, https://gomakethings.com

Example

// Using this module's addEvent() function
// Add a custom event handler
addEvent(document.body, 'myCustomEvent', (event) => console.log(event.detail.weather));

// Later…
// Trigger the custom event
triggerEvent(document.body, 'myCustomEvent', {weather: 'sunshine'});
// Logs: 'sunshine'

form

ESM Import Example:

import {getFormData} from 'ksjs';

// or:
import {getFormData} from 'ksjs/form.mjs';
// or:
import {getFormData} from 'ksjs/form.js';

• form
  • getFormData ⇒ any
  • valuesToFormData(values) ⇒ FormData

getFormData ⇒ any

Return the set of successful form controls of the provided form element in one of four types: object, string, formData, or array.

Returns: any - The set of successful form controls as the provided type

Methods

Example

const myform = document.getElementById('myform');

console.log(getFormData.object(myform));
// Logs:
// {
//    email: 'name@example.com',
//    gender: 'female',
//    meals: ['breakfast', 'dinner']
// }

Example

const myform = document.getElementById('myform');

console.log(getFormData.string(myform));
// Logs:
// email=name%40example.com&gender=female&meals[]=breakfast&meals[]=dinner

Example

const myform = document.getElementById('myform');

console.log(getFormData.array(myform));
// Logs:
// [
//    {
//      name: 'email',
//      value: 'name@example.com'
//    },
//    {
//      name: 'gender',
//      value: 'femail'
//    },
//    {
//      name: 'meals[]',
//      value: 'breakfast'
//    },
//    {
//      name: 'meals[]',
//      value: 'dinner'
//    }
// ]

valuesToFormData(values) ⇒ FormData

Note: if the value of a key is an object with a files property, each file in the files array will be appended to the FormData object.

Returns: FormData - The form data object

jsonp

ESM Import Example:

import {getJSONP} from 'ksjs';

// or:
import {getJSONP} from 'ksjs/jsonp.mjs';
// or:
import {getJSONP} from 'ksjs/jsonp.js';

getJSONP(options, callback(json))

Function for those times when you just need to make a "jsonp" request (and you can't set up CORS on the server). In other words, x-site script grabbing.

• Warning: untested
• Warning: requires setup on server side
• Warning: not entirely safe

Example

getJSONP({url: 'https://example.com/api/'})

math

ESM Import Example:

import {median} from 'ksjs';

// or:
import {median} from 'ksjs/math.mjs';
// or:
import {median} from 'ksjs/math.js';

CommonJS Require Example:

const {median} = require('ksjs/math.cjs');
// or:
const {median} = require('ksjs/cjs/math.js');

• math
  • add(array) ⇒ number
  • subtract(array) ⇒ number
  • multiply(array) ⇒ number
  • divide(array) ⇒ number
  • mod(dividend, [divisor]) ⇒ number
  • average(nums) ⇒ number
  • median(nums) ⇒ number
  • min(nums) ⇒ number
  • max(nums) ⇒ number

add(array) ⇒ number

Return the result of adding an array of numbers (sum)

Returns: number - Sum

subtract(array) ⇒ number

Return the result of subtracting an array of numbers (difference)

Returns: number - Difference

multiply(array) ⇒ number

Return the result of multiplying an array of numbers (product)

Returns: number - Product

divide(array) ⇒ number

Return the result of dividing an array of numbers (quotient)

Returns: number - Quotient

mod(dividend, divisor) ⇒ number

Return the remainder after dividing two numbers (modulo)

Returns: number - Remainder

average(nums) ⇒ number

Return the average of an array of numbers

Returns: number - Average

median(nums) ⇒ number

Return the median of an array of numbers

Returns: number - Median

min(nums) ⇒ number

Return the number with the lowest value from an array of numbers

Returns: number - Minimum value

max(nums) ⇒ number

Return the number with the highest value from an array of numbers

Returns: number - Maximum value

object

ESM Import Example:

import {deepCopy} from 'ksjs';

// or:
import {deepCopy} from 'ksjs/object.mjs';
// or:
import {deepCopy} from 'ksjs/object.js';

CommonJS Require Example:

import {deepCopy} from 'ksjs/object.cjs';
// or:
const {deepCopy} = require('ksjs/cjs/object.js');

• object
  • isObject(obj)
  • isPlainObject(obj)
  • clone(obj) ⇒ Object
  • deepCopy(obj, [forceFallback], [cache]) ⇒ Object
  • isDeepEqual(objectA, objectB) ⇒ Boolean
  • extend(target, ...objects) ⇒ Object
  • getProperty(root, properties, fallbackValue) ⇒ *
  • getLastDefined(root, properties) ⇒ *
  • isEmptyObject(obj) ⇒ boolean
  • setProperty(root, properties, value) ⇒ Object
  • forEachValue(obj, fn) ⇒ void
  • getObject(obj, options)
  • pick(obj, props, [options]) ⇒ Object
  • omit(obj, props, [options]) ⇒ Object

isObject(obj)

Indicate if the provided argument is an object/array

isPlainObject(obj)

Indicate if the provided argument is a plain object Derived from lodash _.isPlainObject

clone(obj) ⇒ Object

Deep copy an object (alternative to deepCopy), using graph theory and new Map(). Avoids circular refs and infinite loops.

Returns: Object - A copy of the object

See: Cloning JavaScript objects with Graph Theory

deepCopy(obj, forceFallback, cache) ⇒ Object

Deep copy an object, avoiding circular references and the infinite loops they might cause.

Returns: Object - A copy of the object

isDeepEqual(objectA, objectB) ⇒ Boolean

Compare two items for equality, recursing through nested objects or arrays

Returns: Boolean - True if the items are deeply equal, false otherwise

extend(target, ...objects) ⇒ Object

Deep merge two or more objects in turn, with right overriding left

Heavily influenced by/mostly ripped off from jQuery.extend

Returns: Object - The merged object

Example

const foo = {
  one: 'singular',
  two: 'are better'
};

const bar = {
  one: 'taste',
  choco: 'hershey',
  saloon: 'wild west',
};

const merged = extend(foo, bar);

// merged is now:
// {
//  one: 'taste',
//  two: 'are better',
//  choco: 'hershey',
//  saloon: 'wild west',
// }


// because foo was mutated, it is also:
// {
//  one: 'taste',
//  two: 'are better',
//  choco: 'hershey',
//  saloon: 'wild west',
// }

getProperty(root, properties, fallbackValue) ⇒ *

Get a nested property of an object in a safe way

Returns: * - The value of the nested property, or undefined, or the designated fallback value

Example

const foo = {
  could: {
   keep: {
    going: 'but will stop'
  }
};

console.log(getProperty(foo, 'could.keep.going'))
// Logs: 'but will stop'

console.log(getProperty(foo, ['could', 'keep', 'going']))
// Logs: 'but will stop'

console.log(getProperty(foo, ['broken', 'not', 'happening']))
// Logs: undefined
};

getLastDefined(root, properties) ⇒ *

Get a nested property of an object in a safe way

Returns: * - The value of the last nested property referenced in properties arg that has a defined value

Example

const foo = {
  could: {
   keep: {
    going: 'but will stop'
  },
  shortStop: 'ride ends here'
};

console.log(getLastDefined(foo, 'could.keep.going'))
// Logs: 'but will stop'

console.log(getLastDefined(foo, ['shortStop', 'stops', 'short']))
// Logs: 'ride ends here'
};

isEmptyObject(obj) ⇒ boolean

Determine whether an object (or array) is "empty"

Returns: boolean - true if object has no keys or array no elements

setProperty(root, properties, value) ⇒ Object

Set a nested property of an object in a safe way

Returns: Object - The modified root object

forEachValue(obj, fn) ⇒ void

Loop through an object, calling a function for each element (like forEach, but for an object)

getObject(obj, options)

INTERNAL: Return either the same object passed in first parameter or a deep copy of the object, depending on the deep option.

pick(obj, props, options) ⇒ Object

Return a new object containing only the properties included in the props array.

Returns: Object - A copy of the object, containing only the props properties

omit(obj, props, options) ⇒ Object

Return a new object, excluding the properties in the props array.

Returns: Object - A modified copy of the object

promise

ESM Import Example:

import {peach} from 'ksjs';

// or:
import {peach} from 'ksjs/promise.mjs';
// or:
import {peach} from 'ksjs/promise.js';

CommonJS Require Example:

import {peach} from 'ksjs/promise.cjs';
// or:
const {peach} = require('ksjs/cjs/promise.js');

• promise
  • peach(arr, fn) ⇒ Array.<Promise>
  • pmap(arr, fn, [order]) ⇒ Promise
  • pfilter(arr, fn(item,index,array), [order]) ⇒ Promise
  • ArrayCallback ⇒ Promise

peach(arr, fn) ⇒ Array.<Promise>

"Promised each()" for iterating over an array of items, calling a function that returns a promise for each one. So, each one waits for the previous one to resolve before being called

Returns: Array.<Promise> - Array of promises

pmap(arr, fn, order) ⇒ Promise

"Promised map()" for iterating over an array of items sequentially (or in parallel), calling a function that returns either the Promise of a modified item or the modified item itself, ultimately returning a single resolved Promise containing the modified array.

Returns: Promise - A resolved Promise, fulfilled with an array containing the mapped items of arr

Example

import {pmap} from 'ksjs/promise.js';

const fruits = ['apple', 'banana', 'pear'];

const indexedFruits = pmap(fruits, (fruit, i) => {

});

pfilter(arr, fn(item,index,array), order) ⇒ Promise

"Promised filter()" to iterate over an array of items sequentially (or in parallel), which acts just like Array.prototype.filter() but allows the callback function to return either a Promise containing a truthy/falsy value or the truthy/falsy value itself. Returns a single resolved Promise containing the filtered array.

Returns: Promise - A resolved Promise, fulfilled with an array containing the mapped items of arr