siFunciona

All the siFunciona system functions for stringing together functions and simplifying logic.

stringHelpers

Manage how strings are manipulated with these utilities.

objectHelpers

Simplify working with object by providing array-like parsing. Also, provides cloning and merging along with accessors that always have a return value for optimal nesting.

numberHelpers

Some number comparators and random number generators.

functionHelpers

Manage how functions are called with these utilities.

objectDescriptors

Create a format to standardize every object into a specific template.

arrayHelpers

Some simple utility functions for generating arrays or performing work on arrays.

All the siFunciona system functions for stringing together functions and simplifying logic.

Version: 1.0.0
Author: Joshua Heagle joshuaheagle@gmail.com

Manage how strings are manipulated with these utilities.

Version: 1.0.0
Author: Joshua Heagle joshuaheagle@gmail.com

• stringHelpers
  • .words(str) ⇒ array
  • .ucFirst(str) ⇒ string
  • .titleCase(str) ⇒ string
  • .strBeforeLast(str, search) ⇒ string
  • .strBefore(str, search) ⇒ string
  • .strAfterLast(str, search) ⇒ string
  • .strAfter(str, search) ⇒ string
  • .snakeCase(str) ⇒ string
  • .regexEscape(str) ⇒ string
  • .makeRelativePath(fromFile, toFile) ⇒ string
  • .makeFilepath(root, [append]) ⇒ string
  • .kabobCase(str) ⇒ string
  • .camelCase(str) ⇒ string

Split a string into sets of numbers or letters.

Kind: static method of stringHelpers

Given a string, make the first character uppercase and the rest lowercase.

Kind: static method of stringHelpers

Given a string in kebab-case, snake_case, camelCase or 'Sentence case', convert to 'Title Case'.

Kind: static method of stringHelpers

Retrieve the string part after the last search match.

Kind: static method of stringHelpers

Retrieve the string part before the search match.

Kind: static method of stringHelpers

Retrieve the string part after the last search match.

Kind: static method of stringHelpers

Retrieve the string part after the search match.

Kind: static method of stringHelpers

Given a string in kebab-case, camelCase or 'Sentence case', convert to snake_case.

Kind: static method of stringHelpers

Take a string and escape the regex characters.

Kind: static method of stringHelpers

Compare two file paths and simplify them to a relative path.

Kind: static method of stringHelpers

Format the given path so that it does not have trailing slashes and also correctly appends a path.

Kind: static method of stringHelpers

Given a string in snake_case, camelCase or 'Sentence case', convert to kabob-case.

Kind: static method of stringHelpers

Given a string in kebab-case, snake_case or 'Sentence case', convert to camelCase.

Kind: static method of stringHelpers

Simplify working with object by providing array-like parsing. Also, provides cloning and merging along with accessors that always have a return value for optimal nesting.

Version: 1.0.0
Author: Joshua Heagle joshuaheagle@gmail.com

• objectHelpers
  • static
    • .mergeObjectsMutable ⇒ *
    • .mergeObjects ⇒ *
    • .setValue(key, value, item) ⇒ Object | Array
    • .setAndReturnValue(item, key, value) ⇒ *
    • .reduceObject(obj, fn, [initialValue]) ⇒ *
    • .objectValues(object, [includeInherited]) ⇒ Array
    • .objectKeys(object, [includeInherited]) ⇒ Array.<(string|number)>
    • .mergeObjectsBase([options]) ⇒ module:objectHelpers~mergeObjectsCallback | mergeObjectsCallback
    • .mapObject(obj, fn, [thisArg]) ⇒ Object | Array
    • .isObject(object) ⇒ boolean
    • .isInstanceObject(object) ⇒ boolean
    • .isCloneable(value) ⇒ boolean
    • .filterObject(obj, fn, [thisArg]) ⇒ Object | Array
    • .emptyObject(item) ⇒ boolean
    • .dotUnset(arrayObject, dotNotation) ⇒ Object
    • .dotSet(arrayObject, dotNotation, value) ⇒ Object
    • .dotNotate(arrayObject, [retainObjects]) ⇒ DotNotatedObject
    • .dotGet(arrayObject, dotNotation, [defaultValue]) ⇒ *
    • .cloneObject(object, [options]) ⇒ Object
  • inner
    • ~handleRetainObjects([retainObjects]) ⇒ function
    • ~performDotNotate(arrayObject, didRetain, [prepend], [results]) ⇒ DotNotatedObject

Uses mergeObjectsBase deep merge objects and arrays, merge by reference.

