fast-osmpbf-js 0.1.4 → 0.2.1

package/README.md

@@ -5,17 +5,25 @@ It is using NodeJS bindings for the high-performance Rust library [fast-osmpbf](
 
 [![npm](https://img.shields.io/npm/v/fast-osmpbf-js.svg)](https://www.npmjs.com/package/fast-osmpbf-js)
 
-## Installation
+## Benchmarks
 
-```bash
-npm install fast-osmpbf-js
+- CPU: Intel(R) Core(TM) i5-9600K CPU @ 3.70GHz
+- Memory: 16GB
+- OS: Linux (Ubuntu)
+- Dataset: `germany-latest.osm.pbf` (~4.6GB)
+
+```
+Hyperfine was used to benchmark with 10 runs each.
+What you see here is the mean time of these 10 runs.
+All problems were run using parallelization if the library offered a way to do it.
 ```
 
-or add this to your `package.json`:
 
-```json
-"fast-osmpbf-js": "0.1"
-```
+| Problem         | fast-osmpbf-js | osm-pbf-parser | osm-read |
+|-----------------|----------------|----------------|----------|
+| Count ways      | 18.10 s        | 330.57 s       | 523.80 s |
+| Count addresses | 30.04 s        | 359.06 s       | 603.33 s |
+
 
 ## Examples
 
@@ -100,26 +108,6 @@ export interface JsElementBlock {
 ```
 
 
-## Benchmarks
-
-- CPU: Intel(R) Core(TM) i5-9600K CPU @ 3.70GHz
-- Memory: 16GB
-- OS: Linux (Ubuntu)
-- Dataset: `germany-latest.osm.pbf` (~4.6GB)
-
-```
-Hyperfine was used to benchmark with 10 runs each.
-What you see here is the mean time of these 10 runs.
-All problems were run using parallelization if the library offered a way to do it.
-```
-
-
-| Problem         | fast-osmpbf-js | osm-pbf-parser | osm-read |
-|-----------------|----------------|----------------|----------|
-| Count ways      | 18.10 s        | 330.57 s       | 523.80 s |
-| Count addresses | 30.04 s        | 359.06 s       | 603.33 s |
-
-
 ## License
 
 This project is licensed under

package/index.js

@@ -1,104 +1,104 @@
-import { createRequire } from "module"
-import { platform, arch } from "process"
-import { join, dirname } from "path"
-import { fileURLToPath } from "url"
+import { createRequire } from "module";
+import { platform, arch } from "process";
+import { join, dirname } from "path";
+import { fileURLToPath } from "url";
 
-const require = createRequire(import.meta.url)
-const __dirname = dirname(fileURLToPath(import.meta.url))
+const require = createRequire(import.meta.url);
+const __dirname = dirname(fileURLToPath(import.meta.url));
 
 // Map Node.js platform/arch to your binding folder names
 function getBindingPath() {
-    const platformMap = {
-        darwin: "apple-darwin",
-        win32: "pc-windows-msvc",
-        linux: "unknown-linux-gnu",
-    }
+  const platformMap = {
+    darwin: "apple-darwin",
+    win32: "pc-windows-msvc",
+    linux: "unknown-linux-gnu",
+  };
 
-    const archMap = {
-        x64: "x86_64",
-        arm64: "aarch64",
-    }
+  const archMap = {
+    x64: "x86_64",
+    arm64: "aarch64",
+  };
 
-    const nodeFileMap = {
-        "linux-x64": "index.linux-x64-gnu.node",
-        "linux-arm64": "index.linux-arm64-gnu.node",
-        "darwin-x64": "index.darwin-x64.node",
-        "darwin-arm64": "index.darwin-arm64.node",
-        "win32-x64": "index.win32-x64-msvc.node",
-    }
+  const nodeFileMap = {
+    "linux-x64": "index.linux-x64-gnu.node",
+    "linux-arm64": "index.linux-arm64-gnu.node",
+    "darwin-x64": "index.darwin-x64.node",
+    "darwin-arm64": "index.darwin-arm64.node",
+    "win32-x64": "index.win32-x64-msvc.node",
+  };
 
-    const mappedPlatform = platformMap[platform]
-    const mappedArch = archMap[arch]
+  const mappedPlatform = platformMap[platform];
+  const mappedArch = archMap[arch];
 
-    if (!mappedPlatform || !mappedArch) {
-        throw new Error(`Unsupported platform: ${platform}-${arch}`)
-    }
+  if (!mappedPlatform || !mappedArch) {
+    throw new Error(`Unsupported platform: ${platform}-${arch}`);
+  }
 
-    const bindingFolder = `bindings-${mappedArch}-${mappedPlatform}`
-    const nodeFile = nodeFileMap[`${platform}-${arch}`]
+  const bindingFolder = `bindings-${mappedArch}-${mappedPlatform}`;
+  const nodeFile = nodeFileMap[`${platform}-${arch}`];
 
-    if (!nodeFile) {
-        throw new Error(`No binding available for ${platform}-${arch}`)
-    }
+  if (!nodeFile) {
+    throw new Error(`No binding available for ${platform}-${arch}`);
+  }
 
-    return join(__dirname, bindingFolder, nodeFile)
+  return join(__dirname, bindingFolder, nodeFile);
 }
 
-const native = require(getBindingPath())
+const native = require(getBindingPath());
 
 export function getTags(block, index) {
-    let tags = block.denseTags || block.tags
-    const start = tags[2][index]
-    const end = tags[2][index + 1]
-    const result = []
-    for (let i = start; i < end; i++) {
-        result.push([block.stringTable[tags[0][i]], block.stringTable[tags[1][i]]])
-    }
-    return result
+  let tags = block.denseTags || block.tags;
+  const start = tags[2][index];
+  const end = tags[2][index + 1];
+  const result = [];
+  for (let i = start; i < end; i++) {
+    result.push([block.stringTable[tags[0][i]], block.stringTable[tags[1][i]]]);
+  }
+  return result;
 }
 
 export function getNodeIds(block, index) {
-    if (!block.nodeIds) {
-        return []
-    }
-    const result = []
-    const start = block.nodeIds[1][index]
-    const end = block.nodeIds[1][index + 1]
-    for (let i = start; i < end; i++) {
-        result.push(block.nodeIds[0][i])
-    }
-    return result
+  if (!block.nodeIds) {
+    return [];
+  }
+  const result = [];
+  const start = block.nodeIds[1][index];
+  const end = block.nodeIds[1][index + 1];
+  for (let i = start; i < end; i++) {
+    result.push(block.nodeIds[0][i]);
+  }
+  return result;
 }
 
 export function getRelationMembers(block, index) {
-    if (!block.relationMembers) {
-        return []
-    }
-    const result = []
-    const start = block.relationMembers[3][index]
-    const end = block.relationMembers[3][index + 1]
-    for (let i = start; i < end; i++) {
-        result.push({
-            id: block.relationMembers[0][i],
-            type: mapMemberType(block.relationMembers[1][i]),
-            role: block.stringTable[block.relationMembers[2][i]],
-        })
-    }
-    return result
+  if (!block.relationMembers) {
+    return [];
+  }
+  const result = [];
+  const start = block.relationMembers[3][index];
+  const end = block.relationMembers[3][index + 1];
+  for (let i = start; i < end; i++) {
+    result.push({
+      id: block.relationMembers[0][i],
+      type: mapMemberType(block.relationMembers[1][i]),
+      role: block.stringTable[block.relationMembers[2][i]],
+    });
+  }
+  return result;
 }
 
 function mapMemberType(memberType) {
-    switch (memberType) {
-        case 0:
-            return "Node"
-        case 1:
-            return "Way"
-        case 2:
-            return "Relation"
-    }
+  switch (memberType) {
+    case 0:
+      return "Node";
+    case 1:
+      return "Way";
+    case 2:
+      return "Relation";
+  }
 }
 
 // Re-export the NAPI exports
-export const OsmReader = native.OsmReader
-export const AsyncBlockIterator = native.AsyncBlockIterator
-export const JsElementBlock = native.JsElementBlock
+export const OsmReader = native.OsmReader;
+export const AsyncBlockIterator = native.AsyncBlockIterator;
+export const JsElementBlock = native.JsElementBlock;

package/package.json

@@ -1,30 +1,44 @@
 {
-    "name": "fast-osmpbf-js",
-    "type": "module",
-    "version": "0.1.4",
-    "description": "Node.js bindings for the fast-osmpbf Rust library",
-    "author": {
-        "name": "Daniel Steblin",
-        "email": "d.steblin.dev@gmail.com"
-    },
-    "main": "index.js",
-    "types": "wrapper.d.ts",
-    "files": [
-        "index.js",
-        "wrapper.d.ts",
-        "index.d.ts",
-        "bindings-*/*.node"
-    ],
-    "scripts": {
-        "artifacts": "napi artifacts",
-        "build": "napi build --platform --release"
-    },
-    "license": "MIT OR Apache-2.0",
-    "devDependencies": {
-        "@napi-rs/cli": "^3.4.1",
-        "@types/node": "^24.3.0"
-    },
-    "engines": {
-        "node": ">=16"
-    }
+  "name": "fast-osmpbf-js",
+  "type": "module",
+  "version": "0.2.1",
+  "description": "Node.js bindings for the fast-osmpbf Rust library",
+  "author": {
+    "name": "Daniel Steblin",
+    "email": "d.steblin.dev@gmail.com"
+  },
+  "keywords": [
+    "openstreetmap",
+    "osmpbf",
+    "osm",
+    "pbf",
+    "parser",
+    "geospatial",
+    "map",
+    "geodata"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/QuodEstDubitandum/fast-osmpbf"
+  },
+  "main": "index.js",
+  "types": "wrapper.d.ts",
+  "files": [
+    "index.js",
+    "wrapper.d.ts",
+    "index.d.ts",
+    "bindings-*/*.node"
+  ],
+  "scripts": {
+    "artifacts": "napi artifacts",
+    "build": "napi build --platform --release"
+  },
+  "license": "MIT OR Apache-2.0",
+  "devDependencies": {
+    "@napi-rs/cli": "^3.4.1",
+    "@types/node": "^24.3.0"
+  },
+  "engines": {
+    "node": ">=16"
+  }
 }