Skip to content

BinaryOptions

github-actions[bot] edited this page Dec 25, 2023 · 1 revision

web-csv-toolbox / Exports / BinaryOptions

Interface: BinaryOptions

CSV Parsing Options for binary.

Hierarchy

Table of contents

Properties

Properties

charset

• Optional charset: string

You can specify the character encoding of the binary.

Remarks

TextDecoderStream is used internally. See Encoding API Compatibility for the encoding formats that can be specified.

Default

'utf-8'

Defined in

src/common/types.ts:75


decomposition

• Optional decomposition: CompressionFormat

If the binary is compressed by a compression algorithm, the decompressed CSV can be parsed by specifying the algorithm.

Remarks

Make sure the runtime you are running supports stream decompression. See DecompressionStream Compatibility.

Defined in

src/common/types.ts:64


fatal

• Optional fatal: boolean

If the binary has a invalid character, you can specify whether to throw an error.

Remarks

If you specify true, an error will be thrown. If you specify false or not specify it, the invalid character will be replaced with U+FFFD. See TextDecoderOptions.fatal for more information about the invalid character.

Defined in

src/common/types.ts:94


ignoreBOM

• Optional ignoreBOM: boolean

If the binary has a BOM, you can specify whether to ignore it.

Remarks

If you specify true, the BOM will be ignored. If you specify false or not specify it, the BOM will be treated as a normal character. See TextDecoderOptions.ignoreBOM for more information about the BOM.

Default

false

Defined in

src/common/types.ts:85

Clone this wiki locally