@geolith/glx 0.1.1 → 0.2.0

package/dist/index.d.ts

@@ -204,9 +204,10 @@ export declare class GlxFile {
   #private;
   private constructor();
   /**
-   * Reads the header and the boot sections (dictionary root, spatial
-   * directory, id directory) and opens the index. Call `init` (the wasm
-   * module) first.
+   * Reads the file header and the search header (the first 512 bytes),
+   * then the boot sections (dictionary root, spatial directory, id
+   * directory) and opens the index. Rejects a file without a search
+   * part, naming the parts it holds. Call `init` (the wasm module) first.
    */
   static open(source: Source, read?: ReadOptions): Promise<GlxFile>;
   /** Places in the file. */

package/dist/index.js

@@ -173,11 +173,13 @@ var Query = class Query {
 };
 if (Symbol.dispose) Query.prototype[Symbol.dispose] = Query.prototype.free;
 /**
-* `[offset, length]` of the boot bytes, from the header bytes.
+* `[offset, length]` of the boot bytes, from the [`header_length`] bytes
+* at the start of the file.
 *
 * # Errors
-* When the bytes are not a `.glx` version 1 header, or the file lacks a
-* record feature this reader needs.
+* When the file header is refused, the file holds no search part (the
+* message names the kinds it holds), or the search header is refused (the
+* part lacks a record feature this reader needs).
 * @param {Uint8Array | number[]} header
 * @returns {Float64Array}
 */
@@ -239,7 +241,8 @@ function collection(query, features, name, version) {
 	}
 }
 /**
-* Header length in bytes.
+* Bytes to fetch first, from the start of the file: the file header and
+* the search header (512).
 * @returns {number}
 */
 function headerLength() {
@@ -462,9 +465,10 @@ var GlxFile = class GlxFile {
 		this.#read = read;
 	}
 	/**
-	* Reads the header and the boot sections (dictionary root, spatial
-	* directory, id directory) and opens the index. Call `init` (the wasm
-	* module) first.
+	* Reads the file header and the search header (the first 512 bytes),
+	* then the boot sections (dictionary root, spatial directory, id
+	* directory) and opens the index. Rejects a file without a search
+	* part, naming the parts it holds. Call `init` (the wasm module) first.
 	*/
 	static async open(source, read = {}) {
 		const header = await source.getBytes(0, headerLength());

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@geolith/glx",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Reads .glx geocoding files from R2 or HTTP range requests: search, autocomplete, structured, reverse, nearby and place lookup.",
   "keywords": [
     "autocomplete",