Options
The Options
object describes the configuration available for the operation of parsing CSV files using the csv.parse
function and the csv.Parser
class.
Properties
Property | Type | Description |
---|---|---|
delimiter | string | The character used to separate fields in the CSV file. Default is ',' . |
skipFirstLine | boolean | Whether to skip the first line of the CSV file. Default is false . |
fromLine | (optional) number | The line number from which to start reading the CSV file. Default is 0 . |
toLine | (optional) number | The line number at which to stop reading the CSV file. If the option is not set, then read until the end. |
Example
import { open } from 'k6/experimental/fs';
import csv from 'k6/experimental/csv';
let file;
let parser;
(async function () {
file = await open('data.csv');
parser = new csv.Parser(file, {
delimiter: ',',
skipFirstLine: true,
fromLine: 2,
toLine: 8,
});
})();
export default async function () {
// The `next` method attempts to read the next row from the CSV file.
//
// It returns an iterator-like object with a `done` property that indicates whether
// there are more rows to read, and a `value` property that contains the row fields
// as an array.
const { done, value } = await parser.next();
if (done) {
throw new Error('No more rows to read');
}
// We expect the `value` property to be an array of strings, where each string is a field
// from the CSV record.
console.log(done, value);
}