goog.object

Module ID	`goog.object`

Adds a key-value pair to the object. Throws an exception if the key is already in use. Use set if you want to change an existing pair.

Parameters

`obj`	`(Object<(K\|null), (V\|null)>\|null)`
	The object to which to add the key-value pair.
`key`	`string`
	The key to add.
`val`	`(V\|null)`
	The value to add.

VIEW SOURCE

Removes all key value pairs from the object/map/hash.

Parameters

`obj`	`(Object\|null)`
	The object to clear.

VIEW SOURCE

Returns a shallow clone of the object.

Parameters

`obj`	`(Object<(K\|null), (V\|null)>\|null)`
	Object to clone.

Returns

Object<(K|null), (V|null)>

Clone of the input object.

VIEW SOURCE

Whether the object/hash/map contains the given object as a value. An alias for containsValue(obj, val).

Parameters

`obj`	`(Object<(K\|null), (V\|null)>\|null)`
	The object in which to look for val.
`val`	`(V\|null)`
	The object for which to check.

Returns

boolean

true if val is present.

VIEW SOURCE

Whether the object/map/hash contains the given key.

Parameters

`obj`	`(Object\|null)`
	The object in which to look for key.
`key`	`?`
	The key for which to check.

Returns

boolean

true If the map contains the key.

VIEW SOURCE

Whether the object/map/hash contains the given value. This is O(n).

Parameters

`obj`	`(Object<(K\|null), (V\|null)>\|null)`
	The object in which to look for val.
`val`	`(V\|null)`
	The value for which to check.

Returns

boolean

true If the map contains the value.

VIEW SOURCE

Creates a new object built from the key-value pairs provided as arguments.

Parameters

`var_args`	`...*`
	If only one argument is provided and it is an array then this is used as the arguments, otherwise even arguments are used as the property names and odd arguments are used as the property values.

Returns

Object

The new object.

Throws

{!Error} If there are uneven number of arguments or there is only one non array argument.

VIEW SOURCE

Creates an immutable view of the underlying object, if the browser supports immutable objects. In default mode, writes to this view will fail silently. In strict mode, they will throw an error.

Parameters

`obj`	`Object<(K\|null), (V\|null)>`
	An object.

Returns

Object<(K|null), (V|null)>

An immutable view of that object, or the original object if this browser does not support immutables.

VIEW SOURCE

Creates a new object where the property names come from the arguments but the value is always set to true

Parameters

`var_args`	`...*`
	If only one argument is provided and it is an array then this is used as the arguments, otherwise the arguments are used as the property names.

Returns

Object

The new object.

VIEW SOURCE

Compares two objects for equality using === on the values.

Parameters

`a`	`Object<(K\|null), (V\|null)>`

`b`	`Object<(K\|null), (V\|null)>`

Returns

boolean

VIEW SOURCE

Calls a function for each element in an object/map/hash. If all calls return true, returns true. If any call returns false, returns false at this point and does not continue to check the remaining elements.

Parameters

`obj`	`(Object<(K\|null), (V\|null)>\|null)`
	The object to check.
`f`	`(function((V\|null), ?, (Object<(K\|null), (V\|null)>\|null)): boolean\|null)`
	The function to call for every element. This function takes 3 arguments (the value, the key and the object) and should return a boolean.
`opt_obj`	`(T\|null)=`
	This is used as the 'this' object within f.

Returns

boolean

false if any element fails the test.

VIEW SOURCE

Extends an object with another object. This operates 'in-place'; it does not create a new Object. Example: var o = {}; extend(o, {a: 0, b: 1}); o; // {a: 0, b: 1} extend(o, {b: 2, c: 3}); o; // {a: 0, b: 2, c: 3}

Deprecated	Prefer Object.assign

Parameters

`target`	`(Object\|null)`
	The object to modify. Existing properties will be overwritten if they are also present in one of the objects in `var_args`.
`var_args`	`...(Object\|null\|undefined)`
	The objects from which values will be copied.

VIEW SOURCE

Calls a function for each element in an object/map/hash. If that call returns true, adds the element to a new object.

