Class DataType<TType, TChildren>`Abstract`

An abstract base class for classes that encapsulate metadata about each of the logical types that Arrow can represent.

Type Parameters

TType extends Type = Type
TChildren extends TypeMap = any

Constructors

constructor

new DataType<TType extends Type = Type, TChildren extends TypeMap = any>(
typeId: TType,
): DataType<TType, TChildren>
Type Parameters
- TType extends Type = Type
- TChildren extends TypeMap = any
Parameters
- typeId: TType
Returns DataType<TType, TChildren>
- Defined in type.ts:107

Properties

`Readonly` `Internal`[kDataTypeSymbol]

"[kDataTypeSymbol]": true

[toStringTag]

"[toStringTag]": string

`Readonly`ArrayType

ArrayType: any

`Readonly`children

children: Field<TChildren[keyof TChildren]>[]

`Readonly`OffsetArrayType

OffsetArrayType: ArrayCtor<Int32Array | BigInt64Array>

`Readonly`TArray

TArray: any

TChildren

TChildren: TChildren

`Readonly`TOffsetArray

TOffsetArray: any

TType

TType: TType

`Readonly`TValue

TValue: any

`Readonly`typeId

typeId: TType

Methods

`Static`isBinary

isBinary(x: any): x is Binary
Parameters
- x: any
Returns x is Binary
Nocollapse
- Defined in type.ts:79

`Static`isBinaryView

isBinaryView(x: any): x is BinaryView
Parameters
- x: any
Returns x is BinaryView
Nocollapse
- Defined in type.ts:80

`Static`isBool

isBool(x: any): x is Bool
Parameters
- x: any
Returns x is Bool
Nocollapse
- Defined in type.ts:85

`Static`isDataType

isDataType(x: any): x is DataType<Type, any>
Check if an object is an instance of DataType. This works across different instances of the Arrow library.

Note: We intentionally do NOT implement Symbol.hasInstance here because it would break instanceof checks for subclasses like Struct, Dictionary, etc. Use DataType.isDataType() for cross-library type checking instead.
Parameters
- x: any
Returns x is DataType<Type, any>
Nocollapse
- Defined in type.ts:67

`Static`isDate

isDate(x: any): x is Date_<Dates>
Parameters
- x: any
Returns x is Date_<Dates>
Nocollapse
- Defined in type.ts:87

`Static`isDecimal

isDecimal(x: any): x is Decimal
Parameters
- x: any
Returns x is Decimal
Nocollapse
- Defined in type.ts:86

`Static`isDenseUnion

isDenseUnion(x: any): x is DenseUnion
Parameters
- x: any
Returns x is DenseUnion
Nocollapse
- Defined in type.ts:102

`Static`isDictionary

isDictionary(x: any): x is Dictionary<any, TKeys>
Parameters
- x: any
Returns x is Dictionary<any, TKeys>
Nocollapse
- Defined in type.ts:100

`Static`isDuration

isDuration(x: any): x is Duration<Durations>
Parameters
- x: any
Returns x is Duration<Durations>
Nocollapse
- Defined in type.ts:91

`Static`isFixedSizeBinary

isFixedSizeBinary(x: any): x is FixedSizeBinary
Parameters
- x: any
Returns x is FixedSizeBinary
Nocollapse
- Defined in type.ts:97

`Static`isFixedSizeList

isFixedSizeList(x: any): x is FixedSizeList<any>
Parameters
- x: any
Returns x is FixedSizeList<any>
Nocollapse
- Defined in type.ts:98

`Static`isFloat

isFloat(x: any): x is Float<Floats>
Parameters
- x: any
Returns x is Float<Floats>
Nocollapse
- Defined in type.ts:78

`Static`isInt

isInt(x: any): x is Int_<Ints>
Parameters
- x: any
Returns x is Int_<Ints>
Nocollapse
- Defined in type.ts:77

`Static`isInterval

isInterval(x: any): x is Interval_<Intervals>
Parameters
- x: any
Returns x is Interval_<Intervals>
Nocollapse
- Defined in type.ts:90

`Static`isLargeBinary

isLargeBinary(x: any): x is LargeBinary
Parameters
- x: any
Returns x is LargeBinary
Nocollapse
- Defined in type.ts:81

`Static`isLargeUtf8

isLargeUtf8(x: any): x is LargeUtf8
Parameters
- x: any
Returns x is LargeUtf8
Nocollapse
- Defined in type.ts:84

`Static`isList

isList(x: any): x is List<any>
Parameters
- x: any
Returns x is List<any>
Nocollapse
- Defined in type.ts:92

`Static`isMap

isMap(x: any): x is Map_<any, any>
Parameters
- x: any
Returns x is Map_<any, any>
Nocollapse
- Defined in type.ts:99

`Static`isNull

isNull(x: any): x is Null
Parameters
- x: any
Returns x is Null
Nocollapse
- Defined in type.ts:76

`Static`isSparseUnion

isSparseUnion(x: any): x is SparseUnion
Parameters
- x: any
Returns x is SparseUnion
Nocollapse
- Defined in type.ts:103

`Static`isStruct

isStruct(x: any): x is Struct<any>
Parameters
- x: any
Returns x is Struct<any>
Nocollapse
- Defined in type.ts:95

`Static`isTime

isTime(x: any): x is Time_<Times>
Parameters
- x: any
Returns x is Time_<Times>
Nocollapse
- Defined in type.ts:88

`Static`isTimestamp

isTimestamp(x: any): x is Timestamp_<Timestamps>
Parameters
- x: any
Returns x is Timestamp_<Timestamps>
Nocollapse
- Defined in type.ts:89

`Static`isUnion

isUnion(x: any): x is Union_<Unions>
Parameters
- x: any
Returns x is Union_<Unions>
Nocollapse
- Defined in type.ts:96

`Static`isUtf8

isUtf8(x: any): x is Utf8
Parameters
- x: any
Returns x is Utf8
Nocollapse
- Defined in type.ts:82

`Static`isUtf8View

isUtf8View(x: any): x is Utf8View
Parameters
- x: any
Returns x is Utf8View
Nocollapse
- Defined in type.ts:83