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

Hierarchy

DataType

Constructors

constructor

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

Properties

`Readonly` ArrayType

ArrayType: any

`Readonly` OffsetArrayType

OffsetArrayType: ArrayCtor<Int32Array | BigInt64Array>

`Readonly` TArray

TArray: any

TChildren

TChildren: TChildren

`Readonly` TOffsetArray

TOffsetArray: any

TType

TType: TType

`Readonly` TValue

TValue: any

[toStringTag]

[toStringTag]: string

`Readonly` children

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

`Readonly` typeId

typeId: TType

Methods

`Static` isBinary

isBinary(x): x is Binary
Parameters
- x: any
Returns x is Binary

Nocollapse
- Defined in type.ts:60

`Static` isBool

isBool(x): x is Bool
Parameters
- x: any
Returns x is Bool

Nocollapse
- Defined in type.ts:64

`Static` isDate

isDate(x): x is Date_<Dates>
Parameters
- x: any
Returns x is Date_<Dates>

Nocollapse
- Defined in type.ts:66

`Static` isDecimal

isDecimal(x): x is Decimal
Parameters
- x: any
Returns x is Decimal

Nocollapse
- Defined in type.ts:65

`Static` isDenseUnion

isDenseUnion(x): x is DenseUnion
Parameters
- x: any
Returns x is DenseUnion

Nocollapse
- Defined in type.ts:79

`Static` isDictionary

isDictionary(x): x is Dictionary<any, TKeys>
Parameters
- x: any
Returns x is Dictionary<any, TKeys>

Nocollapse
- Defined in type.ts:77

`Static` isDuration

isDuration(x): x is Duration<Durations>
Parameters
- x: any
Returns x is Duration<Durations>

Nocollapse
- Defined in type.ts:70

`Static` isFixedSizeBinary

isFixedSizeBinary(x): x is FixedSizeBinary
Parameters
- x: any
Returns x is FixedSizeBinary

Nocollapse
- Defined in type.ts:74

`Static` isFixedSizeList

isFixedSizeList(x): x is FixedSizeList<any>
Parameters
- x: any
Returns x is FixedSizeList<any>

Nocollapse
- Defined in type.ts:75

`Static` isFloat

isFloat(x): x is Float<Floats>
Parameters
- x: any
Returns x is Float<Floats>

Nocollapse
- Defined in type.ts:59

`Static` isInt

isInt(x): x is Int_<Ints>
Parameters
- x: any
Returns x is Int_<Ints>

Nocollapse
- Defined in type.ts:58

`Static` isInterval

isInterval(x): x is Interval_<Intervals>
Parameters
- x: any
Returns x is Interval_<Intervals>

Nocollapse
- Defined in type.ts:69

`Static` isLargeBinary

isLargeBinary(x): x is LargeBinary
Parameters
- x: any
Returns x is LargeBinary

Nocollapse
- Defined in type.ts:61

`Static` isLargeUtf8

isLargeUtf8(x): x is LargeUtf8
Parameters
- x: any
Returns x is LargeUtf8

Nocollapse
- Defined in type.ts:63

`Static` isList

isList(x): x is List<any>
Parameters
- x: any
Returns x is List<any>

Nocollapse
- Defined in type.ts:71

`Static` isMap

isMap(x): x is Map_<any, any>
Parameters
- x: any
Returns x is Map_<any, any>

Nocollapse
- Defined in type.ts:76

`Static` isNull

isNull(x): x is Null
Parameters
- x: any
Returns x is Null

Nocollapse
- Defined in type.ts:57

`Static` isSparseUnion

isSparseUnion(x): x is SparseUnion
Parameters
- x: any
Returns x is SparseUnion

Nocollapse
- Defined in type.ts:80

`Static` isStruct

isStruct(x): x is Struct<any>
Parameters
- x: any
Returns x is Struct<any>

Nocollapse
- Defined in type.ts:72

`Static` isTime

isTime(x): x is Time_<Times>
Parameters
- x: any
Returns x is Time_<Times>

Nocollapse
- Defined in type.ts:67

`Static` isTimestamp

isTimestamp(x): x is Timestamp_<Timestamps>
Parameters
- x: any
Returns x is Timestamp_<Timestamps>

Nocollapse
- Defined in type.ts:68

`Static` isUnion

isUnion(x): x is Union_<Unions>
Parameters
- x: any
Returns x is Union_<Unions>

Nocollapse
- Defined in type.ts:73

`Static` isUtf8

isUtf8(x): x is Utf8
Parameters
- x: any
Returns x is Utf8

Nocollapse
- Defined in type.ts:62

Generated using TypeDoc