Parameters

`obj`	`(Object<(K\|null), (V\|null)>\|null)`
	The object over which to iterate.
`f`	`function((V\|null), ?, (Object<(K\|null), (V\|null)>\|null)): boolean`
	The function to call for every element. This function takes 3 arguments (the value, the key and the object) and should return a boolean. If the return value is true the element is added to the result object. If it is false the element is not included.
`opt_obj`	`(T\|null)=`
	This is used as the 'this' object within f.

Returns

Object<(K|null), (V|null)>

a new object in which only elements that passed the test are present.

VIEW SOURCE

Searches an object for an element that satisfies the given condition and returns its key.

Parameters

`obj`	`(Object<(K\|null), (V\|null)>\|null)`
	The object to search in.
`f`	`function((V\|null), string, (Object<(K\|null), (V\|null)>\|null)): boolean`
	The function to call for every element. Takes 3 arguments (the value, the key and the object) and should return a boolean.
`thisObj`	`(T\|null)=`
	An optional "this" context for the function.

Returns

(string|undefined)

The key of an element for which the function returns true or undefined if no such element is found.

VIEW SOURCE

Searches an object for an element that satisfies the given condition and returns its value.

Parameters

`obj`	`(Object<(K\|null), (V\|null)>\|null)`
	The object to search in.
`f`	`function((V\|null), string, (Object<(K\|null), (V\|null)>\|null)): boolean`
	The function to call for every element. Takes 3 arguments (the value, the key and the object) and should return a boolean.
`thisObj`	`(T\|null)=`
	An optional "this" context for the function.

Returns

V

The value of an element for which the function returns true or undefined if no such element is found.

VIEW SOURCE

Calls a function for each element in an object/map/hash.

Parameters

`obj`	`(Object<(K\|null), (V\|null)>\|null)`
	The object over which to iterate.
`f`	`function((V\|null), ?, (Object<(K\|null), (V\|null)>\|null)): ?`
	The function to call for every element. This function takes 3 arguments (the value, the key and the object) and the return value is ignored.
`opt_obj`	`(T\|null)=`
	This is used as the 'this' object within f.

VIEW SOURCE

Returns the value for the given key.

Parameters

`obj`	`(Object<(K\|null), (V\|null)>\|null)`
	The object from which to get the value.
`key`	`string`
	The key for which to get the value.
`val`	`(R\|null)=`
	The value to return if no item is found for the given key (default is undefined).

Returns

The value for the given key.

VIEW SOURCE

Get all properties names on a given Object regardless of enumerability.

If the browser does not support `Object.getOwnPropertyNames` nor `Object.getPrototypeOf` then this is equivalent to using `getKeys`

Parameters

`obj`	`(Object\|null)`
	The object to get the properties of.
`includeObjectPrototype`	`boolean=`
	Whether properties defined on `Object.prototype` should be included in the result.
`includeFunctionPrototype`	`boolean=`
	Whether properties defined on `Function.prototype` should be included in the result.

Returns

Array<string>

VIEW SOURCE

Returns one key from the object map, if any exists. For map literals the returned key will be the first one in most of the browsers (a know exception is Konqueror).

Parameters

`obj`	`(Object\|null)`
	The object to pick a key from.

Returns

(string|undefined)

The key or undefined if the object is empty.

VIEW SOURCE

Returns one value from the object map, if any exists. For map literals the returned value will be the first one in most of the browsers (a know exception is Konqueror).

Parameters

`obj`	`(Object<(K\|null), (V\|null)>\|null)`
	The object to pick a value from.

Returns

The value or undefined if the object is empty.

VIEW SOURCE

Returns the number of key-value pairs in the object map.

Parameters

`obj`	`(Object\|null)`
	The object for which to get the number of key-value pairs.

Returns

number

The number of key-value pairs in the object map.

VIEW SOURCE

Returns the keys of the object/map/hash.

Parameters

`obj`	`(Object\|null)`
	The object from which to get the keys.

Returns

Array<string>

Array of property keys.

VIEW SOURCE

