@xylabs/object-model


Base functionality used throughout XY Labs TypeScript/JavaScript libraries
Reference
@xylabs/object-model
Interfaces
Type Aliases
interfaces
TypeCheckConfig
@xylabs/object-model
Extended by
Properties
log?
optional log: boolean | Logger;
TypeCheckOptionalConfig
@xylabs/object-model
Extends
Properties
log?
optional log: boolean | Logger;
Inherited from
TypeCheckConfig.log
required
required: false;
TypeCheckRequiredConfig
@xylabs/object-model
Extends
Properties
log?
optional log: boolean | Logger;
Inherited from
TypeCheckConfig.log
required
required: true;
type-aliases
AnyObject
@xylabs/object-model
type AnyObject = Record<TypedKey, unknown>;
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
type AsOptionalTypeFunction<T> = <TType>(value) => undefined | TType;
Type Parameters
T
T extends AnyNonPromise = AnyNonPromise
Type Parameters
TType
TType extends AnyNonPromise
Parameters
value
AnyNonPromise
Returns
undefined | TType
AsTypeFunction
@xylabs/object-model
type AsTypeFunction<T> = {
<TType> (value): undefined | TType;
<TType> (value, config): TType;
<TType> (value, config): undefined | TType;
<TType> (value, assert): undefined | TType;
<TType> (value, assert, config): TType;
<TType> (value, assert, config): undefined | TType;
};
Type Parameters
T
T extends AnyNonPromise = AnyNonPromise
Call Signature
<TType>(value): undefined | TType;
Type Parameters
TType
TType extends AnyNonPromise
Parameters
value
AnyNonPromise
Returns
undefined | TType
Call Signature
<TType>(value, config): TType;
Type Parameters
TType
TType extends AnyNonPromise
Parameters
value
AnyNonPromise
config
TypeCheckRequiredConfig
Returns
TType
Call Signature
<TType>(value, config): undefined | TType;
Type Parameters
TType
TType extends AnyNonPromise
Parameters
value
AnyNonPromise
config
TypeCheckConfig | TypeCheckOptionalConfig
Returns
undefined | TType
Call Signature
<TType>(value, assert): undefined | TType;
Type Parameters
TType
TType extends AnyNonPromise
Parameters
value
AnyNonPromise
assert
StringOrAlertFunction<TType>
Returns
undefined | TType
Call Signature
<TType>(
value,
assert,
config): TType;
Type Parameters
TType
TType extends AnyNonPromise
Parameters
value
AnyNonPromise
assert
StringOrAlertFunction<TType>
config
TypeCheckRequiredConfig
Returns
TType
Call Signature
<TType>(
value,
assert,
config): undefined | TType;
Type Parameters
TType
TType extends AnyNonPromise
Parameters
value
AnyNonPromise
assert
StringOrAlertFunction<TType>
config
TypeCheckConfig | TypeCheckOptionalConfig
Returns
undefined | TType
Compare
@xylabs/object-model
type Compare<T> = (a, b) => number;
Type Parameters
T
T
Parameters
a
T
b
T
Returns
number
StringOrAlertFunction
@xylabs/object-model
type StringOrAlertFunction<T> = string | AssertExMessageFunc<T>;
Type Parameters
T
T extends AnyNonPromise
TypeCheck
@xylabs/object-model
type TypeCheck<T> = {
(obj): obj is T;
(obj, config): obj is T;
(obj, config): obj is T;
};
Type Parameters
T
T extends TypedValue
Call Signature
(obj): obj is T;
Parameters
obj
AnyNonPromise
Returns
obj is T
Call Signature
(obj, config): obj is T;
Parameters
obj
AnyNonPromise
config
TypeCheckConfig
Returns
obj is T
Call Signature
(obj, config): obj is T;
Parameters
obj
AnyNonPromise
config
undefined | number | TypeCheckConfig
Returns
obj is T
Part of sdk-js
Maintainers
License
See the LICENSE file for license details
Credits
Made with 🔥 and ❄️ by XYLabs