seven c79d79ff8e 3333 3 months ago
..
test c79d79ff8e 3333 3 months ago
.eslintrc c79d79ff8e 3333 3 months ago
.nycrc c79d79ff8e 3333 3 months ago
CHANGELOG.md c79d79ff8e 3333 3 months ago
LICENSE c79d79ff8e 3333 3 months ago
README.md c79d79ff8e 3333 3 months ago
index.d.ts c79d79ff8e 3333 3 months ago
index.js c79d79ff8e 3333 3 months ago
package.json c79d79ff8e 3333 3 months ago
tsconfig.json c79d79ff8e 3333 3 months ago

README.md

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