to-primitive-x
v2.1.2
Converts a JavaScript object to a primitive value.
0/weekUpdated 3 years agoMITUnpacked: 219.6 KB
Published by Graham Fairweather
npm install to-primitive-x
title="Travis status">
alt="Travis status" height="18">
title="Dependency status">
alt="Dependency status" height="18"/>
title="devDependency status">
alt="devDependency status" height="18"/>
title="npm version">
alt="npm version" height="18">
title="jsDelivr hits"> alt="jsDelivr hits" height="18">
title="bettercodehub score"> alt="bettercodehub score" height="18">
title="Coverage Status">
alt="Coverage Status" height="18">
to-primitive-x
Converts a JavaScript object to a primitive value.
$3
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
``js
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
``