pip-services3-commons-node
Version:
Portable abstractions and patterns for Pip.Services in Node.js
42 lines (41 loc) • 1.65 kB
TypeScript
/**
* Converts arbitrary values to boolean values using extended conversion rules:
* - Numbers: <>0 are true, =0 are false
* - Strings: "true", "yes", "T", "Y", "1" are true; "false", "no", "F", "N" are false
* - DateTime: <>0 total milliseconds are true, =0 are false
*
* ### Example ###
*
* let value1 = BooleanConverter.toNullableBoolean(true); // true
* let value2 = BooleanConverter.toNullableBoolean("yes"); // true
* let value3 = BooleanConverter.toNullableBoolean(123); // true
* let value4 = BooleanConverter.toNullableBoolean({}); // null
*/
export declare class BooleanConverter {
/**
* Converts value into boolean or returns null when conversion is not possible.
*
* @param value the value to convert.
* @returns boolean value or null when convertion is not supported.
*/
static toNullableBoolean(value: any): boolean;
/**
* Converts value into boolean or returns false when conversion is not possible.
*
* @param value the value to convert.
* @returns boolean value or false when conversion is not supported.
*
* @see [[toBooleanWithDefault]]
*/
static toBoolean(value: any): boolean;
/**
* Converts value into boolean or returns default value when conversion is not possible
*
* @param value the value to convert.
* @param defaultValue the default value
* @returns boolean value or default when conversion is not supported.
*
* @see [[toNullableBoolean]]
*/
static toBooleanWithDefault(value: any, defaultValue?: boolean): boolean;
}