Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Table

Hierarchy

  • Table

Index

Properties

Accessors

Methods

Object literals

Properties

Private _headers

_headers: string[] = []

Private _rows

_rows: any[][] = []

Private _types

_types: types.ValueType[] = []

Accessors

headers

  • get headers(): string[]

structure

  • get structure(): Object

types

  • get types(): ("string" | "number" | "boolean" | "object" | "date")[]

  • Returns ("string" | "number" | "boolean" | "object" | "date")[]

Methods

Private _sql

  • _sql(url: string, tableName: string, indexes?: any[]): Promise<object>

  • Parameters

    • url: string
    • tableName: string
    • Default value indexes: any[] = []

    Returns Promise<object>

add

  • add(rows: any[][]): void

  • Parameters

    • rows: any[][]

    Returns void

column

  • column(column: number | string): any[]

  • Parameters

    • column: number | string

    Returns any[]

columnConverter

  • columnConverter(name: string | number): function

  • Parameters

    • name: string | number

    Returns function

      • (any: any): any

      • Parameters

        • any: any

        Returns any

columnIndex

  • columnIndex(name: string | number): number

  • Returns the index for a column name. Throws and error if it does not exist.

    Parameters

    • name: string | number

      name of the column

    Returns number

columnType

  • columnType(name: string | number): "string" | "number" | "boolean" | "object" | "date"

  • Parameters

    • name: string | number

    Returns "string" | "number" | "boolean" | "object" | "date"

convertRow

  • convertRow(row: any[]): any[]

  • Parameters

    • row: any[]

    Returns any[]

data

  • data(): types.DataRowType[]

map

  • map(f: function): Table

  • Parameters

    • f: function
        • (row: types.DataRowType): types.DataRowType

        • Parameters

          • row: types.DataRowType

          Returns types.DataRowType

    Returns Table

merge

query

  • query(q: string, replace?: boolean): Promise<Table>

  • Parameters

    • q: string
    • Default value replace: boolean = true

    Returns Promise<Table>

row

  • row(index: number): any[]

  • Parameters

    • index: number

    Returns any[]

rows

  • rows(): any[][]

setStructure

  • setStructure(headers: any, types: any): void

  • Parameters

    • headers: any
    • types: any

    Returns void

Static sql

  • sql(path: string): void

  • Parameters

    • path: string

    Returns void

Object literals

export

export: object

csv

  • csv(path: string): void

  • Parameters

    • path: string

    Returns void

sql

  • sql(url: string, tableName?: string): Promise<void>

  • Parameters

    • url: string
    • Optional tableName: string

    Returns Promise<void>

sqlite

  • sqlite(path: string, tableName?: string): Promise<void>

  • Parameters

    • path: string
    • Optional tableName: string

    Returns Promise<void>

Static import

import: object

csv

  • csv(path: string, structure?: types.StructureType): Promise<Table>

  • Imports from csv file, optionally guesses the columns and types.

    Parameters

    • path: string
    • Optional structure: types.StructureType

    Returns Promise<Table>

data

  • data(rows: types.DataRowType[]): Table

  • Import from data objects like {name: "Koen", age: 35}

    Parameters

    • rows: types.DataRowType[]

    Returns Table

rows

  • rows(rows: types.RawRowType[], headers?: string[]): Table

  • Imports from arrays, optionally guesses the columns and types.

    Parameters

    • rows: types.RawRowType[]
    • Optional headers: string[]

    Returns Table

sql

  • sql(path: string, tableName?: string): void

  • Imports from sqlite file.

    Parameters

    • path: string
    • Optional tableName: string

    Returns void

Generated using TypeDoc