@xylabs/object-model

[![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-model

*

Interfaces

- TypeCheckConfig
- TypeCheckRequiredConfig
- TypeCheckOptionalConfig

Type Aliases

- AnyObject
- AsTypeFunction
- AsOptionalTypeFunction
- Compare
- StringOrAlertFunction
- TypeCheck

$3

### TypeCheckConfig

@xylabs/object-model

*

Extended by

- TypeCheckRequiredConfig
- TypeCheckOptionalConfig

Properties

$3

``ts
optional log: boolean | Logger;
`

### TypeCheckOptionalConfig

@xylabs/object-model

*

Extends

- TypeCheckConfig

Properties

$3

`ts
optional log: boolean | Logger;
`

$3

TypeCheckConfig.log

*

$3

`ts
required: false;
`

### TypeCheckRequiredConfig

@xylabs/object-model

*

Extends

- TypeCheckConfig

Properties

$3

`ts
optional log: boolean | Logger;
`

$3

TypeCheckConfig.log

*

$3

`ts
required: true;
`

$3

### AnyObject

@xylabs/object-model

*

`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-model

*

`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-model

*

`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-model

*

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

Type Parameters

$3

T

Parameters

$3

T

$3

T

Returns

number

### StringOrAlertFunction

@xylabs/object-model

*

`ts
type StringOrAlertFunction = string | AssertExMessageFunc;
`

Type Parameters

$3

T extends AnyNonPromise

### TypeCheck

@xylabs/object-model

*

`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`

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-model.svg
[npm-link]: https://www.npmjs.com/package/@xylabs/object-model
[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-model
[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/object-model

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

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