Option bom

The bom option prepend the byte order mark (BOM) to the output stream.

• Type: boolean
• Optional
• Default: false
• Since: 5.4.0
• Related: see Available Options

About

The UTF-8 BOM is a sequence of Bytes at the start of a text-stream (EF BB BF or \ufeff) that allows the reader to reliably determine if file is being encoded in UTF-8.

Example

Default is the boolean value false. The bom example simply activates the option:

import assert from "node:assert";
import { stringify } from "csv-stringify/sync";

const data = stringify([["a", "b", "c"]], {
  bom: true,
});
assert.deepStrictEqual(data, "\ufeffa,b,c\n");