to-primitive-x

    2.1.2 • Public • Published

    Travis status Dependency status devDependency status npm version jsDelivr hits bettercodehub score Coverage Status

    to-primitive-x

    Converts a JavaScript object to a primitive value.

    module.exports(input, [prefferedtype])string | number

    This method converts a JavaScript object to a primitive value. Note: When toPrimitive is called with no hint, then it generally behaves as if the hint were Number. However, objects may over-ride this behaviour by defining a @@toPrimitive method. Of the objects defined in this specification only Date objects (see 20.3.4.45) and Symbol objects (see 19.4.3.4) over-ride the default ToPrimitive behaviour. Date objects treat no hint as if the hint were String.

    Kind: Exported function
    Returns: string | number - The converted input as a primitive.
    Throws:

    • TypeError If unable to convert input to a primitive.
    Param Type Description
    input * The input to convert.
    [prefferedtype] constructor The preffered type (String or Number).

    Example

    import toPrimitive from 'to-primitive-x';
     
    const date = new Date(0);
    console.log(toPrimitive(date)); // Thu Jan 01 1970 01:00:00 GMT+0100 (CET)
    console.log(toPrimitive(date, String)); // Thu Jan 01 1970 01:00:00 GMT+0100 (CET)
    console.log(toPrimitive(date, Number)); // 0

    Install

    npm i to-primitive-x

    DownloadsWeekly Downloads

    7,738

    Version

    2.1.2

    License

    MIT

    Unpacked Size

    220 kB

    Total Files

    11

    Last publish

    Collaborators

    • avatar