Interface CsvService

interface CsvService {
    createParser(options?: CsvParseOptions): CsvParser;
    createStringifier(options?: CsvStringifyOptions): CsvStringifier;
    parse(input: string | Readable, options?: CsvParseOptions): CsvParseResult;
    stringify<T = Record<string, unknown>>(
        input: Readable | T[],
        options?: CsvStringifyOptions,
    ): CsvStringifyResult;
}

Index

Methods

createParser createStringifier parse stringify

Methods

createParser

createParser(options?: CsvParseOptions): CsvParser
Creates a CSV parser for use with streaming data
Parameters
- Optionaloptions: CsvParseOptions
  The parse options
Returns CsvParser
- Defined in packages/services/src/services/Csv/CsvService.ts:33

createStringifier

createStringifier(options?: CsvStringifyOptions): CsvStringifier
Creates a CSV stringifier for use with streaming data
Parameters
- Optionaloptions: CsvStringifyOptions
  The stringify options
Returns CsvStringifier
- Defined in packages/services/src/services/Csv/CsvService.ts:39

parse

parse(input: string | Readable, options?: CsvParseOptions): CsvParseResult
Parses CSV from the input stream or string
Parameters
- input: string | Readable
  The input stream or string
- Optionaloptions: CsvParseOptions
  The parse options
Returns CsvParseResult
- Defined in packages/services/src/services/Csv/CsvService.ts:17

stringify

stringify<T = Record<string, unknown>>(
input: Readable | T[],
options?: CsvStringifyOptions,
): CsvStringifyResult
Stringifies CSV from the input stream or array
Type Parameters
- T = Record<string, unknown>
Parameters
- input: Readable | T[]
  The input stream or array
- Optionaloptions: CsvStringifyOptions
  The stringify options
Returns CsvStringifyResult
- Defined in packages/services/src/services/Csv/CsvService.ts:24