Function createBinaryCSVParser

createBinaryCSVParser<
    const Header extends readonly string[] = readonly string[],
    const Delimiter extends string = ",",
    const Quotation extends string = "\"",
    const Charset extends string = "utf-8",
    const Strategy extends ColumnCountStrategy = ColumnCountStrategy,
>(
    options: BinaryCSVParserFactoryOptions<
        Header,
        Delimiter,
        Quotation,
        Charset,
        "array",
        Strategy,
    > & { outputFormat: "array" },
): BinaryArrayCSVParser<Header>
Factory function to create the appropriate Binary CSV parser based on options.
Type Parameters
- const Header extends readonly string[] = readonly string[]
  The type of the header row
- const Delimiter extends string = ","
- const Quotation extends string = "\""
- const Charset extends string = "utf-8"
- const Strategy extends ColumnCountStrategy = ColumnCountStrategy
Parameters
- options: BinaryCSVParserFactoryOptions<
      Header,
      Delimiter,
      Quotation,
      Charset,
      "array",
      Strategy,
  > & { outputFormat: "array" }
  Parser options including binary CSV processing specification and engine
Returns BinaryArrayCSVParser<Header>
A parser instance configured for the specified output format
Remarks
This function provides both compile-time and runtime type safety. The return type is determined by the outputFormat option:
- outputFormat: 'object' (default) → BinaryObjectCSVParser (FlexibleBinaryObjectCSVParser)
- outputFormat: 'array' → BinaryArrayCSVParser (FlexibleBinaryArrayCSVParser)
Design Intent: This factory function accepts options including engine configuration to enable future execution path optimization. The function may select the optimal internal parser implementation based on the provided options. Currently, this optimization is not implemented, but the API is designed to support it without breaking changes.
Example: Object format (default)
```
const parser = createBinaryCSVParser({
  header: ['name', 'age'],
  charset: 'utf-8',
  decompression: 'gzip',
  signal: abortController.signal,
});
const encoder = new TextEncoder();
for (const record of parser.parse(encoder.encode('Alice,30\nBob,25'))) {
  console.log(record); // { name: 'Alice', age: '30' }
}
```
Example: Array format
```
const parser = createBinaryCSVParser({
  header: ['name', 'age'],
  outputFormat: 'array',
  charset: 'utf-8',
});
const encoder = new TextEncoder();
for (const record of parser.parse(encoder.encode('Alice,30\nBob,25'))) {
  console.log(record); // ['Alice', '30']
}
```
- Defined in src/parser/api/model/createBinaryCSVParser.ts:57
createBinaryCSVParser<
    const Header extends readonly string[] = readonly string[],
    const Delimiter extends string = ",",
    const Quotation extends string = "\"",
    const Charset extends string = "utf-8",
    const Strategy extends ColumnCountStrategy = ColumnCountStrategy,
>(
    options: BinaryCSVParserFactoryOptions<
        Header,
        Delimiter,
        Quotation,
        Charset,
        "object",
        Strategy,
    > & { outputFormat: "object" },
): BinaryObjectCSVParser<Header>
Factory function to create the appropriate Binary CSV parser based on options.
Type Parameters
- const Header extends readonly string[] = readonly string[]
  The type of the header row
- const Delimiter extends string = ","
- const Quotation extends string = "\""
- const Charset extends string = "utf-8"
- const Strategy extends ColumnCountStrategy = ColumnCountStrategy
Parameters
- options: BinaryCSVParserFactoryOptions<
      Header,
      Delimiter,
      Quotation,
      Charset,
      "object",
      Strategy,
  > & { outputFormat: "object" }
  Parser options including binary CSV processing specification and engine
Returns BinaryObjectCSVParser<Header>
A parser instance configured for the specified output format
Remarks
This function provides both compile-time and runtime type safety. The return type is determined by the outputFormat option:
- outputFormat: 'object' (default) → BinaryObjectCSVParser (FlexibleBinaryObjectCSVParser)
- outputFormat: 'array' → BinaryArrayCSVParser (FlexibleBinaryArrayCSVParser)
Design Intent: This factory function accepts options including engine configuration to enable future execution path optimization. The function may select the optimal internal parser implementation based on the provided options. Currently, this optimization is not implemented, but the API is designed to support it without breaking changes.
Example: Object format (default)
```
const parser = createBinaryCSVParser({
  header: ['name', 'age'],
  charset: 'utf-8',
  decompression: 'gzip',
  signal: abortController.signal,
});
const encoder = new TextEncoder();
for (const record of parser.parse(encoder.encode('Alice,30\nBob,25'))) {
  console.log(record); // { name: 'Alice', age: '30' }
}
```
Example: Array format
```
const parser = createBinaryCSVParser({
  header: ['name', 'age'],
  outputFormat: 'array',
  charset: 'utf-8',
});
const encoder = new TextEncoder();
for (const record of parser.parse(encoder.encode('Alice,30\nBob,25'))) {
  console.log(record); // ['Alice', '30']
}
```
- Defined in src/parser/api/model/createBinaryCSVParser.ts:77
createBinaryCSVParser<
    const Header extends readonly string[] = readonly string[],
    const Delimiter extends string = ",",
    const Quotation extends string = "\"",
    const Charset extends string = "utf-8",
    const Strategy extends ColumnCountStrategy = ColumnCountStrategy,
