Skip to content

@technobuddha > library > Object > Conversion

Function: toPrimitive()

ts
function toPrimitive(input: unknown, hint: "string" | "number" | "default"): unknown;

Defined in: to-primitive.ts:21

Convert an object into its primitive (string, number, etc.) value

Parameters

ParameterTypeDefault valueDescription
inputunknownundefinedthe object
hint"string" | "number" | "default"'default'A "hint" as to what the type should be. "string", "number" or "default"

Returns

unknown

primitive value

Example

typescript
toPrimitive(42); // 42
toPrimitive('hello'); // 'hello'
toPrimitive(new Number(42)); // 42
toPrimitive(new String('abc')); // 'abc'
toPrimitive({ valueOf() { return 7; } }); // 7
toPrimitive({ toString() { return 'x'; } }, 'string'); // 'x'