@versatiles/container 1.0.1 → 1.0.2

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" resolution-mode="require"/>
-import type { Block, Header, Options, Reader, TileIndex } from './interfaces.js';
-export type { Compression, Format, Header, Options, Reader } from './interfaces.js';
+import type { Block, Header, OpenOptions, Reader, TileIndex } from './interfaces.js';
+export type { Compression, Format, Header, OpenOptions, Reader } from './interfaces.js';
 /**
  * The `VersaTiles` class is a wrapper around a `.versatiles` container file. It provides methods
  * to access tile data, metadata, and other properties within the container.
@@ -15,7 +15,7 @@ export declare class VersaTiles {
      * @param options - Optional settings that configure tile handling.
      * @throws Will throw an error if the provided source is neither a string nor a Reader function.
      */
-    constructor(source: Reader | string, options?: Options);
+    constructor(source: Reader | string, options?: OpenOptions);
     /**
      * Asynchronously retrieves the header information from the `.versatiles` container.
      *
@@ -28,9 +28,9 @@ export declare class VersaTiles {
      * Metadata typically includes information about `vector_layers` for vector tiles.
      * If the container does not include metadata, this method returns `null`.
      *
-     * @returns A promise that resolves with an object representing the metadata, or null if no metadata is present.
+     * @returns A promise that resolves with an object representing the metadata.
      */
-    getMetadata(): Promise<object | null>;
+    getMetadata(): Promise<unknown>;
     /**
      * Asynchronously retrieves a specific tile's data as a Buffer. If the tile data is compressed as
      * defined in the container header, the returned Buffer will contain the compressed data.

package/dist/index.js

@@ -108,7 +108,7 @@ export class VersaTiles {
      * Metadata typically includes information about `vector_layers` for vector tiles.
      * If the container does not include metadata, this method returns `null`.
      *
-     * @returns A promise that resolves with an object representing the metadata, or null if no metadata is present.
+     * @returns A promise that resolves with an object representing the metadata.
      */
     async getMetadata() {
         if (this.#metadata !== undefined)

package/dist/interfaces.d.ts

@@ -102,6 +102,6 @@ export interface TileIndex {
  * Interface for defining the options available for reading a container.
  * @property {boolean} tms - If set to true, uses the [TMS (Tile Map Service) tile ordering](https://wiki.openstreetmap.org/wiki/TMS) where y=0 is the southernmost point.
  */
-export interface Options {
+export interface OpenOptions {
     tms: boolean;
 }

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@versatiles/container",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "A client library for reading VersaTiles containers",
   "scripts": {
     "build": "rm -rf dist && tsc -p tsconfig.build.json",
-    "check": "cd ..; npm run check",
+    "check": "npm run lint && npm run test && npm run build",
     "doc": "npx vrt ts2md src/index.ts tsconfig.build.json | npx vrt insertmd README.md '# API' true",
-    "lint": "cd ..; npm run lint",
+    "lint": "eslint . --color",
     "prepublish": "npm run build && npm run doc",
-    "test": "cd ..; npm run test"
+    "test": "cd ..; NODE_OPTIONS=--experimental-vm-modules jest --testPathPattern versatiles-container"
   },
   "files": [
     "dist/**/*.js",