Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • CSVBitByBit

Index

Constructors

constructor

Methods

arrayToCsv

  • Converts a 2D array to CSV text. Example: array=[['name','age'], ['John','30']] → 'name,age John,30'

    group

    generate

    shortname

    array to csv

    drawable

    false

    Parameters

    Returns string

    CSV text

getColumnCount

  • Gets the number of columns in a CSV file. Example: csv='name,age,city John,30,NYC' → 3

    group

    query

    shortname

    column count

    drawable

    false

    Parameters

    Returns number

    Number of columns

getHeaders

  • Gets the headers from a CSV file. Example: csv='name,age John,30', headerRow=0 → ['name', 'age']

    group

    query

    shortname

    get headers

    drawable

    false

    Parameters

    Returns string[]

    Array of header names

getRowCount

  • Gets the number of rows in a CSV file (excluding headers if specified). Example: csv='name,age John,30 Jane,25', headerRow=0 → 2

    group

    query

    shortname

    row count

    drawable

    false

    Parameters

    Returns number

    Number of data rows

jsonToCsv

  • Converts an array of JSON objects to CSV text. Example: json=[{'name':'John','age':'30'}], headers=['name','age'] → 'name,age John,30'

    group

    generate

    shortname

    json to csv

    drawable

    false

    Type parameters

    • T = Record<string, unknown>

    Parameters

    • inputs: JsonToCsvDto<T>

      JSON array, headers, and formatting options

    Returns string

    CSV text

jsonToCsvAuto

  • Converts an array of JSON objects to CSV text using object keys as headers. Example: json=[{'name':'John','age':'30'}] → 'name,age John,30'

    group

    generate

    shortname

    json to csv auto

    drawable

    false

    Type parameters

    • T = Record<string, unknown>

    Parameters

    Returns string

    CSV text

parseToArray

  • Parses CSV text to a 2D array of strings (rows and columns). Example: csv='a,b,c 1,2,3' → [['a','b','c'], ['1','2','3']]

    group

    parse

    shortname

    parse to array

    drawable

    false

    Parameters

    Returns string[][]

    2D array of strings

parseToJson

  • Parses CSV text to an array of JSON objects using headers. Example: csv='name,age John,30 Jane,25', headerRow=0, dataStartRow=1 → [{'name':'John','age':'30'}, {'name':'Jane','age':'25'}]

    group

    parse

    shortname

    parse to json

    drawable

    false

    Type parameters

    • T = Record<string, string | number>

    Parameters

    Returns T[]

    Array of JSON objects

parseToJsonWithHeaders

  • Parses CSV text to JSON using custom headers (ignores CSV headers if present). Example: csv='John,30 Jane,25', headers=['name','age'] → [{'name':'John','age':'30'}, {'name':'Jane','age':'25'}]

    group

    parse

    shortname

    parse to json with headers

    drawable

    false

    Type parameters

    • T = Record<string, string | number>

    Parameters

    Returns T[]

    Array of JSON objects

queryColumn

  • Queries CSV data by column/header name and returns all values in that column. Example: csv='name,age John,30 Jane,25', column='name' → ['John', 'Jane']

    group

    query

    shortname

    query column

    drawable

    false

    Type parameters

    • T = Record<string, string | number>

    Parameters

    Returns (string | number)[]

    Array of values from the specified column

queryRowsByValue

  • Queries CSV data and filters rows where a column matches a value. Example: csv='name,age John,30 Jane,25', column='age', value='30' → [{'name':'John','age':'30'}]

    group

    query

    shortname

    query rows by value

    drawable

    false

    Type parameters

    • T = Record<string, string | number>

    Parameters

    Returns T[]

    Array of matching rows as JSON objects

Generated using TypeDoc