Given a ES5 or ES6 class reference, return its super class / super constructor. This should be used in rare cases where you need to walk up the inheritance tree (this is generally a bad idea). But this work with ES5 and ES6 classes, unlike relying on the superClass_ property. Note: To start walking up the hierarchy from an instance call this with its constructor property; e.g. getSuperClass(instance.constructor).

Parameters

`constructor`	`function(new: ?)`

Returns

(Object|null)

VIEW SOURCE

Get a value from an object multiple levels deep. This is useful for pulling values from deeply nested objects, such as JSON responses. Example usage: getValueByKeys(jsonObj, 'foo', 'entries', 3)

Parameters

`obj`	`(Object\|null)`
	An object to get the value from. Can be array-like.
`var_args`	`...(string\|number\|IArrayLike<(number\|string)>)`
	A number of keys (as strings, or numbers, for array-like objects). Can also be specified as a single array of keys.

Returns

*

The resulting value. If, at any point, the value for a key in the current object is null or undefined, returns undefined.

VIEW SOURCE

Returns the values of the object/map/hash.

Parameters

`obj`	`(Object<(K\|null), (V\|null)>\|null)`
	The object from which to get the values.

Returns

Array<(V|null)>

The values in the object/map/hash.

VIEW SOURCE

Whether the object/map/hash is empty.

Parameters

`obj`	`(Object\|null)`
	The object to test.

Returns

boolean

true if obj is empty.

VIEW SOURCE

Parameters

`obj`	`Object`
	An object.

Returns

boolean

Whether this is an immutable view of the object.

VIEW SOURCE

For every element in an object/map/hash calls a function and inserts the result into a new object.

Parameters

`obj`	`(Object<(K\|null), (V\|null)>\|null)`
	The object over which to iterate.
`f`	`function((V\|null), ?, (Object<(K\|null), (V\|null)>\|null)): (R\|null)`
	The function to call for every element. This function takes 3 arguments (the value, the key and the object) and should return something. The result will be inserted into a new object.
`opt_obj`	`(T\|null)=`
	This is used as the 'this' object within f.

Returns

Object<(K|null), (R|null)>

a new object with the results from f.

VIEW SOURCE

Removes a key-value pair based on the key.

Parameters

`obj`	`(Object\|null)`
	The object from which to remove the key.
`key`	`?`
	The key to remove.

Returns

boolean

Whether an element was removed.

VIEW SOURCE

Adds a key-value pair to the object/map/hash.

Parameters

`obj`	`(Object<(K\|null), (V\|null)>\|null)`
	The object to which to add the key-value pair.
`key`	`string`
	The key to add.
`value`	`(V\|null)`
	The value to add.

VIEW SOURCE

Adds a key-value pair to the object/map/hash if it doesn't exist yet.

Parameters

`obj`	`(Object<(K\|null), (V\|null)>\|null)`
	The object to which to add the key-value pair.
`key`	`string`
	The key to add.
`value`	`(V\|null)`
	The value to add if the key wasn't present.

Returns

V

The value of the entry at the end of the function.

VIEW SOURCE

Sets a key and value to an object if the key is not set. The value will be the return value of the given function. If the key already exists, the object will not be changed and the function will not be called (the function will be lazily evaluated -- only called if necessary). This function is particularly useful when used with an Object which is acting as a cache.

Parameters

`obj`	`(Object<(K\|null), (V\|null)>\|null)`
	The object to which to add the key-value pair.
`key`	`string`
	The key to add.
`f`	`function(): (V\|null)`
	The value to add if the key wasn't present.

Returns

V

The value of the entry at the end of the function.

VIEW SOURCE

Calls a function for each element in an object/map/hash. If any call returns true, returns true (without checking the rest). If all calls return false, returns false.

Parameters

`obj`	`(Object<(K\|null), (V\|null)>\|null)`
	The object to check.
`f`	`function((V\|null), ?, (Object<(K\|null), (V\|null)>\|null)): boolean`
	The function to call for every element. This function takes 3 arguments (the value, the key and the object) and should return a boolean.
`opt_obj`	`(T\|null)=`
	This is used as the 'this' object within f.

