augment-vir - v31.73.2
    Preparing search index...

    Variable convertToConst

    convertTo: {
        maybeNumber(this: void, value: unknown): number | undefined;
        maybeString(this: void, value: unknown): string | undefined;
        string(this: void, value: unknown): string;
    } = ...

    A suite of functions that each convert an unknown value into a specific type, throwing an error if the conversion is not possible.

    Type Declaration

    • maybeNumber: function
      • Converts almost anything into a number but maps null, undefined, and any conversion that results in NaN to undefined.

        Parameters

        • this: void
        • value: unknown

        Returns number | undefined

        import {convertTo} from '@augment-vir/common';

        convertTo.maybeNumber('42'); // `42`
        convertTo.maybeNumber(42); // `42`
        convertTo.maybeNumber(null); // `undefined`
        convertTo.maybeNumber('hello'); // `undefined`
    • maybeString: function
      • Converts almost anything into a string but maps null, undefined, and empty string results to undefined.

        Parameters

        • this: void
        • value: unknown

        Returns string | undefined

        import {convertTo} from '@augment-vir/common';

        convertTo.string('hi'); // `'hi'`
        convertTo.string(42); // `'42'`
        convertTo.string(null); // `undefined`
        convertTo.string(''); // `undefined`
        convertTo.string({}); // `'{}'`
    • string: function
      • Converts anything into a string.

        Parameters

        • this: void
        • value: unknown

        Returns string

        import {convertTo} from '@augment-vir/common';

        convertTo.string('hi'); // `'hi'`
        convertTo.string(42); // `'42'`
        convertTo.string(null); // `'hi'`
        convertTo.string({}); // `'{}'`
    import {convertTo} from '@augment-vir/common';

    convertTo.string(42); // `'42'`
    convertTo.string(undefined); // throws an error