>(
    options?: Omit<
        BinaryCSVParserFactoryOptions<
            Header,
            Delimiter,
            Quotation,
            Charset,
            "object",
            Strategy,
        >,
        "outputFormat",
    >,
): BinaryObjectCSVParser<Header>
Factory function to create the appropriate Binary CSV parser based on options.
Type Parameters
- const Header extends readonly string[] = readonly string[]
  The type of the header row
- const Delimiter extends string = ","
- const Quotation extends string = "\""
- const Charset extends string = "utf-8"
- const Strategy extends ColumnCountStrategy = ColumnCountStrategy
Parameters
- Optionaloptions: Omit<
      BinaryCSVParserFactoryOptions<
          Header,
          Delimiter,
          Quotation,
          Charset,
          "object",
          Strategy,
      >,
      "outputFormat",
  >
  Parser options including binary CSV processing specification and engine
Returns BinaryObjectCSVParser<Header>
A parser instance configured for the specified output format
Remarks
This function provides both compile-time and runtime type safety. The return type is determined by the outputFormat option:
- outputFormat: 'object' (default) → BinaryObjectCSVParser (FlexibleBinaryObjectCSVParser)
- outputFormat: 'array' → BinaryArrayCSVParser (FlexibleBinaryArrayCSVParser)
Design Intent: This factory function accepts options including engine configuration to enable future execution path optimization. The function may select the optimal internal parser implementation based on the provided options. Currently, this optimization is not implemented, but the API is designed to support it without breaking changes.
Example: Object format (default)
```
const parser = createBinaryCSVParser({
  header: ['name', 'age'],
  charset: 'utf-8',
  decompression: 'gzip',
  signal: abortController.signal,
});
const encoder = new TextEncoder();
for (const record of parser.parse(encoder.encode('Alice,30\nBob,25'))) {
  console.log(record); // { name: 'Alice', age: '30' }
}
```
Example: Array format
```
const parser = createBinaryCSVParser({
  header: ['name', 'age'],
  outputFormat: 'array',
  charset: 'utf-8',
});
const encoder = new TextEncoder();
for (const record of parser.parse(encoder.encode('Alice,30\nBob,25'))) {
  console.log(record); // ['Alice', '30']
}
```
- Defined in src/parser/api/model/createBinaryCSVParser.ts:97
createBinaryCSVParser<
    const Header extends readonly string[] = readonly string[],
    const Delimiter extends string = ",",
    const Quotation extends string = "\"",
    const Charset extends string = "utf-8",
    const OutputFormat extends "object" | "array" = "object" | "array",
    const Strategy extends ColumnCountStrategy = ColumnCountStrategy,
>(
    options: BinaryCSVParserFactoryOptions<
        Header,
        Delimiter,
        Quotation,
        Charset,
        OutputFormat,
        Strategy,
    >,
): BinaryArrayCSVParser<Header>
| BinaryObjectCSVParser<Header>
Factory function to create the appropriate Binary CSV parser based on options.
Type Parameters
- const Header extends readonly string[] = readonly string[]
  The type of the header row
- const Delimiter extends string = ","
- const Quotation extends string = "\""
- const Charset extends string = "utf-8"
- const OutputFormat extends "object" | "array" = "object" | "array"
- const Strategy extends ColumnCountStrategy = ColumnCountStrategy
Parameters
- options: BinaryCSVParserFactoryOptions<
      Header,
      Delimiter,
      Quotation,
      Charset,
      OutputFormat,
      Strategy,
  >
  Parser options including binary CSV processing specification and engine
Returns BinaryArrayCSVParser<Header> | BinaryObjectCSVParser<Header>
A parser instance configured for the specified output format
Remarks
This function provides both compile-time and runtime type safety. The return type is determined by the outputFormat option:
- outputFormat: 'object' (default) → BinaryObjectCSVParser (FlexibleBinaryObjectCSVParser)
- outputFormat: 'array' → BinaryArrayCSVParser (FlexibleBinaryArrayCSVParser)
Design Intent: This factory function accepts options including engine configuration to enable future execution path optimization. The function may select the optimal internal parser implementation based on the provided options. Currently, this optimization is not implemented, but the API is designed to support it without breaking changes.
Example: Object format (default)
```
const parser = createBinaryCSVParser({
  header: ['name', 'age'],
  charset: 'utf-8',
  decompression: 'gzip',
  signal: abortController.signal,
});
const encoder = new TextEncoder();
for (const record of parser.parse(encoder.encode('Alice,30\nBob,25'))) {
  console.log(record); // { name: 'Alice', age: '30' }
}
```
Example: Array format
```
const parser = createBinaryCSVParser({
  header: ['name', 'age'],
  outputFormat: 'array',
  charset: 'utf-8',
});
const encoder = new TextEncoder();
for (const record of parser.parse(encoder.encode('Alice,30\nBob,25'))) {
  console.log(record); // ['Alice', '30']
}
```
- Defined in src/parser/api/model/createBinaryCSVParser.ts:118

Function createBinaryCSVParser

Type Parameters

Parameters

Returns BinaryArrayCSVParser<Header>

Remarks

Example: Object format (default)

Example: Array format

Type Parameters

Parameters

Returns BinaryObjectCSVParser<Header>

Remarks

Example: Object format (default)

Example: Array format

Type Parameters

Parameters

Returns BinaryObjectCSVParser<Header>

Remarks

Example: Object format (default)

Example: Array format

Type Parameters

Parameters

Returns BinaryArrayCSVParser<Header> | BinaryObjectCSVParser<Header>

Remarks

Example: Object format (default)

Example: Array format

Settings