X\choro 48f1b97cc3 first commit 10 months ago
..
test 48f1b97cc3 first commit 10 months ago
.eslintrc 48f1b97cc3 first commit 10 months ago
.nycrc 48f1b97cc3 first commit 10 months ago
CHANGELOG.md 48f1b97cc3 first commit 10 months ago
LICENSE 48f1b97cc3 first commit 10 months ago
README.md 48f1b97cc3 first commit 10 months ago
index.d.ts 48f1b97cc3 first commit 10 months ago
index.js 48f1b97cc3 first commit 10 months ago
package.json 48f1b97cc3 first commit 10 months ago
tsconfig.json 48f1b97cc3 first commit 10 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