es-set-tostringtag

es-set-tostringtag

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

Changelog

v2.1.0 - 2025-01-01

Commits

• [actions] split out node 10-20, and 20+ ede033c
• [types] use shared config 28ef164
• [New] add nonConfigurable option 3bee3f0
• [Fix] validate boolean option argument 3c8a609
• [Dev Deps] update @arethetypeswrong/cli, @ljharb/eslint-config, @ljharb/tsconfig, @types/get-intrinsic, @types/tape, auto-changelog, tape 501a969
• [Tests] add coverage 18af289
• [readme] document force option bd446a1
• [Tests] use @arethetypeswrong/cli 7c2c2fa
• [Tests] replace aud with npm audit 9e372d7
• [Deps] update get-intrinsic 7df1216
• [Deps] update hasown 993a7d2
• [Dev Deps] add missing peer dep 148ed8d