@stdlib/string-remove-utf8-bom

Remove a UTF-8 byte order mark (BOM) from the beginning of a string.

Usage no npm install needed!

<script type="module">
  import stdlibStringRemoveUtf8Bom from 'https://cdn.skypack.dev/@stdlib/string-remove-utf8-bom';
</script>

README

Remove UTF-8 BOM

NPM version Build Status Coverage Status

Remove a UTF-8 byte order mark (BOM) from the beginning of a string.

Installation

npm install @stdlib/string-remove-utf8-bom

Usage

var removeUTF8BOM = require( '@stdlib/string-remove-utf8-bom' );

removeUTF8BOM( str )

Removes a UTF-8 byte order mark (BOM) from the beginning of a string.

var str = removeUTF8BOM( '\ufeffbeep' );
// returns 'beep'

Examples

var removeUTF8BOM = require( '@stdlib/string-remove-utf8-bom' );

var str = removeUTF8BOM( '\ufeffbeep' );
// returns 'beep'

str = removeUTF8BOM( 'boop\ufeff' );
// returns 'boop\ufeff'

str = removeUTF8BOM( 'be\ufeffbop' );
// returns 'be\ufeffbop'

str = removeUTF8BOM( 'foobar' );
// returns 'foobar'

CLI

Installation

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

npm install -g @stdlib/string-remove-utf8-bom

Usage

Usage: remove-utf8-bom [options] [<string>]

Options:

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

Examples

Assuming a shell which understands escape sequences,

$ remove-utf8-bom "\xEF\xBB\xBFbeep boop"
beep boop

To use as a standard stream,

$ echo -n '\ufeffbeep' | remove-utf8-bom
beep

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

Chat

License

See LICENSE.

Copyright

Copyright © 2016-2022. The Stdlib Authors.