@stdlib/assert-has-tostringtag-support

What is @stdlib/assert-has-tostringtag-support?

@stdlib/assert-has-tostringtag-support is a package that allows you to check if the environment supports the `Symbol.toStringTag` property. This property is used to customize the default string description of objects.

What are @stdlib/assert-has-tostringtag-support's main functionalities?

Check for Symbol.toStringTag support

This feature allows you to check if the current JavaScript environment supports the `Symbol.toStringTag` property. The code sample demonstrates how to use the package to perform this check and log the result.

const hasToStringTagSupport = require('@stdlib/assert-has-tostringtag-support');

if (hasToStringTagSupport()) {
  console.log('Environment supports Symbol.toStringTag');
} else {
  console.log('Environment does not support Symbol.toStringTag');
}

Other packages similar to @stdlib/assert-has-tostringtag-support

has-symbols

The `has-symbols` package checks if the environment supports ES6 symbols, including `Symbol.toStringTag`. It provides a broader check for symbol support compared to `@stdlib/assert-has-tostringtag-support`, which is specifically focused on `Symbol.toStringTag`.

is-symbol

The `is-symbol` package checks if a given value is a symbol. While it does not directly check for `Symbol.toStringTag` support, it can be used in conjunction with other checks to determine symbol-related capabilities in the environment.

has-tostringtag

The `has-tostringtag` package specifically checks for the presence of the `Symbol.toStringTag` property in the environment. It is very similar to `@stdlib/assert-has-tostringtag-support` in terms of functionality.

README

Symbol.toStringTag Support

Detect native Symbol.toStringTag support.

Installation

npm install @stdlib/assert-has-tostringtag-support

Usage

var hasToStringTagSupport = require( '@stdlib/assert-has-tostringtag-support' );

hasToStringTagSupport()

Detects if a runtime environment supports ES2015 Symbol.toStringTag.

var bool = hasToStringTagSupport();
// returns <boolean>

Examples

var hasToStringTagSupport = require( '@stdlib/assert-has-tostringtag-support' );

var bool = hasToStringTagSupport();
if ( bool ) {
    console.log( 'Environment has `toStringTag` support.' );
} else {
    console.log( 'Environment lacks `toStringTag` support.' );
}

---

CLI

Installation

To use the module as a general utility, install the module globally

npm install -g @stdlib/assert-has-tostringtag-support

Usage

Usage: has-tostringtag-support [options]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.

Examples

$ has-tostringtag-support
<boolean>

---

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

---

License

See LICENSE.

Copyright

Copyright © 2016-2022. The Stdlib Authors.