Class DataType<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

Hierarchy

DataType

Index

Constructors

constructor

Properties

Accessors

typeId

Methods

Constructors

constructor

new DataType<TType, TChildren>(): DataType<TType, TChildren>

Type parameters
- TType: Type = Type
- TChildren: {} = any
Returns DataType<TType, TChildren>

Properties

Readonly ArrayType

ArrayType: any

Readonly TArray

TArray: any

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 type.ts:87
Returns TType

Methods

Static isBinary

isBinary(x: any): x is Binary

- Defined in type.ts:71
nocollapse

Parameters
- x: any
Returns x is Binary

Static isBool

isBool(x: any): x is Bool

- Defined in type.ts:73
nocollapse

Parameters
- x: any
Returns x is Bool

Static isDate

isDate(x: any): x is Date_<Dates>

- Defined in type.ts:75
nocollapse

Parameters
- x: any
Returns x is Date_<Dates>

Static isDecimal

isDecimal(x: any): x is Decimal

- Defined in type.ts:74
nocollapse

Parameters
- x: any
Returns x is Decimal

Static isDictionary

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

- Defined in type.ts:85
nocollapse

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

Static isFixedSizeBinary

isFixedSizeBinary(x: any): x is FixedSizeBinary

- Defined in type.ts:82
nocollapse

Parameters
- x: any
Returns x is FixedSizeBinary

Static isFixedSizeList

isFixedSizeList(x: any): x is FixedSizeList<any>

- Defined in type.ts:83
nocollapse

Parameters
- x: any
Returns x is FixedSizeList<any>

Static isFloat

isFloat(x: any): x is Float<Floats>

- Defined in type.ts:70
nocollapse

Parameters
- x: any
Returns x is Float<Floats>

Static isInt

isInt(x: any): x is Int_<Ints>

- Defined in type.ts:69
nocollapse

Parameters
- x: any
Returns x is Int_<Ints>

Static isInterval

isInterval(x: any): x is Interval_<Intervals>

- Defined in type.ts:78
nocollapse

Parameters
- x: any
Returns x is Interval_<Intervals>

Static isList

isList(x: any): x is List<any>

- Defined in type.ts:79
nocollapse

Parameters
- x: any
Returns x is List<any>

Static isMap

isMap(x: any): x is Map_<any, any>

- Defined in type.ts:84
nocollapse

Parameters
- x: any
Returns x is Map_<any, any>

Static isNull

isNull(x: any): x is Null

- Defined in type.ts:68
nocollapse

Parameters
- x: any
Returns x is Null

Static isStruct

isStruct(x: any): x is Struct<any>

- Defined in type.ts:80
nocollapse

Parameters
- x: any
Returns x is Struct<any>

Static isTime

isTime(x: any): x is Time_<Times>

- Defined in type.ts:76
nocollapse

Parameters
- x: any
Returns x is Time_<Times>

Static isTimestamp

isTimestamp(x: any): x is Timestamp_<Timestamps>

- Defined in type.ts:77
nocollapse

Parameters
- x: any
Returns x is Timestamp_<Timestamps>

Static isUnion

isUnion(x: any): x is Union_<Unions>

- Defined in type.ts:81
nocollapse

Parameters
- x: any
Returns x is Union_<Unions>

Static isUtf8

isUtf8(x: any): x is Utf8

- Defined in type.ts:72
nocollapse

Parameters
- x: any
Returns x is Utf8

Generated using TypeDoc