From e738643745f8cbb709d20fa68155c995215f48d5 Mon Sep 17 00:00:00 2001
From: Sylvain Lesage <severo@rednegra.net>
Date: Fri, 22 Nov 2024 21:19:34 +0100
Subject: [PATCH] Publish 1.6.1 - fix type of utils and update the doc (#44)

* Publish 1.6.1 - fix types

* update the doc
---
 README.md          | 11 ++++++++++-
 package.json       |  2 +-
 src/hyparquet.d.ts |  6 ++++--
 3 files changed, 15 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 4d09d87..75ad046 100644
--- a/README.md
+++ b/README.md
@@ -73,7 +73,16 @@ Hyparquet supports asynchronous fetching of parquet files over a network.
 const { asyncBufferFromUrl, parquetRead } = await import('https://cdn.jsdelivr.net/npm/hyparquet/src/hyparquet.min.js')
 const url = 'https://hyperparam-public.s3.amazonaws.com/bunnies.parquet'
 await parquetRead({
-  file: await asyncBufferFromUrl(url),
+  file: await asyncBufferFromUrl({url}),
+  onComplete: data => console.log(data)
+})
+```
+
+Pass the `requestInit` option to authenticate, for example:
+
+```js
+await parquetRead({
+  file: await asyncBufferFromUrl({url, requestInit: {headers: {Authorization: 'Bearer my_token'}}}),
   onComplete: data => console.log(data)
 })
 ```
diff --git a/package.json b/package.json
index 09b2c9e..c2e41c0 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "hyparquet",
-  "version": "1.6.0",
+  "version": "1.6.1",
   "description": "parquet file parser for javascript",
   "keywords": [
     "parquet",
diff --git a/src/hyparquet.d.ts b/src/hyparquet.d.ts
index c6ec81a..0d19954 100644
--- a/src/hyparquet.d.ts
+++ b/src/hyparquet.d.ts
@@ -117,8 +117,9 @@ export function toJson(obj: any): any
 /**
  * Construct an AsyncBuffer for a URL.
  * If byteLength is not provided, will make a HEAD request to get the file size.
+ * If requestInit is provided, it will be passed to fetch.
  */
-export function asyncBufferFromUrl(url: string, byteLength?: number): Promise<AsyncBuffer>
+export function asyncBufferFromUrl({url, byteLength, requestInit}: {url: string, byteLength?: number, requestInit?: RequestInit}): Promise<AsyncBuffer>
 
 /**
  * Construct an AsyncBuffer for a local file using node fs package.
@@ -127,8 +128,9 @@ export function asyncBufferFromFile(filename: string): Promise<AsyncBuffer>
 
 /**
  * Get the byte length of a URL using a HEAD request.
+ * If requestInit is provided, it will be passed to fetch.
  */
-export function byteLengthFromUrl(url: string): Promise<number>
+export function byteLengthFromUrl(url: string, requestInit?: RequestInit): Promise<number>
 
 /**
  * Returns a cached layer on top of an AsyncBuffer.