Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sindresorhus/is-unicode-supported
Detect whether the terminal supports Unicode
https://github.com/sindresorhus/is-unicode-supported
Last synced: about 1 month ago
JSON representation
Detect whether the terminal supports Unicode
- Host: GitHub
- URL: https://github.com/sindresorhus/is-unicode-supported
- Owner: sindresorhus
- License: mit
- Created: 2021-03-17T10:03:18.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-29T14:02:59.000Z (about 1 year ago)
- Last Synced: 2024-04-13T17:42:28.663Z (7 months ago)
- Language: JavaScript
- Homepage:
- Size: 17.6 KB
- Stars: 80
- Watchers: 5
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Funding: .github/funding.yml
- License: license
- Security: .github/security.md
Awesome Lists containing this project
- awesome - sindresorhus/is-unicode-supported - Detect whether the terminal supports Unicode (others)
README
# is-unicode-supported
> Detect whether the terminal supports Unicode
This can be useful to decide whether to use Unicode characters or fallback ASCII characters in command-line output.
Note that the check is quite naive. It just assumes all non-Windows terminals support Unicode and hard-codes which Windows terminals that do support Unicode. However, I have been using this logic in some popular packages for years without problems.
## Install
```sh
npm install is-unicode-supported
```
## Usage
```js
import isUnicodeSupported from 'is-unicode-supported';
isUnicodeSupported();
//=> true
```
## API
### isUnicodeSupported()
Returns a `boolean` for whether the terminal supports Unicode.
## Related
- [is-interactive](https://github.com/sindresorhus/is-interactive) - Check if stdout or stderr is interactive
- [supports-color](https://github.com/chalk/supports-color) - Detect whether a terminal supports color
- [figures](https://github.com/sindresorhus/figures) - Unicode symbols with Windows fallbacks
- [log-symbols](https://github.com/sindresorhus/log-symbols) - Colored symbols for various log levels