Kind: static constant of objectHelpers
See: module:objectHelpers~mergeObjectsCallback

Uses mergeObjectsBase deep merge objects and arrays, merge by value.

Kind: static constant of objectHelpers
See: module:objectHelpers~mergeObjectsCallback

Set a value on an item, then return the item. NOTE: Argument order designed for usage with pipe

Kind: static method of objectHelpers

Set a value on an item, then return the value

Kind: static method of objectHelpers

This function is intended to replicate behaviour of the Array.reduce() function but for Objects. If an array is passed in instead then it will perform standard reduce(). It is recommended to always use the standard reduce() function when it is known that the object is actually an array.

Kind: static method of objectHelpers

Get an array of values from any object or array. Will return empty array when invalid or there are no values. Optional flag will include the inherited values from prototype chain when set.

Kind: static method of objectHelpers

Get an array of keys from any object or array. Will return empty array when invalid or there are no keys. Optional flag will include the inherited keys from prototype chain when set.

Kind: static method of objectHelpers

Perform a deep merge of objects. This will return a function that will combine all objects and sub-objects. Objects having the same attributes will overwrite from last object to first. NOTE: Use the mapLimit and relevancyRange to resolve "too much recursion" when the object is large and is known to have circular references. A high mapLimit may lead to heavy memory usage and slow performance.

Kind: static method of objectHelpers

This function is intended to replicate behaviour of the Array.map() function but for Objects. If an array is passed in instead then it will perform standard map(). It is recommended to always use the standard map() function when it is known that the object is actually an array.

Kind: static method of objectHelpers

Check if the provided thing is an object / array.

Kind: static method of objectHelpers

Check if the current object has inherited properties.

Kind: static method of objectHelpers

Determine if the value is a reference instance

Kind: static method of objectHelpers

This function is intended to replicate behaviour of the Array.filter() function but for Objects. If an array is passed in instead then it will perform standard filter(). It is recommended to always use the standard filter() function when it is known that the object is actually an array.

Kind: static method of objectHelpers

Helper function for testing if the item is an Object or Array that does not have any properties

Kind: static method of objectHelpers

Unset a nested property value an object.

Kind: static method of objectHelpers
Returns: Object - The modified object

Set a nested property value an object.

Kind: static method of objectHelpers
Returns: Object - The modified object

Convert an array or object to a single dimensional associative array with dot notation.

Kind: static method of objectHelpers
Returns: DotNotatedObject - The dot-notated object

Get a nested property value from an object.

Kind: static method of objectHelpers
Returns: * - The value of the property

Clone objects for manipulation without data corruption, returns a copy of the provided object. NOTE: Use the mapLimit and relevancyRange to resolve "too much recursion" when the object is large and is known to have circular references. A high mapLimit may lead to heavy memory usage and slow performance.

Kind: static method of objectHelpers

Convert an array of keys into a regex, return a function to test if incoming keys match.

Kind: inner method of objectHelpers
Returns: function - The dot-notated array

The underlying logic function for converting arrays to dot-notation.

Kind: inner method of objectHelpers
Returns: DotNotatedObject - The dot-notated object

Some number comparators and random number generators.

Version: 1.0.0
Author: Joshua Heagle joshuaheagle@gmail.com

• numberHelpers
  • .randomNumber(range, [offset], [interval]) ⇒ number
  • .randomInteger(range, [offset], [interval]) ⇒ number
  • .compare(val1, val2) ⇒ number
  • .absoluteMin(num1, num2) ⇒ number
  • .absoluteMax(num1, num2) ⇒ number

Create a single random number within provided range. And with optional offset, The distance between the result numbers can be adjusted with interval.

Kind: static method of numberHelpers

Create a single random integer within provide range. And with optional offset, The distance between the result numbers can be adjusted with interval.

Kind: static method of numberHelpers

Compare two numbers and return: -1 to indicate val1 is less than val2 0 to indicate both values are the equal 1 to indicate val1 is greater than val2

Kind: static method of numberHelpers

Helper for returning the absolute min value

Kind: static method of numberHelpers

Helper for returning the absolute max value

Kind: static method of numberHelpers

Manage how functions are called with these utilities.

Version: 1.0.0
Author: Joshua Heagle joshuaheagle@gmail.com

