hyparquet/src/constants.js
Sylvain Lesage 09ae9400c5
build types before publishing to npm (#46)
* build types before publishing to npm

* use prepare instead of prepublishOnly + make it clear that we only build types

doc for prepare vs prepublishOnly is here: https://docs.npmjs.com/cli/v8/using-npm/scripts

* no jsx in this lib

* relative imports from the root, so that it works from types/

* remove unused hyparquet.d.ts + report differences to jsdoc in files

* try to understand if this is the cause of the failing CI check

tsc fails: https://github.com/hyparam/hyparquet/actions/runs/12040954822/job/33571851170?pr=46

* Revert "try to understand if this is the cause of the failing CI check"

This reverts commit 5e2fc8ca179064369de71793ab1cda3facefddc7.

* not sure what happens, but we just need to ensure the types are created correctly

* increment version

* Explicitly export types for use in downstream typescript projects

* Use new typescript jsdoc imports for smaller package

* Combine some files and use @import jsdoc

* use the local typescript

---------

Co-authored-by: Kenny Daniel <platypii@gmail.com>
2024-12-02 17:47:42 +01:00

102 lines
1.6 KiB
JavaScript

/** @type {import('../src/types.d.ts').ParquetType[]} */
export const ParquetType = [
'BOOLEAN',
'INT32',
'INT64',
'INT96', // deprecated
'FLOAT',
'DOUBLE',
'BYTE_ARRAY',
'FIXED_LEN_BYTE_ARRAY',
]
export const Encoding = [
'PLAIN',
undefined,
'PLAIN_DICTIONARY',
'RLE',
'BIT_PACKED', // deprecated
'DELTA_BINARY_PACKED',
'DELTA_LENGTH_BYTE_ARRAY',
'DELTA_BYTE_ARRAY',
'RLE_DICTIONARY',
'BYTE_STREAM_SPLIT',
]
export const FieldRepetitionType = [
'REQUIRED',
'OPTIONAL',
'REPEATED',
]
/** @type {import('../src/types.d.ts').ConvertedType[]} */
export const ConvertedType = [
'UTF8',
'MAP',
'MAP_KEY_VALUE',
'LIST',
'ENUM',
'DECIMAL',
'DATE',
'TIME_MILLIS',
'TIME_MICROS',
'TIMESTAMP_MILLIS',
'TIMESTAMP_MICROS',
'UINT_8',
'UINT_16',
'UINT_32',
'UINT_64',
'INT_8',
'INT_16',
'INT_32',
'INT_64',
'JSON',
'BSON',
'INTERVAL',
]
/** @type {import('../src/types.d.ts').LogicalTypeType[]} */
export const logicalTypeType = [
'NULL',
'STRING',
'MAP',
'LIST',
'ENUM',
'DECIMAL',
'DATE',
'TIME',
'TIMESTAMP',
'INTERVAL',
'INTEGER',
'NULL',
'JSON',
'BSON',
'UUID',
]
export const CompressionCodec = [
'UNCOMPRESSED',
'SNAPPY',
'GZIP',
'LZO',
'BROTLI',
'LZ4',
'ZSTD',
'LZ4_RAW',
]
/** @type {import('../src/types.d.ts').PageType[]} */
export const PageType = [
'DATA_PAGE',
'INDEX_PAGE',
'DICTIONARY_PAGE',
'DATA_PAGE_V2',
]
/** @type {import('../src/types.d.ts').BoundaryOrder[]} */
export const BoundaryOrder = [
'UNORDERED',
'ASCENDING',
'DESCENDING',
]