@rtorcato/js-common / objects

objects

Functions

isPlainObject()

isPlainObject(value): value is Record<string, any>

Defined in: objects/index.ts:16

Returns true if the value is a plain object (not null, not array, not function).

Example

isPlainObject({ a: 1 }) // true
isPlainObject([1, 2]) // false
isPlainObject(null) // false
isPlainObject(new Date()) // false

Parameters

value

any

The value to check.

Returns

value is Record<string, any>

---

deepMerge()

deepMerge<T, U>(target, source): T & U

Defined in: objects/index.ts:33

Deeply merges two objects. Does not mutate inputs.

Example

deepMerge({ a: 1, nested: { x: 1, y: 2 } }, { nested: { y: 9 }, b: 2 })
// { a: 1, nested: { x: 1, y: 9 }, b: 2 }

Type Parameters

T

T extends object

U

U extends object

Parameters

target

T

The target object.

source

U

The source object.

Returns

T & U

The merged object.

---

omit()

omit<T, K>(obj, keys): Omit<T, K>

Defined in: objects/index.ts:58

Returns a shallow copy of an object with the given keys omitted.

Example

omit({ id: 1, name: 'Ada', password: 'x' }, ['password'])
// { id: 1, name: 'Ada' }

Type Parameters

T

T extends object

K

K extends string | number | symbol

Parameters

obj

T

The source object.

keys

K[]

Keys to omit.

Returns

Omit<T, K>

---

pick()

pick<T, K>(obj, keys): Pick<T, K>

Defined in: objects/index.ts:72

Returns a shallow copy of an object with only the given keys.

Type Parameters

T

T extends object

K

K extends string | number | symbol

Parameters

obj

T

The source object.

keys

K[]

Keys to pick.

Returns

Pick<T, K>