Returns

boolean

true if any element passes the test.

VIEW SOURCE

Returns a new object in which all the keys and values are interchanged (keys become values and values become keys). If multiple keys map to the same value, the chosen transposed value is implementation-dependent.

Parameters

`obj`	`(Object\|null)`
	The object to transpose.

Returns

Object

The transposed object.

VIEW SOURCE

Clones a value. The input may be an Object, Array, or basic type. Objects and arrays will be cloned recursively. WARNINGS: unsafeClone does not detect reference loops. Objects that refer to themselves will cause infinite recursion. unsafeClone is unaware of unique identifiers, and copies UIDs created by getUid into cloned results.

Parameters

`obj`	`(T\|null)`
	The value to clone.

Returns

T

A clone of the input value.

VIEW SOURCE

goog.object

Exported Functions

add`<K, V>`( `obj`, `key`, `val` ) `→` `void`

clear( `obj` ) `→` `void`

clone`<K, V>`( `obj` ) `→` `Object<(K|null), (V|null)>`

contains`<K, V>`( `obj`, `val` ) `→` `boolean`

containsKey( `obj`, `key` ) `→` `boolean`

containsValue`<K, V>`( `obj`, `val` ) `→` `boolean`

create( `...var_args` ) `→` `Object`

createImmutableView`<K, V>`( `obj` ) `→` `Object<(K|null), (V|null)>`

createSet( `...var_args` ) `→` `Object`

equals`<K, V>`( `a`, `b` ) `→` `boolean`

every`<T, K, V>`( `obj`, `f`, `opt_obj` ) `→` `boolean`

extend( `target`, `...var_args` ) `→` `void`

filter`<T, K, V>`( `obj`, `f`, `opt_obj` ) `→` `Object<(K|null), (V|null)>`

findKey`<T, K, V>`( `obj`, `f`, `thisObj` ) `→` `(string|undefined)`

findValue`<T, K, V>`( `obj`, `f`, `thisObj` ) `→` `V`

forEach`<T, K, V>`( `obj`, `f`, `opt_obj` ) `→` `void`

get`<K, V, R>`( `obj`, `key`, `val` ) `→` `?`

getAllPropertyNames( `obj`, `includeObjectPrototype`, `includeFunctionPrototype` ) `→` `Array<string>`

getAnyKey( `obj` ) `→` `(string|undefined)`

getAnyValue`<K, V>`( `obj` ) `→` `?`

getCount( `obj` ) `→` `number`

getKeys( `obj` ) `→` `Array<string>`

getSuperClass( `constructor` ) `→` `(Object|null)`

getValueByKeys( `obj`, `...var_args` ) `→` `*`

getValues`<K, V>`( `obj` ) `→` `Array<(V|null)>`

isEmpty( `obj` ) `→` `boolean`

isImmutableView( `obj` ) `→` `boolean`

map`<T, K, V, R>`( `obj`, `f`, `opt_obj` ) `→` `Object<(K|null), (R|null)>`

remove( `obj`, `key` ) `→` `boolean`

set`<K, V>`( `obj`, `key`, `value` ) `→` `void`

setIfUndefined`<K, V>`( `obj`, `key`, `value` ) `→` `V`

setWithReturnValueIfNotSet`<K, V>`( `obj`, `key`, `f` ) `→` `V`

some`<T, K, V>`( `obj`, `f`, `opt_obj` ) `→` `boolean`

transpose( `obj` ) `→` `Object`

unsafeClone`<T>`( `obj` ) `→` `T`

goog.object

Exported Functions

add<K, V>( obj, key, val ) → void

clear( obj ) → void

clone<K, V>( obj ) → Object<(K|null), (V|null)>

contains<K, V>( obj, val ) → boolean

containsKey( obj, key ) → boolean

containsValue<K, V>( obj, val ) → boolean

create( ...var_args ) → Object

createImmutableView<K, V>( obj ) → Object<(K|null), (V|null)>

createSet( ...var_args ) → Object

equals<K, V>( a, b ) → boolean

every<T, K, V>( obj, f, opt_obj ) → boolean

