Interface QuantityConstructor

Constructor returned by createQuantityClass, with an optional per-instance parser override.

interface QuantityConstructor {
    new QuantityConstructor(
        input: QuantityInitParam,
        units?: string,
        parser?: Parser<QuantityDefinition>,
    ): QuantityCore;
    config: Readonly<DecimalConfig>;
    conversionCacheConfig: CacheConfig;
    parserConfig: ParserConfig;
    withConfig<T extends new (...args: never[]) => QuantityCore>(
        this: T,
        config: QuantityConfigInput,
    ): T;
}

Index

Constructors

Properties

config conversionCacheConfig parserConfig

Methods

Constructors

constructor

new QuantityConstructor(
    input: QuantityInitParam,
    units?: string,
    parser?: Parser<QuantityDefinition>,
): QuantityCore
Construct a quantity using the configured parser unless an override is supplied.
Parameters
- input: QuantityInitParam
- Optionalunits: string
- Optionalparser: Parser<QuantityDefinition>
Returns QuantityCore
- Defined in src/core.ts:30

Properties

`Readonly`config

config: Readonly<DecimalConfig>

Frozen snapshot of the class's effective Decimal settings.

`Readonly`conversionCacheConfig

conversionCacheConfig: CacheConfig

Immutable limits applied separately to each instance's conversion caches.

`Readonly`parserConfig

parserConfig: ParserConfig

Immutable parser settings shared by this class and its default parser instances.

Methods

withConfig

withConfig<T extends new (...args: never[]) => QuantityCore>(
this: T,
config: QuantityConfigInput,
): T
Create a class with numerical and parser settings while retaining this parser factory.
Type Parameters
- T extends new (...args: never[]) => QuantityCore
Parameters
- this: T
- config: QuantityConfigInput
Returns T
- Defined in src/core.ts:22