Skip to content

A helper to optimistically set Symbol.toStringTag, when possible.

License

Notifications You must be signed in to change notification settings

es-shims/es-set-tostringtag

This branch is up to date with main.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Jan 2, 2025
90e506f · Jan 2, 2025

History

34 Commits
Dec 31, 2024
Dec 31, 2024
Dec 21, 2022
Dec 21, 2022
Dec 21, 2022
Dec 31, 2024
Jan 2, 2025
Dec 21, 2022
Dec 31, 2024
Dec 31, 2024
Dec 31, 2024
Jan 2, 2025
Mar 11, 2024

Repository files navigation

es-set-tostringtag Version Badge

github actions coverage License Downloads

npm badge

A helper to optimistically set Symbol.toStringTag, when possible.

Example

Most common usage:

var assert = require('assert');
var setToStringTag = require('es-set-tostringtag');

var obj = {};

assert.equal(Object.prototype.toString.call(obj), '[object Object]');

setToStringTag(obj, 'tagged!');

assert.equal(Object.prototype.toString.call(obj), '[object tagged!]');

Options

An optional options argument can be provided as the third argument. The available options are:

force

If the force option is set to true, the toStringTag will be set even if it is already set.

nonConfigurable

If the nonConfigurable option is set to true, the toStringTag will be defined as non-configurable when possible.

Tests

Simply clone the repo, npm install, and run npm test