Values of these types can be used as a seed.
Use this symbol to delete properies in deepObjectAssign.
Accelerate from zero velocity.
Time.
Value at time t.
Accelerate until halfway, then decelerate.
Time.
Value at time t.
Accelerate until halfway, then decelerate.
Time.
Value at time t.
Accelerate until halfway, then decelerate.
Time.
Value at time t.
Accelerate until halfway, then decelerate.
Time.
Value at time t.
Accelerate from zero velocity.
Time.
Value at time t.
Accelerate from zero velocity.
Time.
Value at time t.
Accelerate from zero velocity.
Time.
Value at time t.
Decelerate to zero velocity.
Time.
Value at time t.
Decelerate to zero velocity.
Time.
Value at time t.
Decelerate to zero velocity.
Time.
Value at time t.
Decelerate to zero velocity.
Time.
Value at time t.
Provides no easing and no acceleration.
Time.
Value at time t.
Convert a value into a boolean.
Value to be converted intoboolean, a function will be executed as (() => unknown).
If the value or the return value of the function == null then this will be returned.
Corresponding boolean value, if none then the default value, if none then null.
Convert a value into a DOM Element.
Value to be converted into DOM Element, a function will be executed as (() => unknown).
If the value or the return value of the function == null then this will be returned.
The DOM Element, if none then the default value, if none then null.
Convert a value into a number.
Value to be converted intonumber, a function will be executed as (() => unknown).
If the value or the return value of the function == null then this will be returned.
Corresponding boxed number value, if none then the default value, if none then null.
Convert a value into a size.
Value to be converted intosize, a function will be executed as (() => unknown).
If the value or the return value of the function == null then this will be returned.
Corresponding string value (number + 'px'), if none then the default value, if none then null.
Convert a value into a string.
Value to be converted intostring, a function will be executed as (() => unknown).
If the value or the return value of the function == null then this will be returned.
Corresponding boxed string value, if none then the default value, if none then null.
Convert HSV <0, 1> into hex color string.
Hue.
Saturation.
Value.
Hex color string.
Convert HSV <0, 1> into RGB color object.
Hue.
Saturation.
Value.
RGB color object.
Convert RGB <0, 255> into HSV object.
Red channel.
Green channel.
Blue channel.
HSV color object.
Convert RGB <0, 255> into hex color string.
Red channel.
Green channel.
Blue channel.
Hex color string (for example: '#0acdc0').
Add a className to the given elements style.
The element to which the classes will be added.
Space separated list of classes.
Append a string with css styles to an element.
The element that will receive new styles.
The styles to be appended.
Add and event listener. Works for all browsers.
The element to bind the event listener to.
Same as Element.addEventListener(action, —, —).
Same as Element.addEventListener(—, listener, —).
Same as Element.addEventListener(—, —, useCapture).
This function does a binary search for a visible item in a sorted list. If we find a visible item, the code that uses this function will then iterate in both directions over this sorted list to find all visible items.
Items ordered by start.
-1 is lower, 0 is equal, 1 is higher.
Property name on an item (That is item[field]).
Second property name on an item (That is item[field][field2]).
Index of the found item or -1 if nothing was found.
This function does a binary search for a visible item in a sorted list. If we find a visible item, the code that uses this function will then iterate in both directions over this sorted list to find all visible items.
Items ordered by start.
-1 is lower, 0 is equal, 1 is higher.
Property name on an item (That is item[field]).
Index of the found item or -1 if nothing was found.
This function does a binary search for a specific value in a sorted array. If it does not exist but is in between of two values, we return either the one before or the one after, depending on user input If it is found, we return the index, else -1.
Sorted array.
The searched value.
Name of the property in items to be searched.
If the target is between two values, should the index of the before or the after be returned?
An optional comparator, returning -1, 0, 1 for <, ===, >.
The index of found value or -1 if nothing was found.
This recursively redirects the prototype of JSON objects to the referenceObject. This is used for default options.
The original object.
The Element if the referenceObject is an Element, or a new object inheriting from the referenceObject.
This recursively redirects the prototype of JSON objects to the referenceObject. This is used for default options.
The original object.
The Element if the referenceObject is an Element, or a new object inheriting from the referenceObject.
Used to extend an array and copy it. This is used to propagate paths recursively.
First part.
The value to be aadded into the array.
A new array with all items from arr and newValue (which is last).
Used to extend an array and copy it. This is used to propagate paths recursively.
First part.
The value to be aadded into the array.
A new array with all items from arr and newValue (which is last).
Used to extend an array and copy it. This is used to propagate paths recursively.
The array to be copied.
Shallow copy of arr.
Deep extend an object a with the properties of object b.
Target object.
Source object.
If true, the prototype values will also be extended. (That is the options objects that inherit from others will also get the inherited options).
If true, the values of fields that are null will be deleted.
Argument a.
Deep version of object assign with additional deleting by the DELETE symbol.
The object that will be augmented using the sources.
Objects to be deeply merged into the target.
The target (same instance).
Test whether all elements in two arrays are equal.
First array.
Second array.
True if both arrays have the same length and same elements (1 = '1').
Copy the values of all of the enumerable own properties from one or more source objects to a target object. Returns the target object.
The target object to copy to.
The source object from which to copy properties.
The target object.
Copy the values of all of the enumerable own properties from one or more source objects to a target object. Returns the target object.
The target object to copy to.
The target object.
Copy the values of all of the enumerable own properties from one or more source objects to a target object. Returns the target object.
The target object to copy to.
The target object.
Copy the values of all of the enumerable own properties from one or more source objects to a target object. Returns the target object.
The target object to copy to.
The target object.
Fill an object with a possibly partially defined other object.
Only copies values for the properties already present in a. That means an object is not created on a property if only the b object has it.
The object that will have it's properties updated.
The object with property updates.
If true, delete properties in a that are explicitly set to null in b.
For each method for both arrays and objects. In case of an array, the built-in Array.forEach() is applied (No, it's not!). In case of an Object, the method loops over all properties of the object.
Array.forEach-like callback.
For each method for both arrays and objects. In case of an array, the built-in Array.forEach() is applied (No, it's not!). In case of an Object, the method loops over all properties of the object.
An Object or Array to be iterated over.
Array.forEach-like callback.
Retrieve the absolute left value of a DOM element.
A dom element, for example a div.
The absolute left position of this element in the browser page.
Retrieve the absolute right value of a DOM element.
A dom element, for example a div.
The absolute right position of this element in the browser page.
Retrieve the absolute top value of a DOM element.
A dom element, for example a div.
The absolute top position of this element in the browser page.
Experimentaly compute the width of the scrollbar for this browser.
The width in pixels.
Get HTML element which is the target of the event.
The event.
The element or null if not obtainable.
Get the type of an object, for example exports.getType([]) returns 'Array'.
Input value of unknown type.
Detected type.
Check if given element contains given parent somewhere in the DOM tree.
The element to be tested.
The ancestor (not necessarily parent) of the element.
True if parent is an ancestor of the element, false otherwise.
Convert hex color string into HSV <0, 1>.
Hex color string.
HSV color object.
Convert hex color string into RGB color object.
Hex color string (3 or 6 digits, with or without #).
RGB color object.
This method provides a stable sort implementation, very fast for presorted data.
The array to be sorted (in-place).
An order comparator.
The argument a.
Test whether given object is a Date, or a String containing a Date.
Input value of unknown type.
True if Date instance or string date representation, false otherwise.
Test whether given object is a number.
Input value of unknown type.
True if number, false otherwise.
Test whether given object is a object (not primitive or null).
Input value of unknown type.
True if not null object, false otherwise.
Test whether given object is a string.
Input value of unknown type.
True if string, false otherwise.
Validate hex color string.
Unknown string that may contain a color.
True if the string is valid, false otherwise.
Validate RGB color string.
Unknown string that may contain a color.
True if the string is valid, false otherwise.
Validate RGBA color string.
Unknown string that may contain a color.
True if the string is valid, false otherwise.
This is used to set the options of subobjects in the options object.
A requirement of these subobjects is that they have an 'enabled' element which is optional for the user but mandatory for the program.
The added value here of the merge is that option 'enabled' is set as required.
Either this.options or the options used for the groups.
Options.
Option key in the options argument.
Global options, passed in to determine value of option 'enabled'.
This function takes string color in hex or RGB format and adds the opacity, RGBA is passed through unchanged.
The color string (hex, RGB, RGBA).
The new opacity.
RGBA string, for example 'rgba(255, 0, 127, 0.3)'.
Parse a color property into an object with border, background, and highlight colors.
Shorthand color string or input color object.
Color object.
Parse a color property into an object with border, background, and highlight colors.
Shorthand color string or input color object.
Color object.
Parse a color property into an object with border, background, and highlight colors.
Shorthand color string or input color object.
Color object.
Parse a color property into an object with border, background, and highlight colors.
Shorthand color string or input color object.
Full color object to fill in missing values in inputColor.
Color object.
Cancels the event's default action if it is cancelable, without stopping further propagation of the event.
The event whose default action should be prevented.
Pure version of deepObjectAssign, it doesn't modify any of it's arguments.
The base object that fullfils the whole interface T.
Updates that may change or delete props.
A brand new instance with all the supplied objects deeply merged.
Remove everything in the DOM object.
Node whose child nodes will be recursively deleted.
Remove a className from the given elements style.
The element from which the classes will be removed.
Space separated list of classes.
Remove a string with css styles from an element.
The element from which styles should be removed.
The styles to be removed.
Remove an event listener from an element.
The element to bind the event listener to.
Same as Element.removeEventListener(action, —, —).
Same as Element.removeEventListener(—, listener, —).
Same as Element.removeEventListener(—, —, useCapture).
This recursively redirects the prototype of JSON objects to the referenceObject. This is used for default options.
Names of properties to be bridged.
The original object.
A new object inheriting from the referenceObject.
Extend object a with selected properties of object b. Only properties with defined values are copied.
Names of first-level properties to copy over.
Target object.
Source object.
If true, delete property in a if explicitly set to null in b.
Argument a.
Extend object a with selected properties of object b or a series of objects.
Properties to be copied to a.
The target.
The sources.
Argument a.
Extend object a with properties of object b, ignoring properties which
are explicitly specified to be excluded.
Names of properties which should not be copied.
Object to extend.
Object to take properties from for extension.
If true, delete properties in a that are explicitly set to null in b.
Argument a.
Throttle the given function to be only executed once per animation frame.
The original function.
The throttled function.
Throttle the given function to be only executed once per animation frame.
The throttled function.
Convert an object into an array: all objects properties are put into the array. The resulting array is unordered.
Object that contains the properties and methods.
An array of unordered values.
Convert an object into an array: all objects properties are put into the array. The resulting array is unordered.
Object that contains the properties and methods.
An array of unordered values.
Get the top most property value from a pile of objects.
Array of objects, no required format.
Array of property names.
For example object['foo']['bar'] → ['foo', 'bar'].
Value of the property with given accessors path from the first pile item where it's not undefined.
Update a property in an object.
The object whose property will be updated.
Name of the property to be updated.
The new value to be assigned.
Whether the value was updated (true) or already strictly the same in the original object (false).
Generated using TypeDoc
Turns
undefinedintoundefined | typeof DELETEand makes everything partial. Intended to be used withdeepObjectAssign.