v2.4.0 (#69)

* docs: Update useBigIntTimestamp docs.

* chore: Bump minor version, dev deps.

* chore: Update lockfile.

Author: jheer

README.md

@@ -117,7 +117,7 @@ const table = tableFromIPC(ipc, {
   useDate: true,            // map dates and timestamps to Date objects
   useDecimalInt: true,      // use BigInt for decimals, do not coerce to number
   useBigInt: true,          // use BigInt for 64-bit ints, do not coerce to number
-  useBigIntTimestamp: true, // use BigInt for timestamps, do not coerce to float
+  useBigIntTimestamp: true, // use BigInt for timestamps, do not coerce to millisecond number
   useMap: true,             // create Map objects for [key, value] pair lists
   useProxy: true            // use zero-copy proxies for struct and table row objects
 });

docs/api/data-types.md

@@ -21,7 +21,7 @@ The table below provides an overview of all data types supported by the Apache A
 |   7 | [Decimal](#decimal)                 | ✅ | ✅ | ✅ | `number`, or scaled integers via the `useDecimalInt` flag |
 |   8 | [Date](#date)                       | ✅ | ✅ | ✅ | `number`, or `Date` via the `useDate` flag. |
 |   9 | [Time](#time)                       | ✅ | ✅ | ✅ | `number`, or `bigint` for 64-bit values via the `useBigInt` flag |
-|  10 | [Timestamp](#timestamp)             | ✅ | ✅ | ✅ | `number`, `bigint` via `useBigIntTimestamp` flag, or `Date` via the `useDate` flag. |
+|  10 | [Timestamp](#timestamp)             | ✅ | ✅ | ✅ | `number`, `Date` via the `useDate` flag, or `bigint` via `useBigIntTimestamp` flag. |
 |  11 | [Interval](#interval)               | ✅ | ✅ | ✅ | depends on the interval unit |
 |  12 | [List](#list)                       | ✅ | ✅ | ✅ | `Array` or `TypedArray` of child type |
 |  13 | [Struct](#struct)                   | ✅ | ✅ | ✅ | `object`, properties depend on child types |

docs/api/index.md

@@ -25,8 +25,8 @@ By default Flechette assumes input data is uncompressed. If input IPC data conta
 * *data* (`ArrayBuffer` \| `Uint8Array` \| `Uint8Array[]`): The source byte buffer, or an array of buffers. If an array, each byte array may contain one or more self-contained messages. Messages may NOT span multiple byte arrays.
 * *options* (`ExtractionOptions`): Options for controlling how values are transformed when extracted from an Arrow binary representation.
   * *useBigInt* (`boolean`): If true, extract 64-bit integers as JavaScript `BigInt` values. Otherwise, coerce long integers to JavaScript number values (default `false`), raising an error if the integer can not be represented as a double precision floating point number.
-  * *useBigIntTimestamp* (`boolean`): If true, extract timestamps as JavaScript `BigInt` values. Otherwise, coerce timestamps to float milliseconds.
-  * *useDate* (`boolean`): If true, extract dates and timestamps as JavaScript `Date` objects. Otherwise, return numerical timestamp values (default `false`).
+  * *useBigIntTimestamp* (`boolean`): If true, extract timestamps as JavaScript `BigInt` values. Otherwise, coerce timestamps to millisecond numbers. This option takes precedence over the *useDate* option.
+  * *useDate* (`boolean`): If true, extract dates and timestamps as JavaScript `Date` objects. Otherwise, return numerical timestamp values (default `false`). If *useBigIntTimestamp* is true, this option does not apply to timestamps.
   * *useDecimalInt* (`boolean`): If true, extract decimal-type data as scaled integer values, where fractional digits are scaled to integer positions. Returned integers are `BigInt` values for decimal bit widths of 64 bits or higher and 32-bit integers (as JavaScript `number`) otherwise. If false, decimals are lossily converted to floating-point numbers (default).
   * *useMap* (`boolean`): If true, extract Arrow 'Map' values as JavaScript `Map` instances. Otherwise, return an array of [key, value] pairs compatible with both `Map` and `Object.fromEntries` (default `false`).
   * *useProxy* (`boolean`): If true, extract Arrow 'Struct' values and table row objects using zero-copy proxy objects that extract data from underlying Arrow batches. The proxy objects can improve performance and reduce memory usage, but do not support property enumeration (`Object.keys`, `Object.values`, `Object.entries`) or spreading (`{ ...object }`). Otherwise (default `false`), use standard JS objects for structs and table rows.

docs/index.md

@@ -117,7 +117,7 @@ const table = tableFromIPC(ipc, {
   useDate: true,            // map dates and timestamps to Date objects
   useDecimalInt: true,      // use scaled ints for decimals, not floating point
   useBigInt: true,          // use BigInt for 64-bit ints, do not coerce to number
-  useBigIntTimestamp: true, // use BigInt for timestamps, do not coerce to float
+  useBigIntTimestamp: true, // use BigInt for timestamps, do not coerce to millisecond number
   useMap: true,             // create Map objects for [key, value] pair lists
   useProxy: true            // use zero-copy proxies for struct and table row objects
 });