@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 = EmptyObject & Partial<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) => TType | undefined;
Type Parameters
T
T extends AnyNonPromise = AnyNonPromise
Type Parameters
TType
TType extends AnyNonPromise
Parameters
value
AnyNonPromise
Returns
TType | undefined
AsTypeFunction
@xylabs/object-model
type AsTypeFunction<T> = {
<TType> (value): TType | undefined;
<TType> (value, config): TType;
<TType> (value, config): TType | undefined;
<TType> (value, assert): TType | undefined;
<TType> (value, assert, config): TType;
<TType> (value, assert, config): TType | undefined;
};
Type Parameters
T
T extends AnyNonPromise = AnyNonPromise
Call Signature
<TType>(value): TType | undefined;
Type Parameters
TType
TType extends AnyNonPromise
Parameters
value
AnyNonPromise
Returns
TType | undefined
Call Signature
<TType>(value, config): TType;
Type Parameters
TType
TType extends AnyNonPromise
Parameters
value
AnyNonPromise
config
TypeCheckRequiredConfig
Returns
TType
Call Signature
<TType>(value, config): TType | undefined;
Type Parameters
TType
TType extends AnyNonPromise
Parameters
value
AnyNonPromise
config
TypeCheckConfig | TypeCheckOptionalConfig
Returns
TType | undefined
Call Signature
<TType>(value, assert): TType | undefined;
Type Parameters
TType
TType extends AnyNonPromise
Parameters
value
AnyNonPromise
assert
StringOrAlertFunction<TType>
Returns
TType | undefined
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): TType | undefined;
Type Parameters
TType
TType extends AnyNonPromise
Parameters
value
AnyNonPromise
assert
StringOrAlertFunction<TType>
config
TypeCheckConfig | TypeCheckOptionalConfig
Returns
TType | undefined
Compare
@xylabs/object-model
type Compare<T> = (a, b) => number;
Type Parameters
T
T
Parameters
a
T
b
T
Returns
number
EmptyObject
@xylabs/object-model
type EmptyObject<T> = Exclude<{ [K in keyof T]?: never }, unknown[] | (...args) => unknown | null>;
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
T
T extends object = object
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
number | TypeCheckConfig | undefined
Returns
obj is T
Part of sdk-js
Maintainers
License
See the LICENSE file for license details
Credits
Made with 🔥 and ❄️ by XYLabs