• functionHelpers
  • .trace(label, useClone) ⇒ function
  • .relevancyFilter(map, [options]) ⇒ relevanceMap
  • .queueTimeout([queueManagerHandle]) ⇒ module:functionHelpers~queueTimeoutHandle
  • .queueManager([queue]) ⇒ module:functionHelpers~queueManagerHandle
    • ~makeQueuedRunnable(resolve, reject, fn, ...args) ⇒ queuedRunnable
    • ~postRun(result) ⇒ *
    • ~runNextItem() ⇒ IteratorYieldResult | null
    • ~pushAnother(fn, ...args) ⇒
  • .preloadParams(fn, params, [unassignedParam]) ⇒ module:functionHelpers~callWithMissing
  • .pipe(...fns) ⇒ *
  • .onBodyLoad(callback, [reset]) ⇒ Array.<function()>
  • .makeBasicQueue(initialQueue) ⇒ IsQueue
  • .delay(time) ⇒ module:functionHelpers~delayHandler
  • .curry(fn) ⇒ function | *
  • .callWithParams(fn, params, [minimum]) ⇒ *

Output the value with label to the console and return the value to not interrupt the code.

Kind: static method of functionHelpers

Remove elements out of relevance range and update the max relevance.

Kind: static method of functionHelpers

Manage functions to run sequentially with delays.

Kind: static method of functionHelpers

Manage functions to run sequentially.

Kind: static method of functionHelpers

• .queueManager([queue]) ⇒ module:functionHelpers~queueManagerHandle
  • ~makeQueuedRunnable(resolve, reject, fn, ...args) ⇒ queuedRunnable
  • ~postRun(result) ⇒ *
  • ~runNextItem() ⇒ IteratorYieldResult | null
  • ~pushAnother(fn, ...args) ⇒

Convert a function to a queueable object.

Kind: inner method of queueManager

After an item is run, THEN run this function to reset isRunning

Kind: inner method of queueManager

When ready, runs the next queued runnable generator.

Kind: inner method of queueManager

Add a function into the queue to be run when ready.

Kind: inner method of queueManager
Returns: Promise

Provide an array of parameters to be used with a function, allow the function to be called later with the missing parameter.

Kind: static method of functionHelpers

Take one or more function with a single parameter and return value. Pass a parameter and the value will be transformed by each function then returned.

Kind: static method of functionHelpers

Prepare functions to be called once the body is available.

Kind: static method of functionHelpers

Create an instance of a basic queue.

Kind: static method of functionHelpers

Provide a timeout which returns a promise.

Kind: static method of functionHelpers

Return a curried version of the passed function. The returned function expects the same number of arguments minus the ones provided. fn is the name of the function being curried.

Kind: static method of functionHelpers

Given a function, call with the correct number of parameters from an array of possible parameters.

Kind: static method of functionHelpers

Create a format to standardize every object into a specific template.

Version: 1.0.0
Author: Joshua Heagle joshuaheagle@gmail.com

• objectDescriptors
  • .mappedDescriptorMap : module:objectDescriptors~descriptorMap
  • .descriptorMapSample : module:objectDescriptors~descriptorMap
  • .descriptorDetailSample : module:objectDescriptors~descriptorDetail
  • .descriptorSample : module:objectDescriptors~descriptor
  • .sameDescriptor(descriptor1, descriptor2) ⇒ boolean
  • .nextReference(descriptor, currentReference) ⇒ number | undefined
  • .describeObjectMap(object, [options]) ⇒ module:objectDescriptors~descriptorMap
  • .describeObjectDetail(value, [key], [index]) ⇒ module:objectDescriptors~descriptorDetail
  • .describeObject(object) ⇒ module:objectDescriptors~descriptor
  • .compareDescriptor(descriptor1, descriptor2) ⇒ boolean
  • .cloneDescriptorDetail(originalDetail) ⇒ module:objectDescriptors~descriptorDetail
  • .cloneDescriptor(originalMap) ⇒ module:objectDescriptors~descriptor
  • .checkDescriptorComplete(descriptor) ⇒ module:objectDescriptors~descriptor
  • .checkClearValues(descriptor, [keepValues]) ⇒ module:objectDescriptors~descriptor
  • .assignDescriptorDetail(originalDetail, ...details) ⇒ module:objectDescriptors~descriptorDetail
  • .assignDescriptor(originalMap, ...descriptors) ⇒ module:objectDescriptors~descriptor

Kind: static constant of objectDescriptors

Kind: static constant of objectDescriptors

Kind: static constant of objectDescriptors

Kind: static constant of objectDescriptors

Check if the two descriptors are the same.

Kind: static method of objectDescriptors

Find the index of the next module:objectDescriptors.descriptorDetail to build a resource for.

Kind: static method of objectDescriptors

Trace out the entire object including nested objects.

Kind: static method of objectDescriptors