extend( target, ...var_args ) → void

filter<T, K, V>( obj, f, opt_obj ) → Object<(K|null), (V|null)>

findKey<T, K, V>( obj, f, thisObj ) → (string|undefined)

findValue<T, K, V>( obj, f, thisObj ) → V

forEach<T, K, V>( obj, f, opt_obj ) → void

get<K, V, R>( obj, key, val ) → ?

getAllPropertyNames( obj, includeObjectPrototype, includeFunctionPrototype ) → Array<string>

getAnyKey( obj ) → (string|undefined)

getAnyValue<K, V>( obj ) → ?

getCount( obj ) → number

getKeys( obj ) → Array<string>

getSuperClass( constructor ) → (Object|null)

getValueByKeys( obj, ...var_args ) → *

getValues<K, V>( obj ) → Array<(V|null)>

isEmpty( obj ) → boolean

isImmutableView( obj ) → boolean

map<T, K, V, R>( obj, f, opt_obj ) → Object<(K|null), (R|null)>

remove( obj, key ) → boolean

set<K, V>( obj, key, value ) → void

setIfUndefined<K, V>( obj, key, value ) → V

setWithReturnValueIfNotSet<K, V>( obj, key, f ) → V

some<T, K, V>( obj, f, opt_obj ) → boolean

transpose( obj ) → Object

unsafeClone<T>( obj ) → T

add`<K, V>`( `obj`, `key`, `val` ) `→` `void`

clear( `obj` ) `→` `void`

clone`<K, V>`( `obj` ) `→` `Object<(K|null), (V|null)>`

contains`<K, V>`( `obj`, `val` ) `→` `boolean`

containsKey( `obj`, `key` ) `→` `boolean`

containsValue`<K, V>`( `obj`, `val` ) `→` `boolean`

create( `...var_args` ) `→` `Object`

createImmutableView`<K, V>`( `obj` ) `→` `Object<(K|null), (V|null)>`

createSet( `...var_args` ) `→` `Object`

equals`<K, V>`( `a`, `b` ) `→` `boolean`

every`<T, K, V>`( `obj`, `f`, `opt_obj` ) `→` `boolean`

extend( `target`, `...var_args` ) `→` `void`

filter`<T, K, V>`( `obj`, `f`, `opt_obj` ) `→` `Object<(K|null), (V|null)>`

findKey`<T, K, V>`( `obj`, `f`, `thisObj` ) `→` `(string|undefined)`

findValue`<T, K, V>`( `obj`, `f`, `thisObj` ) `→` `V`

forEach`<T, K, V>`( `obj`, `f`, `opt_obj` ) `→` `void`

get`<K, V, R>`( `obj`, `key`, `val` ) `→` `?`

getAllPropertyNames( `obj`, `includeObjectPrototype`, `includeFunctionPrototype` ) `→` `Array<string>`

getAnyKey( `obj` ) `→` `(string|undefined)`

getAnyValue`<K, V>`( `obj` ) `→` `?`

getCount( `obj` ) `→` `number`

getKeys( `obj` ) `→` `Array<string>`

getSuperClass( `constructor` ) `→` `(Object|null)`

getValueByKeys( `obj`, `...var_args` ) `→` `*`

getValues`<K, V>`( `obj` ) `→` `Array<(V|null)>`

isEmpty( `obj` ) `→` `boolean`

isImmutableView( `obj` ) `→` `boolean`

map`<T, K, V, R>`( `obj`, `f`, `opt_obj` ) `→` `Object<(K|null), (R|null)>`

remove( `obj`, `key` ) `→` `boolean`

set`<K, V>`( `obj`, `key`, `value` ) `→` `void`

setIfUndefined`<K, V>`( `obj`, `key`, `value` ) `→` `V`

setWithReturnValueIfNotSet`<K, V>`( `obj`, `key`, `f` ) `→` `V`

some`<T, K, V>`( `obj`, `f`, `opt_obj` ) `→` `boolean`

transpose( `obj` ) `→` `Object`

unsafeClone`<T>`( `obj` ) `→` `T`