pip-services3-commons-node/obj/src/convert/DoubleConverter.d.ts

Portable abstractions and patterns for Pip.Services in Node.js

/**
 * Converts arbitrary values into double using extended conversion rules:
 * - Strings are converted to double values
 * - DateTime: total number of milliseconds since unix epoсh
 * - Boolean: 1 for true and 0 for false
 *
 * ### Example ###
 *
 *     let value1 = DoubleConverter.toNullableDouble("ABC"); // Result: null
 *     let value2 = DoubleConverter.toNullableDouble("123.456"); // Result: 123.456
 *     let value3 = DoubleConverter.toNullableDouble(true); // Result: 1
 *     let value4 = DoubleConverter.toNullableDouble(new Date()); // Result: current milliseconds
 */
export declare class DoubleConverter {
    /**
     * Converts value into doubles or returns null when conversion is not possible.
     *
     * @param value     the value to convert.
     * @returns         double value or null when conversion is not supported.
     */
    static toNullableDouble(value: any): number;
    /**
     * Converts value into doubles or returns 0 when conversion is not possible.
     *
     * @param value     the value to convert.
     * @returns         double value or 0 when conversion is not supported.
     *
     * @see [[toDoubleWithDefault]]
     */
    static toDouble(value: any): number;
    /**
     * Converts value into integer or returns default value when conversion is not possible.
     *
     * @param value         the value to convert.
     * @param defaultValue  the default value.
     * @returns             double value or default when conversion is not supported.
     *
     * @see [[toNullableDouble]]
     */
    static toDoubleWithDefault(value: any, defaultValue?: number): number;
}