Trace an object's attribute and provide details about it.

Kind: static method of objectDescriptors

Trace an object and return the descriptor which defines the object's structure and attributes.

Kind: static method of objectDescriptors

Check if two descriptors are the same or similar in that they have similar keys and the associated types are the same.

Kind: static method of objectDescriptors

Get a new copy of an existing Descriptor Detail

Kind: static method of objectDescriptors

Make a copy of an object descriptor so that the original will not be mutated.

Kind: static method of objectDescriptors

Check if the descriptors references have all been built and set complete to true if they have.

Kind: static method of objectDescriptors

Check if we should clear the values on this descriptor

Kind: static method of objectDescriptors

Assign properties from other details onto an existing detail.

Kind: static method of objectDescriptors

Apply one or more descriptors to an existing descriptor so that they represent a merged version of the descriptors.

Kind: static method of objectDescriptors

Some simple utility functions for generating arrays or performing work on arrays.

Version: 1.0.0
Author: Joshua Heagle joshuaheagle@gmail.com

• arrayHelpers
  • .BasicQueue
    • .dequeue() ⇒ queuedItem | *
    • .empty() ⇒ boolean
    • .enqueue(data) ⇒ BasicQueue
    • .peek() ⇒ queuedItem | *
    • .size() ⇒ number
  • .uniqueArray(array) ⇒ Array
  • .mergeArrays(...arrays) ⇒ Array
  • .compareArrays(...arrays) ⇒ Array.<module:arrayHelpers~compareArrayResult>
  • .buildArrayOfReferences(item, length) ⇒ Array.<*>
  • .buildArray(item, length) ⇒ Array.<*>
  • .addUniqueToArray(item, array) ⇒ Array

Class BasicQueue is a functional example of a queue to be used with queueManager.

Kind: static class of arrayHelpers

• .BasicQueue
  • .dequeue() ⇒ queuedItem | *
  • .empty() ⇒ boolean
  • .enqueue(data) ⇒ BasicQueue
  • .peek() ⇒ queuedItem | *
  • .size() ⇒ number

Remove and return the next item in the queue

Kind: instance method of BasicQueue

Check if the queue is empty

Kind: instance method of BasicQueue

Add an item to the end of the queue

Kind: instance method of BasicQueue

Retrieve the next item from the queue

Kind: instance method of BasicQueue

Get the quantity of items in the queue

Kind: instance method of BasicQueue

Remove duplicate values from an array. uniqueArray

Kind: static method of arrayHelpers

Take multiple arrays and then filter all these into one unique array.

Kind: static method of arrayHelpers

Compare two Arrays and return the Object where the value for each property is as follows: -1 to indicate val1 is less than val2 0 to indicate both values are the equal 1 to indicate val1 is greater than val2 The returned Object uses the element values as the property names This functions works by first creating a concatenated array of all unique values. Then for each unique values, convert to a string and use it as a new property name. Array filter each array checking if it has the unique value. Use the lengths of these filtered arrays to compare. So if the first array has the value and the second one doesn't the first length will be one or more and the second will be zero, if the both have the value then both will be one or more.

Kind: static method of arrayHelpers

Example

// example of input and resulting output
compareArrays(
  ['match1', 'firstMismatch1', 'match2', 'firstMismatch2', 'badMatch1'],
  ['match1', 'match2', 'secondMismatch1', 'badMatch1', 'badMatch1']
)
// unique array
['match1', 'firstMismatch1', 'match2', 'firstMismatch2', 'badMatch1', 'secondMismatch1']
// result object
[
  {
    value: 'match1',
    keys: [[0], [0]],
    result: [0, 0]
  },
  {
    value: 'firstMismatch1',
    keys: [[1], []],
    result: [1, -1]
  },
  {
    value: 'match2',
    keys: [[2], [1]],
    result: [0, 0]
  },
  {
    value: 'firstMismatch2',
    keys: [[3], []],
    result: [1, -1]
  },
  {
    value: 'badMatch1',
    keys: [[4], [3, 4]],
    result: [0, 0]
  },
  {
    value: 'secondMismatch1',
    keys: [[], [2]],
    result: [-1, 1]
  }
]

Leverage buildArrayBase to generate an array filled with references to the provided item. The length defines how long the array should be.

Kind: static method of arrayHelpers

Leverage buildArrayBase to generate an array filled with a copy of the provided item. The length defines how long the array should be.

Kind: static method of arrayHelpers

Having an array and a potential new array element, check if the element is in the array, if not append to array.

Kind: static method of arrayHelpers