Function createStringCSVParser

createStringCSVParser<
    const Header extends readonly string[] = readonly string[],
    const Delimiter extends string = ",",
    const Quotation extends string = "\"",
    const Strategy extends ColumnCountStrategy = ColumnCountStrategy,
>(
    options: StringCSVParserFactoryOptions<
        Header,
        Delimiter,
        Quotation,
        "array",
        Strategy,
    > & { outputFormat: "array" },
): StringArrayCSVParser<Header>
Factory function to create the appropriate String 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 Strategy extends ColumnCountStrategy = ColumnCountStrategy
Parameters
- options: StringCSVParserFactoryOptions<Header, Delimiter, Quotation, "array", Strategy> & {
  outputFormat: "array";
  }
  Parser options including CSV processing specification and engine
Returns StringArrayCSVParser<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) → StringObjectCSVParser (FlexibleStringObjectCSVParser)
- outputFormat: 'array' → StringArrayCSVParser (FlexibleStringArrayCSVParser)
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 = createStringCSVParser({
  header: ['name', 'age'],
  delimiter: ',',
  signal: abortController.signal,
});
for (const record of parser.parse('Alice,30\nBob,25')) {
  console.log(record); // { name: 'Alice', age: '30' }
}
```
Example: Array format
```
const parser = createStringCSVParser({
  header: ['name', 'age'],
  outputFormat: 'array',
});
for (const record of parser.parse('Alice,30\nBob,25')) {
  console.log(record); // ['Alice', '30']
}
```
- Defined in src/parser/api/model/createStringCSVParser.ts:53
createStringCSVParser<
    const Header extends readonly string[] = readonly string[],
    const Delimiter extends string = ",",
    const Quotation extends string = "\"",
    const Strategy extends ColumnCountStrategy = ColumnCountStrategy,
>(
    options: StringCSVParserFactoryOptions<
        Header,
        Delimiter,
        Quotation,
        "object",
        Strategy,
    > & { outputFormat: "object" },
): StringObjectCSVParser<Header>
Factory function to create the appropriate String 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 Strategy extends ColumnCountStrategy = ColumnCountStrategy
Parameters
- options: StringCSVParserFactoryOptions<Header, Delimiter, Quotation, "object", Strategy> & {
  outputFormat: "object";
  }
  Parser options including CSV processing specification and engine
Returns StringObjectCSVParser<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) → StringObjectCSVParser (FlexibleStringObjectCSVParser)
- outputFormat: 'array' → StringArrayCSVParser (FlexibleStringArrayCSVParser)
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 = createStringCSVParser({
  header: ['name', 'age'],
  delimiter: ',',
  signal: abortController.signal,
});
for (const record of parser.parse('Alice,30\nBob,25')) {
  console.log(record); // { name: 'Alice', age: '30' }
}
```
Example: Array format
```
const parser = createStringCSVParser({
  header: ['name', 'age'],
  outputFormat: 'array',
});
for (const record of parser.parse('Alice,30\nBob,25')) {
  console.log(record); // ['Alice', '30']
}
```
- Defined in src/parser/api/model/createStringCSVParser.ts:71
createStringCSVParser<
    const Header extends readonly string[] = readonly string[],
    const Delimiter extends string = ",",
    const Quotation extends string = "\"",
    const Strategy extends ColumnCountStrategy = ColumnCountStrategy,
>(
    options?: Omit<
        StringCSVParserFactoryOptions<
            Header,
            Delimiter,
            Quotation,
            "object",
            Strategy,
        >,
        "outputFormat",
    >,
): StringObjectCSVParser<Header>
Factory function to create the appropriate String 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 Strategy extends ColumnCountStrategy = ColumnCountStrategy
Parameters
- Optionaloptions: Omit<
      StringCSVParserFactoryOptions<
          Header,
          Delimiter,
          Quotation,
          "object",
          Strategy,
      >,
      "outputFormat",
  >
  Parser options including CSV processing specification and engine
Returns StringObjectCSVParser<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) → StringObjectCSVParser (FlexibleStringObjectCSVParser)
- outputFormat: 'array' → StringArrayCSVParser (FlexibleStringArrayCSVParser)
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 = createStringCSVParser({
  header: ['name', 'age'],
  delimiter: ',',
  signal: abortController.signal,
});
for (const record of parser.parse('Alice,30\nBob,25')) {
  console.log(record); // { name: 'Alice', age: '30' }
}
```
Example: Array format
```
const parser = createStringCSVParser({
  header: ['name', 'age'],
  outputFormat: 'array',
});
for (const record of parser.parse('Alice,30\nBob,25')) {
  console.log(record); // ['Alice', '30']
}
```
- Defined in src/parser/api/model/createStringCSVParser.ts:89
createStringCSVParser<
    const Header extends readonly string[] = readonly string[],
    const Delimiter extends string = ",",
    const Quotation extends string = "\"",
    const OutputFormat extends "object" | "array" = "object" | "array",
    const Strategy extends ColumnCountStrategy = ColumnCountStrategy,
>(
    options: StringCSVParserFactoryOptions<
        Header,
        Delimiter,
        Quotation,
        OutputFormat,
        Strategy,
    >,
): StringArrayCSVParser<Header>
| StringObjectCSVParser<Header>
Factory function to create the appropriate String 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 OutputFormat extends "object" | "array" = "object" | "array"
- const Strategy extends ColumnCountStrategy = ColumnCountStrategy
Parameters
- options: StringCSVParserFactoryOptions<
      Header,
      Delimiter,
      Quotation,
      OutputFormat,
      Strategy,
  >
  Parser options including CSV processing specification and engine
Returns StringArrayCSVParser<Header> | StringObjectCSVParser<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) → StringObjectCSVParser (FlexibleStringObjectCSVParser)
- outputFormat: 'array' → StringArrayCSVParser (FlexibleStringArrayCSVParser)
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 = createStringCSVParser({
  header: ['name', 'age'],
  delimiter: ',',
  signal: abortController.signal,
});
for (const record of parser.parse('Alice,30\nBob,25')) {
  console.log(record); // { name: 'Alice', age: '30' }
}
```
Example: Array format
```
const parser = createStringCSVParser({
  header: ['name', 'age'],
  outputFormat: 'array',
});
for (const record of parser.parse('Alice,30\nBob,25')) {
  console.log(record); // ['Alice', '30']
}
```
- Defined in src/parser/api/model/createStringCSVParser.ts:108

Function createStringCSVParser

Type Parameters

Parameters

Returns StringArrayCSVParser<Header>

Remarks

Example: Object format (default)

Example: Array format

Type Parameters

Parameters

Returns StringObjectCSVParser<Header>

Remarks

Example: Object format (default)

Example: Array format

Type Parameters

Parameters

Returns StringObjectCSVParser<Header>

Remarks

Example: Object format (default)

Example: Array format

Type Parameters

Parameters

Returns StringArrayCSVParser<Header> | StringObjectCSVParser<Header>

Remarks

Example: Object format (default)

Example: Array format

Settings