@ayte/archetype.value

Ayte / TypeScript / Archetype / Value

This package consists of common value types and types for everyday tasks related to values, such as comparison.

Installation

yarn add @ayte/archetype.value

# - or -

npm install -S @ayte/archetype.value

Structure

Value types

Packages exposes IBound<T>, which describes abstract value bound (limit and whether that limit is exclusive or not), IRange<T>, which consists of upper and lower IBound<T>s, and Equivalence, special enum describing comparison result.

Processing types

As for now, three types are exposed: IComparator<T>, IClassicComparator<T> and IMaterializer<T>.

Comparator types expose standard comparison, allowing caller to know whether left value is lesser than, equal to or greater than right, the only difference is that classic comparator returns number, while regular comparator returns Equivalence enum value.

Materializer is a function that takes in partial value and reconstructs all properties, which is a usual task in configuration reading and other types of value normalization.

Licensing

MIT / UPL-1.0

Ayte Labs, 2020