@xylabs/object

[![logo][]](https://xylabs.com)

[![main-build][]][main-build-link]
[![npm-badge][]][npm-link]
[![npm-downloads-badge][]][npm-link]
[![jsdelivr-badge][]][jsdelivr-link]
[![npm-license-badge][]](LICENSE)
[![codacy-badge][]][codacy-link]
[![codeclimate-badge][]][codeclimate-link]
[![snyk-badge][]][snyk-link]
[![socket-badge][]][socket-link]

Base functionality used throughout XY Labs TypeScript/JavaScript libraries

Reference

@xylabs/object

*

Classes

- IsObjectFactory
- ObjectWrapper
- ValidatorBase

Interfaces

- ObjectTypeConfig
- Validator
- TypeCheckConfig
- TypeCheckRequiredConfig
- TypeCheckOptionalConfig

Type Aliases

- EmptyObject
- EmptyObjectOf
- JsonValue
- JsonObject
- JsonArray
- OmitStartsWith
- DeepOmitStartsWith
- DeepRestrictToStringKeys
- Optional
- Override
- ~~PartialRecord~~
- PickStartsWith
- DeepPickStartsWith
- StringKeyObject
- WithAdditional
- OmitByPredicate
- PickByPredicate
- AnyObject
- AsTypeFunction
- AsOptionalTypeFunction
- Compare
- StringOrAlertFunction
- TypeCheck

Variables

- AsObjectFactory
- AsTypeFactory
- asAnyObject
- deepMerge

Functions

- isJsonValue
- isJsonArray
- isValidJsonFieldPair
- isJsonObject
- createDeepMerge
- isObject
- isType
- omitBy
- omitByPrefix
- pickBy
- pickByPrefix
- removeFields
- toJsonArray
- toJsonObject
- toJsonValue
- toJsonString
- toJson

$3

### IsObjectFactory

@xylabs/object

*

Type Parameters

$3

T extends TypedObject

Constructors

$3

``ts
new IsObjectFactory(): IsObjectFactory;
`

$3

IsObjectFactory\<T\>

Methods

$3

`ts
create(shape?, additionalChecks?): TypeCheck;
`

$3

#### shape?

ObjectTypeShape

#### additionalChecks?

TypeCheck\<TypedObject\>[]

$3

TypeCheck\<T\>

### ObjectWrapper

@xylabs/object

*

Extended by

- ValidatorBase

Type Parameters

$3

T extends EmptyObject = EmptyObject

Constructors

$3

`ts
new ObjectWrapper(obj): ObjectWrapper;
`

$3

#### obj

T

$3

ObjectWrapper\<T\>

Properties

$3

`ts
readonly obj: T;
`

Accessors

$3

$3

`ts
get protected stringKeyObj(): StringKeyObject;
`

#### Returns

StringKeyObject

### ValidatorBase

@xylabs/object

*

Extends

- ObjectWrapper\<Partial\<T\>\>

Type Parameters

$3

T extends EmptyObject = AnyObject

Implements

- Validator\<T\>

Constructors

$3

`ts
new ValidatorBase(obj): ValidatorBase;
`

$3

#### obj

T

$3

ValidatorBase\<T\>

$3

ObjectWrapper.constructor

Properties

$3

`ts
readonly obj: T;
`

$3

ObjectWrapper.obj

Accessors

$3

$3

`ts
get protected stringKeyObj(): StringKeyObject;
`

#### Returns

StringKeyObject

$3

ObjectWrapper.stringKeyObj

Methods

$3

`ts
abstract validate(payload): Promisable;
`

$3

#### payload

T

$3

Promisable\<Error[]\>

$3

Validator.validate

$3

### createDeepMerge

@xylabs/object

*

`ts
function createDeepMerge(options): (...objects) => MergeAll;
`

Creates a deep merge function with the specified options.

Parameters

$3

MergeOptions

Options for merging.

Returns

A deep merge function configured for the specified options.

`ts
(...objects): MergeAll;
`

$3

$3

T extends AnyObject[]

$3

$3

...T

$3

MergeAll\<T\>

### isJsonArray

@xylabs/object

*

`ts
function isJsonArray(value): value is JsonArray;
`

Parameters

$3

unknown

Returns

value is JsonArray

### isJsonObject

@xylabs/object

*

`ts
function isJsonObject(value): value is JsonObject;
`

Parameters

$3

unknown

Returns

value is JsonObject

### isJsonValue

@xylabs/object

*

`ts
function isJsonValue(value): value is JsonValue;
`

Parameters

$3

unknown

Returns

value is JsonValue

### isObject

@xylabs/object

*

`ts
function isObject(value): value is T & object;
`

Type Parameters

$3

T

Parameters

$3

T

Returns

value is T & object

### isType

@xylabs/object

*

`ts
function isType(value, expectedType): boolean;
`

Parameters

$3

unknown

$3

FieldType

Returns

boolean

### isValidJsonFieldPair

@xylabs/object

*

`ts
function isValidJsonFieldPair(__namedParameters): boolean;
`

Parameters

$3

\[unknown, unknown\]

Returns

boolean

### omitBy

@xylabs/object

*

`ts
function omitBy(
obj,
predicate,
maxDepth): Partial;
`

Type Parameters

$3

T extends object

Parameters

$3

T

$3

OmitByPredicate

$3

number = 1

Returns

Partial\<T\>

### omitByPrefix

@xylabs/object

*

`ts
function omitByPrefix(
payload,
prefix,
maxDepth): DeepOmitStartsWith;
`

Type Parameters

$3

T extends object

$3

P extends string

Parameters

$3

T

$3

P

$3

number = 100

Returns

DeepOmitStartsWith\<T, P\>

### pickBy

@xylabs/object

*

`ts
function pickBy(
obj,
predicate,
maxDepth): Partial;
`

Type Parameters

$3

T extends object

Parameters

$3

T

$3

PickByPredicate

$3

number = 1

Returns

Partial\<T\>

### pickByPrefix

@xylabs/object

*

`ts
function pickByPrefix(
payload,
prefix,
maxDepth): DeepPickStartsWith;
`

Type Parameters

$3

T extends object

$3

P extends string

Parameters

$3

T

$3

P

$3

number = 100

Returns

DeepPickStartsWith\<T, P\>

### removeFields

@xylabs/object

*

`ts
function removeFields(obj, fields): Omit;
`

Type Parameters

$3

T extends object

$3

K extends string \| number \| symbol

Parameters

$3

T

$3

K[]

Returns

Omit\<T, K\>

### toJson

@xylabs/object

*

`ts
function toJson(value, maxDepth): JsonValue;
`

Parameters

$3

unknown

$3

number = 3

Returns

JsonValue

### toJsonArray

@xylabs/object

*

`ts
function toJsonArray(
value,
cycleList?,
maxDepth?): JsonArray;
`

Parameters

$3

unknown[]

$3

unknown[]

$3

number = 3

Returns

JsonArray

### toJsonObject

@xylabs/object

*

`ts
function toJsonObject(
value,
cycleList?,
maxDepth?): JsonObject;
`

Parameters

$3

object

$3

unknown[]

$3

number = 3

Returns

JsonObject

### toJsonString

@xylabs/object

*

`ts
function toJsonString(value, maxDepth): string;
`

Parameters

$3

unknown

$3

number = 3

Returns

string

### toJsonValue

@xylabs/object

*

`ts
function toJsonValue(
value,
cycleList?,
maxDepth?): JsonValue;
`

Parameters

$3

unknown

$3

unknown[]

$3

number = 3

Returns

JsonValue

$3

### ObjectTypeConfig

@xylabs/object

*

Extends

- TypeCheckConfig

Properties

$3

`ts
optional log: boolean | Logger;
`

$3

TypeCheckConfig.log

### TypeCheckConfig

@xylabs/object

*

Extended by

- ObjectTypeConfig
- TypeCheckRequiredConfig
- TypeCheckOptionalConfig

Properties

$3

`ts
optional log: boolean | Logger;
`

### TypeCheckOptionalConfig

@xylabs/object

*

Extends

- TypeCheckConfig

Properties

$3

`ts
optional log: boolean | Logger;
`

$3

TypeCheckConfig.log

*

$3

`ts
required: false;
`

### TypeCheckRequiredConfig

@xylabs/object

*

Extends

- TypeCheckConfig

Properties

$3

`ts
optional log: boolean | Logger;
`

$3

TypeCheckConfig.log

*

$3

`ts
required: true;
`

### Validator

@xylabs/object

*

Type Parameters

$3

T extends EmptyObject = AnyObject

Methods

$3

`ts
validate(payload): Promisable;
`

$3

#### payload

T

$3

Promisable\<Error[]\>

$3

### AnyObject

@xylabs/object

*

`ts
type AnyObject = Record;
`

Any object, which means that it does not enforce the set of fields that it has. Extending from AnyObject
will result in a type that includes the universal set of field names

### AsOptionalTypeFunction

@xylabs/object

*

`ts
type AsOptionalTypeFunction = (value) => undefined | TType;
`

Type Parameters

$3

T extends AnyNonPromise = AnyNonPromise

Type Parameters

$3

TType extends AnyNonPromise

Parameters

$3

AnyNonPromise

Returns

undefined \| TType

### AsTypeFunction

@xylabs/object

*

`ts
type AsTypeFunction = {
(value): undefined | TType;
(value, config): TType;
(value, config): undefined | TType;
(value, assert): undefined | TType;
(value, assert, config): TType;
(value, assert, config): undefined | TType;
};
`

Type Parameters

$3

T extends AnyNonPromise = AnyNonPromise

Call Signature

`ts
(value): undefined | TType;
`

$3

$3

TType extends AnyNonPromise

$3

$3

AnyNonPromise

$3

undefined \| TType

Call Signature

`ts
(value, config): TType;
`

$3

$3

TType extends AnyNonPromise

$3

$3

AnyNonPromise

$3

TypeCheckRequiredConfig

$3

TType

Call Signature

`ts
(value, config): undefined | TType;
`

$3

$3

TType extends AnyNonPromise

$3

$3

AnyNonPromise

$3

TypeCheckConfig | TypeCheckOptionalConfig

$3

undefined \| TType

Call Signature

`ts
(value, assert): undefined | TType;
`

$3

$3

TType extends AnyNonPromise

$3

$3

AnyNonPromise

$3

StringOrAlertFunction\<TType\>

$3

undefined \| TType

Call Signature

`ts
(
value,
assert,
config): TType;
`

$3

$3

TType extends AnyNonPromise

$3

$3

AnyNonPromise

$3

StringOrAlertFunction\<TType\>

$3

TypeCheckRequiredConfig

$3

TType

Call Signature

`ts
(
value,
assert,
config): undefined | TType;
`

$3

$3

TType extends AnyNonPromise

$3

$3

AnyNonPromise

$3

StringOrAlertFunction\<TType\>

$3

TypeCheckConfig | TypeCheckOptionalConfig

$3

undefined \| TType

### Compare

@xylabs/object

*

`ts
type Compare = (a, b) => number;
`

Type Parameters

$3

T

Parameters

$3

T

$3

T

Returns

number

### DeepOmitStartsWith

@xylabs/object

*

`ts
type DeepOmitStartsWith = T extends infer U[] ? DeepOmitStartsWith[] : T extends object ? { [K in keyof T as K extends string ? K extends ${Prefix}${string} ? never : K : K]: DeepOmitStartsWith } : T;
`

Type Parameters

$3

T

$3

Prefix extends string

### DeepPickStartsWith

@xylabs/object

*

`ts
type DeepPickStartsWith = T extends infer U[] ? DeepPickStartsWith[] : T extends object ? { [K in keyof T as K extends string ? K extends ${Prefix}${string} ? K : never : K]: DeepPickStartsWith } : T;
`

Type Parameters

$3

T

$3

Prefix extends string

### DeepRestrictToStringKeys

@xylabs/object

*

`ts
type DeepRestrictToStringKeys = { [K in keyof T as K extends string ? K : never]: T[K] extends (infer U)[] ? DeepRestrictToStringKeys[] : T[K] extends object ? DeepRestrictToStringKeys : T[K] };
`

Type Parameters

$3

T

### EmptyObject

@xylabs/object

*

`ts
type EmptyObject = { [K in keyof T]?: never };
`

An empty object, which means that it does enforce the set of field names, defaulting to an empty set until
extended from, which then adds only those additional fields

Type Parameters

$3

T extends object = object

### EmptyObjectOf

@xylabs/object

*

`ts
type EmptyObjectOf = EmptyObject extends T ? EmptyObject : never;
`

Type Parameters

$3

T extends object

### JsonArray

@xylabs/object

*

`ts
type JsonArray = JsonValue[];
`

### JsonObject

@xylabs/object

*

`ts
type JsonObject = object;
`

Index Signature

`ts
[key: string]: JsonValue
`

### JsonValue

@xylabs/object

*

`ts
type JsonValue =
| string
| number
| boolean
| null
| JsonObject
| JsonArray;
`

### OmitByPredicate

@xylabs/object

*

`ts
type OmitByPredicate = (value, key) => boolean;
`

Type Parameters

$3

T extends EmptyObject = Record\<string, unknown\>

Parameters

$3

T\[keyof T\]

$3

keyof T

Returns

boolean

### OmitStartsWith

@xylabs/object

*

`ts
type OmitStartsWith = { [K in keyof T as K extends ${Prefix}${string} ? never : K]: T[K] };
`

Type Parameters

$3

T

$3

Prefix extends string

### Optional

@xylabs/object

*

`ts
type Optional = Omit & Partial>;
`

Type Parameters

$3

T extends object

$3

F extends keyof T

### Override

@xylabs/object

*

`ts
type Override = Omit & T2;
`

Type Parameters

$3

T1

$3

T2

### PartialRecord

@xylabs/object

*

`ts
type PartialRecord = { [P in K]?: T };
`

Type Parameters

$3

K extends keyof any

$3

T

Deprecated

use Partial> instead

### PickByPredicate

@xylabs/object

*

`ts
type PickByPredicate = (value, key) => boolean;
`

Type Parameters

$3

T extends EmptyObject = Record\<string, unknown\>

Parameters

$3

T\[keyof T\]

$3

keyof T

Returns

boolean

### PickStartsWith

@xylabs/object

*

`ts
type PickStartsWith = { [K in keyof T as K extends ${Prefix}${string} ? K : never]: T[K] };
`

Type Parameters

$3

T

$3

Prefix extends string

### StringKeyObject

@xylabs/object

*

`ts
type StringKeyObject = object;
`

Type Parameters

$3

T = unknown

Index Signature

`ts
[key: string]: T
`

### StringOrAlertFunction

@xylabs/object

*

`ts
type StringOrAlertFunction = string | AssertExMessageFunc;
`

Type Parameters

$3

T extends AnyNonPromise

### TypeCheck

@xylabs/object

*

`ts
type TypeCheck = {
(obj): obj is T;
(obj, config): obj is T;
(obj, config): obj is T;
};
`

Type Parameters

$3

T extends TypedValue

Call Signature

`ts
(obj): obj is T;
`

$3

$3

AnyNonPromise

$3

obj is T

Call Signature

`ts
(obj, config): obj is T;
`

$3

$3

AnyNonPromise

$3

TypeCheckConfig

$3

obj is T

Call Signature

`ts
(obj, config): obj is T;
`

$3

$3

AnyNonPromise

$3

undefined | number | TypeCheckConfig

$3

obj is T

### WithAdditional

@xylabs/object

*

`ts
type WithAdditional = TAdditional extends EmptyObject ? T & TAdditional : T;
`

Type Parameters

$3

T extends EmptyObject \| void

$3

TAdditional extends EmptyObject \| void = void

$3

### AsObjectFactory

@xylabs/object

*

`ts
const AsObjectFactory: object;
`

Type declaration

$3

`ts
create: (typeCheck) => AsTypeFunction;
`

$3

#### T

T extends TypedObject

$3

#### typeCheck

TypeCheck\<T\>

$3

AsTypeFunction\<T\>

$3

`ts
createOptional: (typeCheck) => (value) => undefined | T;
`

$3

#### T

T extends TypedObject

$3

#### typeCheck

TypeCheck\<T\>

$3

`ts
(value): undefined | T;
`

#### Parameters

##### value

AnyNonPromise

#### Returns

undefined \| T

### AsTypeFactory

@xylabs/object

*

`ts
const AsTypeFactory: object;
`

Type declaration

$3

`ts
create: (typeCheck) => AsTypeFunction;
`

$3

#### T

T extends AnyNonPromise

$3

#### typeCheck

TypeCheck\<T\>

$3

AsTypeFunction\<T\>

$3

`ts
createOptional: (typeCheck) => (value) => undefined | T;
`

$3

#### T

T extends AnyNonPromise

$3

#### typeCheck

TypeCheck\<T\>

$3

`ts
(value): undefined | T;
`

#### Parameters

##### value

AnyNonPromise

#### Returns

undefined \| T

### asAnyObject

@xylabs/object

*

`ts
const asAnyObject: AsTypeFunction;
`

### deepMerge

@xylabs/object

*

`ts
const deepMerge: (...objects) => MergeAll;
`

Deeply merges multiple objects into a new object.

Type Parameters

$3

T extends AnyObject[]

Parameters

$3

...T

Multiple objects to merge deeply.
The function merges properties from all objects into a new object.
If a property exists in multiple objects, the last object's value will be used.
If a property is an object, it will be merged recursively.
If a property is an array, it will be overwritten by the last object's value.
If a property is a primitive value, it will be overwritten by the last object's value.
If a property is undefined in the source, it will be skipped.
If a property is a symbol, it will be merged as well.

Returns

MergeAll\<T`\>

A new object with the merged properties.

Part of sdk-js

Maintainers

- Arie Trouw (arietrouw.com)
- Matt Jones
- Joel Carter
- Jordan Trouw

License

> See the LICENSE file for license details

Credits

Made with 🔥 and ❄️ by XYLabs

[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg

[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
[npm-badge]: https://img.shields.io/npm/v/@xylabs/object.svg
[npm-link]: https://www.npmjs.com/package/@xylabs/object
[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json

[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/object
[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/object

[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/object/badge
[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/object

[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/object
[socket-link]: https://socket.dev/npm/package/@xylabs/object