@xylabs/object-model
Advanced tools
Base functionality used throughout XY Labs TypeScript/JavaScript libraries
Base functionality used throughout XY Labs TypeScript/JavaScript libraries
@xylabs/object-model
Configuration options for type check functions, with optional logging.
optional log: boolean | Logger;
Type check configuration that marks the value as optional, returning undefined on failure.
optional log: boolean | Logger;
required: false;
Type check configuration that marks the value as required, causing assertions on failure.
optional log: boolean | Logger;
required: true;
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
type AsOptionalTypeFunction<T> = <TType>(value) => TType | undefined;
A simplified type-narrowing function that returns T or undefined, without assertion support.
T extends AnyNonPromise = AnyNonPromise
TType extends AnyNonPromise
AnyNonPromise
TType | undefined
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;
};
A type-narrowing function that attempts to cast a value to T, with optional assertion and configuration overloads.
T extends AnyNonPromise = AnyNonPromise
<TType>(value): TType | undefined;
TType extends AnyNonPromise
AnyNonPromise
TType | undefined
<TType>(value, config): TType;
TType extends AnyNonPromise
AnyNonPromise
TType
<TType>(value, config): TType | undefined;
TType extends AnyNonPromise
AnyNonPromise
TypeCheckConfig | TypeCheckOptionalConfig
TType | undefined
<TType>(value, assert): TType | undefined;
TType extends AnyNonPromise
AnyNonPromise
StringOrAlertFunction<TType>
TType | undefined
<TType>(
value,
assert,
config): TType;
TType extends AnyNonPromise
AnyNonPromise
StringOrAlertFunction<TType>
TType
<TType>(
value,
assert,
config): TType | undefined;
TType extends AnyNonPromise
AnyNonPromise
StringOrAlertFunction<TType>
TypeCheckConfig | TypeCheckOptionalConfig
TType | undefined
type Compare<T> = (a, b) => number;
A comparator function that returns a negative number if a < b, zero if a == b, and a positive number if a > b.
T
T
T
number
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
T extends object = object
type StringOrAlertFunction<T> = string | AssertExMessageFunc<T>;
A string message or function that produces an assertion error message for a failed type check.
T extends AnyNonPromise
type TypeCheck<T> = {
(obj): obj is T;
(obj, config): obj is T;
(obj, config): obj is T;
};
A type guard function that checks whether a value conforms to type T, with optional configuration.
T extends TypedValue
(obj): obj is T;
AnyNonPromise
obj is T
(obj, config): obj is T;
AnyNonPromise
obj is T
(obj, config): obj is T;
AnyNonPromise
number | TypeCheckConfig | undefined
obj is T
Part of sdk-js
See the LICENSE file for license details
FAQs
Base functionality used throughout XY Labs TypeScript/JavaScript libraries
The npm package @xylabs/object-model receives a total of 11,419 weekly downloads. As such, @xylabs/object-model popularity was classified as popular.
We found that @xylabs/object-model demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Six malicious Packagist packages posing as OphimCMS themes contain trojanized jQuery that exfiltrates URLs, injects ads, and loads FUNNULL-linked redirects.
Security News
The GCVE initiative operated by CIRCL has officially opened its publishing ecosystem, letting organizations issue and share vulnerability identifiers without routing through a central authority.
Security News
The project is retiring its odd/even release model in favor of a simpler annual cadence where every major version becomes LTS.