row

const row: {
  getBinary: Uint8Array<ArrayBufferLike> | null;
  getBoolean: boolean | null;
  getDate: Date | null;
  getDouble: number | null;
  getInt: number | null;
  getLong: bigint | null;
  getString: string | null;
};

Defined in: types/row.ts:74

Typed runtime accessors for Row values. Each getter checks the column exists and the value matches the expected JavaScript type. Returns null when the value is null. Throws InvalidInputError on a type mismatch or missing column.

Use when the schema isn’t known at compile time. The alternative, df.as<Schema>().collect(), gives full compile-time typing instead. Matches the Scala Row.getInt, getLong, and getAs[T] pattern.

Type Declaration

getBinary()

getBinary(r, col): Uint8Array<ArrayBufferLike> | null;

Spark BinaryType.

Parameters

Parameter	Type
r	Row
col	string

Returns

Uint8Array<ArrayBufferLike> | null

getBoolean()

getBoolean(r, col): boolean | null;

Spark BooleanType.

Parameters

Parameter	Type
r	Row
col	string

Returns

boolean | null

getDate()

getDate(r, col): Date | null;

Spark DateType / TimestampType.

Parameters

Parameter	Type
r	Row
col	string

Returns

Date | null

getDouble()

getDouble(r, col): number | null;

Spark DoubleType / FloatType.

Parameters

Parameter	Type
r	Row
col	string

Returns

number | null

getInt()

getInt(r, col): number | null;

Spark IntegerType / ShortType / ByteType.

Parameters

Parameter	Type
r	Row
col	string

Returns

number | null

getLong()

getLong(r, col): bigint | null;

Spark LongType (decoded as bigint to preserve 64-bit precision).

Parameters

Parameter	Type
r	Row
col	string

Returns

bigint | null

getString()

getString(r, col): string | null;

Spark StringType. Also covers DecimalType (decoded as string).

Parameters

Parameter	Type
r	Row
col	string

Returns

string | null

Example

import { row } from "@spark-connect-js/core";

  const [stats] = await df.collect();
  const total = row.getLong(stats, "count");      // bigint | null
  const mean  = row.getDouble(stats, "average");  // number | null