Class Row

Represents a row of data in a DataFrame.

Remarks

Row provides type-safe access to columnar data with support for various data types including primitives, dates, and binary data.

Example

const row = new Row(schema, { name: "Alice", age: 30 });
const name = row.getString(0);
const age = row.getInt(1);

Implements

Indexable

  • [index: number]: any

Constructors

constructor

Accessors

length

Methods

size schema isNullAt get getAs getBoolean getByte getShort getInt getLong getFloat getDouble getDecimal getString getBinary getUint8Array getDate getTimestamp toJSON

Constructors

constructor

Accessors

length

  • get length(): number

    Returns the number of elements in the Row (alias for size()).

    Returns number

    The number of columns in this row

Methods

size

schema

isNullAt

  • isNullAt(i: number): boolean

    Checks whether the value at position i is null.

    Parameters

    • i: number

      The column index (0-based)

    Returns boolean

    True if the value is null or undefined, false otherwise

get

  • get(i: number): any

    Gets the value at the specified column index.

    Parameters

    • i: number

      The column index (0-based)

    Returns any

    The value at the specified index as a plain JavaScript value

    Throws

    Error if the field does not exist

getAs

  • getAs<T>(i: number): T

    Returns the value at position i, cast to type T.

    Type Parameters

    • T

      The type to cast the value to

    Parameters

    • i: number

      The column index (0-based)

    Returns T

    The value at the specified index, cast to type T

getBoolean

  • getBoolean(i: number): boolean

    Returns the value at position i as a boolean.

    Parameters

    • i: number

      The column index (0-based)

    Returns boolean

    The boolean value at the specified index

    Throws

    Error if the value is not a boolean

getByte

  • getByte(i: number): number

    Returns the value at position i as a byte (8-bit signed integer).

    Parameters

    • i: number

      The column index (0-based)

    Returns number

    The byte value at the specified index (range: -128 to 127)

    Throws

    Error if the value is not a valid byte

getShort

  • getShort(i: number): number

    Returns the value at position i as a short (16-bit signed integer).

    Parameters

    • i: number

      The column index (0-based)

    Returns number

    The short value at the specified index (range: -32768 to 32767)

    Throws

    Error if the value is not a valid short

getInt

  • getInt(i: number): number

    Returns the value at position i as an integer (32-bit signed integer).

    Parameters

    • i: number

      The column index (0-based)

    Returns number

    The integer value at the specified index

    Throws

    Error if the value is not a valid integer

getLong

  • getLong(i: number): bigint

    Returns the value at position i as a long (64-bit signed integer).

    Parameters

    • i: number

      The column index (0-based)

    Returns bigint

    The bigint value at the specified index

    Throws

    Error if the value cannot be converted to bigint

getFloat

  • getFloat(i: number): number

    Returns the value at position i as a float (32-bit floating point number).

    Parameters

    • i: number

      The column index (0-based)

    Returns number

    The float value at the specified index

getDouble

  • getDouble(i: number): number

    Returns the value at position i as a double (64-bit floating point number).

    Parameters

    • i: number

      The column index (0-based)

    Returns number

    The double value at the specified index

getDecimal

  • getDecimal(i: number): number

    Returns the value at position i as a decimal number.

    Parameters

    • i: number

      The column index (0-based)

    Returns number

    The decimal value at the specified index

    Throws

    Error if the value is not a valid decimal

getString

  • getString(i: number): string

    Returns the value at position i as a string.

    Parameters

    • i: number

      The column index (0-based)

    Returns string

    The string value at the specified index

    Throws

    Error if the value is not a string

getBinary

  • getBinary(i: number): Buffer

    Returns the value at position i as a Buffer (binary data).

    Parameters

    • i: number

      The column index (0-based)

    Returns Buffer

    The binary value as a Node.js Buffer

    Throws

    Error if the value cannot be converted to binary

getUint8Array

  • getUint8Array(i: number): Uint8Array

    Returns the value at position i as a Uint8Array.

    Parameters

    • i: number

      The column index (0-based)

    Returns Uint8Array

    The binary value as a Uint8Array

    Throws

    Error if the value is not a valid byte array

getDate

  • getDate(i: number): Date

    Returns the value at position i as a Date.

    Parameters

    • i: number

      The column index (0-based)

    Returns Date

    The date value at the specified index

    Throws

    Error if the value cannot be converted to a Date

getTimestamp

  • getTimestamp(i: number): Date

    Returns the value at position i as a timestamp (Date).

    Parameters

    • i: number

      The column index (0-based)

    Returns Date

    The timestamp value as a Date object

    Throws

    Error if the field is not a TimestampType or cannot be converted

toJSON

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods