Logo for jsDocs.io

strip-bom

  • Version 5.0.0
  • Published
  • 3.63 kB
  • No dependencies
  • MIT license

Install

npm i strip-bom
yarn add strip-bom
pnpm add strip-bom

Overview

Strip UTF-8 byte order mark (BOM) from a string

Index

Functions

Functions

function stripBom

stripBom: (string: string) => string;

  • Strip UTF-8 [byte order mark](https://en.wikipedia.org/wiki/Byte_order_mark#UTF-8) (BOM) from a string.

    Example 1

    import stripBom from 'strip-bom';
    

    stripBom('\uFEFFunicorn');
    //=> 'unicorn'

Package Files (1)

Dependencies (0)

No dependencies.

Dev Dependencies (3)

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/strip-bom.

  • Markdown
    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/strip-bom)
  • HTML
    <a href="https://www.jsdocs.io/package/strip-bom"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>