Registry / data / node-trilateration

node-trilateration

library1.0.0jsnpmunverified

node-trilateration is a JavaScript module designed to solve the 2D trilateration problem, enabling the calculation of a device's position based on its distances to three known beacon locations. Operating at version 1.0.0, this package provides a straightforward implementation of the geometric principles, where three circles (representing beacons with their distances as radii) are used to determine a unique intersection point. The library's core function takes an array of three beacon objects, each with `x`, `y` coordinates and a `distance`, and returns the calculated `x`, `y` position of the device. It focuses on this specific mathematical task without extensive abstractions, making it a concise solution for applications requiring basic 2D positioning from distance measurements. There is no stated release cadence, suggesting a stable, single-purpose utility.

data

npm install node-trilateration

github ↗package ↗

INSTALL

IMPORT

SIG · NODE-TRILATERATION

node-trilateration

datajavascriptv1.0.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

trilateration

✓ const trilateration = require('node-trilateration');

✗ import trilateration from 'node-trilateration';

This package is primarily a CommonJS module. While bundlers might allow ES Module syntax, the native Node.js experience is via `require`.

calculate

✓ const { calculate } = require('node-trilateration');

✗ import { calculate } from 'node-trilateration';

The `calculate` function is the primary API, directly exposed by the module's default export.

trilateration.calculate

✓ const trilateration = require('node-trilateration'); const pos = trilateration.calculate(beacons);

✗ const pos = calculate(beacons);

The `calculate` function is a method on the `trilateration` object (the module's export), not a direct named export.

This example demonstrates how to install `node-trilateration`, define three beacon locations with their respective distances, and use the `calculate` function to determine and log the device's estimated (x, y) coordinates. It showcases the core functionality for 2D positioning.

Debug

Known issues

gotchaThe `node-trilateration` package is designed exclusively for 2D trilateration. It does not support 3D positioning calculations and will not work correctly for scenarios requiring Z-axis coordinates.

fix

Ensure your problem space is strictly two-dimensional or use a different library designed for 3D trilateration/multilateration.

affects: >=1.0.0

gotchaThe `calculate` function strictly requires an array containing exactly three beacon objects. Providing fewer or more than three beacons will lead to incorrect results or runtime errors, as the underlying mathematical model relies on three distinct reference points.

fix

Always pass an array with precisely three beacon objects, each containing valid `x`, `y`, and `distance` numeric properties.

affects: >=1.0.0

gotchaThe library assumes valid geometric input. Edge cases such as colinear beacons, distances that make a solution impossible (e.g., circles not intersecting), or highly ambiguous geometries might result in inaccurate or unexpected position calculations without explicit error handling or warnings from the library.

fix

Implement robust input validation for beacon positions and distances in your application code. Consider preprocessing beacon data or adding custom checks for geometric validity if precise error handling is critical.

affects: >=1.0.0

gotchaInput validation within the library for non-numeric or malformed `x`, `y`, or `distance` properties on beacon objects is minimal. Providing invalid data types could lead to `TypeError` exceptions during arithmetic operations.

fix

Ensure that all `x`, `y`, and `distance` values within your beacon objects are valid numbers before passing them to the `calculate` function.

affects: >=1.0.0

Errors

Common errors & fixes

TypeError: Cannot read properties of undefined (reading 'x')

The `beacons` array passed to `trilateration.calculate` was empty, contained non-object elements, or was not an array.

fix

Ensure the input to `trilateration.calculate` is an array of exactly three objects, each having `x`, `y`, and `distance` numeric properties.

TypeError: trilateration.calculate is not a function

The module was imported incorrectly, or `calculate` was attempted to be called as a named export when it is a method on the default export.

fix

Use `const trilateration = require('node-trilateration');` then `trilateration.calculate(beacons);` for CommonJS. For ESM, try `import trilateration from 'node-trilateration';` (though compatibility might vary) and then `trilateration.calculate(beacons);`.

ReferenceError: beacons is not defined

The `beacons` array was not declared or initialized before being passed to the `calculate` function.

fix

Declare and initialize the `beacons` array with the three required beacon objects before calling `trilateration.calculate`.

Upgrade

Version history

1.0.0latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/mberberoglu/node-trilateration ↗

packagehttps://www.npmjs.com/package/node-trilateration ↗