Function createStringCSVParser

createStringCSVParser<Header extends readonly string[] = readonly string[]>(
    options: Omit<CSVProcessingOptions<Header, ",", "\"">, "outputFormat"> & {
        outputFormat: "array";
    },
): StringArrayCSVParser<Header>
Factory function to create the appropriate String CSV parser based on options.
Type Parameters
- Header extends readonly string[] = readonly string[]
  The type of the header row
Parameters
- options: Omit<CSVProcessingOptions<Header, ",", "\"">, "outputFormat"> & {
  outputFormat: "array";
  }
  CSV processing specification (excludes execution strategy)
Returns StringArrayCSVParser<Header>
A parser instance configured for the specified output format
Remarks
This is a low-level factory function that accepts CSVProcessingOptions. It does NOT accept execution strategy options (engine). For high-level APIs with execution strategy support, use parseString() and related functions.

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)
Example: Object format (default)
```
const parser = createStringCSVParser({
  header: ['name', 'age'] as const,
  delimiter: ',',
  signal: abortController.signal,
  // engine is NOT available (low-level API)
});
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'] as const,
  outputFormat: 'array',
  // engine is NOT available (low-level API)
});
for (const record of parser.parse('Alice,30\nBob,25')) {
  console.log(record); // ['Alice', '30']
}
```
- Defined in src/parser/api/model/createStringCSVParser.ts:52
createStringCSVParser<Header extends readonly string[] = readonly string[]>(
    options: Omit<CSVProcessingOptions<Header, ",", "\"">, "outputFormat"> & {
        outputFormat: "object";
    },
): StringObjectCSVParser<Header>
Factory function to create the appropriate String CSV parser based on options.
Type Parameters
- Header extends readonly string[] = readonly string[]
  The type of the header row
Parameters
- options: Omit<CSVProcessingOptions<Header, ",", "\"">, "outputFormat"> & {
  outputFormat: "object";
  }
  CSV processing specification (excludes execution strategy)
Returns StringObjectCSVParser<Header>
A parser instance configured for the specified output format
Remarks
This is a low-level factory function that accepts CSVProcessingOptions. It does NOT accept execution strategy options (engine). For high-level APIs with execution strategy support, use parseString() and related functions.

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)
Example: Object format (default)
```
const parser = createStringCSVParser({
  header: ['name', 'age'] as const,
  delimiter: ',',
  signal: abortController.signal,
  // engine is NOT available (low-level API)
});
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'] as const,
  outputFormat: 'array',
  // engine is NOT available (low-level API)
});
for (const record of parser.parse('Alice,30\nBob,25')) {
  console.log(record); // ['Alice', '30']
}
```
- Defined in src/parser/api/model/createStringCSVParser.ts:60
createStringCSVParser<Header extends readonly string[] = readonly string[]>(
    options: Omit<CSVProcessingOptions<Header, ",", "\"">, "outputFormat"> & {
        outputFormat: "object" | "array";
    },
): StringArrayCSVParser<Header>
| StringObjectCSVParser<Header>
Factory function to create the appropriate String CSV parser based on options.
Type Parameters
- Header extends readonly string[] = readonly string[]
  The type of the header row
Parameters
- options: Omit<CSVProcessingOptions<Header, ",", "\"">, "outputFormat"> & {
  outputFormat: "object" | "array";
  }
  CSV processing specification (excludes execution strategy)
Returns StringArrayCSVParser<Header> | StringObjectCSVParser<Header>
A parser instance configured for the specified output format
Remarks
This is a low-level factory function that accepts CSVProcessingOptions. It does NOT accept execution strategy options (engine). For high-level APIs with execution strategy support, use parseString() and related functions.

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)
Example: Object format (default)
```
const parser = createStringCSVParser({
  header: ['name', 'age'] as const,
  delimiter: ',',
  signal: abortController.signal,
  // engine is NOT available (low-level API)
});
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'] as const,
  outputFormat: 'array',
  // engine is NOT available (low-level API)
});
for (const record of parser.parse('Alice,30\nBob,25')) {
  console.log(record); // ['Alice', '30']
}
```
- Defined in src/parser/api/model/createStringCSVParser.ts:68
createStringCSVParser<Header extends readonly string[] = readonly string[]>(
options?: CSVProcessingOptions<Header, ",", "\"">,
): StringObjectCSVParser<Header>
Factory function to create the appropriate String CSV parser based on options.
Type Parameters
- Header extends readonly string[] = readonly string[]
  The type of the header row
Parameters
- Optionaloptions: CSVProcessingOptions<Header, ",", "\"">
  CSV processing specification (excludes execution strategy)
Returns StringObjectCSVParser<Header>
A parser instance configured for the specified output format
Remarks
This is a low-level factory function that accepts CSVProcessingOptions. It does NOT accept execution strategy options (engine). For high-level APIs with execution strategy support, use parseString() and related functions.

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)
Example: Object format (default)
```
const parser = createStringCSVParser({
  header: ['name', 'age'] as const,
  delimiter: ',',
  signal: abortController.signal,
  // engine is NOT available (low-level API)
});
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'] as const,
  outputFormat: 'array',
  // engine is NOT available (low-level API)
});
for (const record of parser.parse('Alice,30\nBob,25')) {
  console.log(record); // ['Alice', '30']
}
```
- Defined in src/parser/api/model/createStringCSVParser.ts:76

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 StringArrayCSVParser<Header> | StringObjectCSVParser<Header>

Remarks

Example: Object format (default)

Example: Array format

Type Parameters

Parameters

Returns StringObjectCSVParser<Header>

Remarks

Example: Object format (default)

Example: Array format

Settings