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

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

/** @module convert */
/** @hidden */ 
let _ = require('lodash');

/**
 * 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 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.
     */
    public static toNullableDouble(value: any): number {
        if (value == null) return null;
        if (_.isNumber(value)) return value;
        if (_.isDate(value)) return value.getTime();
        if (_.isBoolean(value)) return value ? 1 : 0;

        let result = parseFloat(value);
        return isNaN(result) ? null : result;
    }

    /**
     * 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]]
     */
    public static toDouble(value: any): number {
        return DoubleConverter.toDoubleWithDefault(value, 0);
    }

    /**
     * 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]]
     */
    public static toDoubleWithDefault(value: any, defaultValue: number = 0): number {
        var result = DoubleConverter.toNullableDouble(value);
        return result != null ? result : defaultValue;
    }

}