Repository navigation
ParseBinaryOptions
web-csv-toolbox / Exports / ParseBinaryOptions
Parse options for CSV binary.
| Name | Type |
|---|---|
Header |
extends ReadonlyArray<string> |
-
ParseOptions<Header> -
↳
ParseBinaryOptions
• 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'• 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.
• Optional demiliter: string
CSV field delimiter.
Remarks
If you want to parse TSV, specify '\t'.
This library supports multi-character delimiters.
Default
','• 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.
• Optional header: Header
CSV header.
Remarks
If you specify this option, the first record will be treated as a normal record.
If you don't specify this option, the first record will be treated as a header.
Default
undefined• 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• Optional quotation: string
CSV field quotation.
Remarks
This library supports multi-character quotations.
Default
'"'