Class DataType<TType, TChildren, TType, TChildren>

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

Type parameters

TType: Type = Type
TChildren: {} = any
TType: Type = Type
TChildren: {} = any

Hierarchy

DataType

Index

Properties

Accessors

typeId

Methods

Properties

Readonly ArrayType

ArrayType: any

Readonly TArray

TArray: any

Readonly TType

TType: TType

Readonly TValue

TValue: any

[Symbol.toStringTag]

[Symbol.toStringTag]: string

Readonly children

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

Accessors

typeId

get typeId(): TType

- Defined in src/type.ts:89
Returns TType

Methods

compareTo

compareTo(other: DataType): other is TypeToDataType<TType>

- Defined in src/type.ts:90
Parameters
- other: DataType
Returns other is TypeToDataType<TType>

Static isBinary

isBinary(x: any): x is Binary

- Defined in src/type.ts:73
nocollapse

Parameters
- x: any
Returns x is Binary

Static isBool

isBool(x: any): x is Bool

- Defined in src/type.ts:75
nocollapse

Parameters
- x: any
Returns x is Bool

Static isDate

isDate(x: any): x is Date_

- Defined in src/type.ts:77
nocollapse

Parameters
- x: any
Returns x is Date_

Static isDecimal

isDecimal(x: any): x is Decimal

- Defined in src/type.ts:76
nocollapse

Parameters
- x: any
Returns x is Decimal

Static isDictionary

isDictionary(x: any): x is Dictionary

- Defined in src/type.ts:87
nocollapse

Parameters
- x: any
Returns x is Dictionary

Static isFixedSizeBinary

isFixedSizeBinary(x: any): x is FixedSizeBinary

- Defined in src/type.ts:84
nocollapse

Parameters
- x: any
Returns x is FixedSizeBinary

Static isFixedSizeList

isFixedSizeList(x: any): x is FixedSizeList

- Defined in src/type.ts:85
nocollapse

Parameters
- x: any
Returns x is FixedSizeList

Static isFloat

isFloat(x: any): x is Float

- Defined in src/type.ts:72
nocollapse

Parameters
- x: any
Returns x is Float

Static isInt

isInt(x: any): x is Int_

- Defined in src/type.ts:71
nocollapse

Parameters
- x: any
Returns x is Int_

Static isInterval

isInterval(x: any): x is Interval_

- Defined in src/type.ts:80
nocollapse

Parameters
- x: any
Returns x is Interval_

Static isList

isList(x: any): x is List

- Defined in src/type.ts:81
nocollapse

Parameters
- x: any
Returns x is List

Static isMap

isMap(x: any): x is Map_

- Defined in src/type.ts:86
nocollapse

Parameters
- x: any
Returns x is Map_

Static isNull

isNull(x: any): x is Null

- Defined in src/type.ts:70
nocollapse

Parameters
- x: any
Returns x is Null

Static isStruct

isStruct(x: any): x is Struct

- Defined in src/type.ts:82
nocollapse

Parameters
- x: any
Returns x is Struct

Static isTime

isTime(x: any): x is Time_

- Defined in src/type.ts:78
nocollapse

Parameters
- x: any
Returns x is Time_

Static isTimestamp

isTimestamp(x: any): x is Timestamp_

- Defined in src/type.ts:79
nocollapse

Parameters
- x: any
Returns x is Timestamp_

Static isUnion

isUnion(x: any): x is Union_

- Defined in src/type.ts:83
nocollapse

Parameters
- x: any
Returns x is Union_

Static isUtf8

isUtf8(x: any): x is Utf8

- Defined in src/type.ts:74
nocollapse

Parameters
- x: any
Returns x is Utf8

Generated using TypeDoc