ObjectHelper

Checks that the supplied value is an array. Throws if it is not

Checks that the supplied value is a boolean. Throws if it is not

Checks that the supplied value is a Bryntum class. Throws if it is not

Checks that the supplied value is a function. Throws if it is not

Checks that the supplied value is an instance of a Bryntum class. Throws if it is not

Checks that the supplied value is a number. Throws if it is not

Checks that the supplied value is a plain object. Throws if it is not

Checks that the supplied value is a string. Throws if it is not

Checks that the supplied value is of the specified type.Throws if it is not

Copies all enumerable properties from the supplied source objects to dest. Unlike Object.assign, this copy also includes inherited properties.

Copies all enumerable properties from the supplied source objects to dest, only including properties that does not already exist on dest. Unlike Object.assign, this copy also includes inherited properties.

Changes the passed object and removes all null and undefined properties from it

Creates a deep copy of the value. Simple objects (isObject, arrays and Date objects are cloned. The enumerable properties of simple objects and the elements of arrays are cloned recursively.

Copies the named properties from the source parameter into the dest parameter.

Copies all properties from the source parameter into the dest parameter except those specified in except.

Copies the named properties from the source parameter into the dest parameter unless the property already exists in the dest.

Converts a list of names (either a space separated string or an array), into an object with those properties assigned truthy values. The converse of getTruthyKeys.

Returns an object retaining the enumerable key/value pairs for which the provided function fn returns a truthy value.

Calls a provided function fn for each key/value pair of a given object.

Returns a non-null entry from a Map for a given key path. This enables a specified defaultValue to be added "just in time" which is returned if the key is not already present.

Returns value for a given path in the object

Gathers the names of properties which have truthy values into an array.

This is useful when gathering CSS class names for complex element production. Instead of appending to an array or string which may already contain the name, and instead of contending with space separation and concatenation and conditional execution, just set the properties of an object:

cls = {
    [this.selectedCls] : this.isSelected(thing),
    [this.dirtyCls] : this.isDirty(thing)
};

If the source parameter is an array, it is returned. If it is a single string, it is wrapped in an array and returned. Otherwise, the value must be an object (or null) it will be processed as described above.

Gathers the values of properties which are truthy into an array.

Checks if two objects are deeply equal

Tests whether a passed object has any enumerable properties.

Checks if two values are equal. Basically === but special handling of dates.

Checks if value a is smaller than value b.

Checks if value a is bigger than value b.

Returns true if the value is a simple Object.

Checks if value B is partially equal to value A.

Returns an array containing all enumerable property names from every prototype level for the object. If object is null, this method returns an empty array.

Copies all enumerable properties from the supplied source objects to dest, recursing when the properties of both the source and dest are objects.

 const o = {
     a : 1,
     b : {
         c : 2
     }
 };
 const o2 = {
     b : {
         d : 3
     }
 }

 console.log(merge(o, o2));

 > { a : 1, b : { c : 2, d : 3 } }

Recursively wraps an object and all nested objects in Proxy instances. Invokes a callback whenever any property is mutated (set or deleted) at any depth.

This is useful for observing changes in complex objects, such as configuration objects, where you want to track changes to any property, no matter how deeply nested.

It is advisable to debounce the onChange callback to avoid performance issues with frequent updates.

Checks if a given path exists in an object

Changes the passed object and removes all properties from it. Used while mutating when need to keep reference to the object but replace its properties.

Round the passed number to the passed number of decimals.

Round the passed number to closest passed step value.

Sets value for a given path in the object

Number.toFixed(), with polyfill for browsers that needs it

Creates a new object where key is a property in array item (ref by default) or index in the array and value is array item.

From:

[
    {
         text : 'foo',
         ref : 'fooItem'
    },
    {
         text : 'bar'
    }
]

To:

{
    fooItem : {
        text : 'foo',
        ref  : 'fooItem'
    },
    1 : {
        text : 'bar'
    }
}

Creates a new array from object values and saves key in a property (ref by default) of each item.

From:

{
    fooItem : {
        text : 'foo'
    },
    1 : {
        text : 'bar'
    },
    barItem : false // will be ignored
}

To:

[
    {
         text : 'foo',
         ref : 'fooItem'
    },
    {
         text : 'bar',
         ref : 1
    }
]

Returns the specific type of the given value. Unlike the typeof operator, this function returns the text from the Object.prototype.toString result allowing Date, Array, RegExp, and others to be differentiated.

 console.log(typeOf(null));
 > null

 console.log(typeOf({}));
 > object

 console.log(typeOf([]));
 > array

 console.log(typeOf(new Date()));
 > date

 console.log(typeOf(NaN));
 > nan

 console.log(typeOf(/a/));
 > regexp