A Node.js Tile38 client written in TypeScript. 

A Node.js Tile38 client written in TypeScript

tiermobility

@tiermobility/tile38-ts

Error

Ignore

Warn

License

Maintenance

Miscellaneous

Quality

Supply chain risk

Vulnerability

Admins only

Organization members

Dashboard

<upgradeLink>Upgrade</upgradeLink> to access this feature

About

Blog

Socket CLI

Customers

Socket Dependency Search

Docs

Socket for GitHub

Love

Impersonation Mode Active

Update your browser to the latest version for the best experience.

Your web browser is outdated

Use another browser for the best experience.

Your web browser is unsupported

{{count, number}} commits last two months

{{count, number}} critical severity alert

{{count, number}} critical severity alerts

{{count, number}} dependency vulnerability

{{count, number}} dependency vulnerabilities

{{count, number}} development dependencies

{{count, number}} transitive dependencies

{{count, number}} version published last month

{{count, number}} versions published last month

{{count, number}} version published in last two months

{{count, number}} versions published in last two months

{{count, number}} version published last week

{{count, number}} versions published last week

{{count, number}} version published last year

{{count, number}} versions published last year

Socket undergoes annual SOC2 Type II audits. Socket customers can request a copy of the full SOC2 Type II report.

Allows organization owners and admins to access detailed records of actions taken by members of their organization, complete with timestamps.

Prevent compromised packages from infiltrating your supply chain by monitoring for changes in real-time.

Join our Discord community to get help from Socket engineers and other Socket users.

Compare millions of open source packages on socket.dev

Detect malicious code and risky behavior (e.g. network) in your dependencies using "deep package inspection"

All data is encrypted in transit and at rest using industry standard encryption algorithms.

Get a dedicated Socket account manager and access to Socket’s Customer Success team.

Get dedicated support from Socket engineers via email and Slack.

"Shift left" with the Socket Chrome extension and give intervene early, before developers choose risky or low quality dependencies.

Catch developers using risky dependencies and give them a "speed bump" to encourage good behavior

Install the Socket GitHub app to receive real-time dependency scanning and reports with every pull request.

Integrate Socket into your GitHub SCM to prevent risky dependencies from being installed.

Socket scans for vulnerabilities in your dependencies, including CVEs, security advisories, and more.

Socket supports dependencies in many languages, with most popular ecosystems coming in 2024. We've got you covered no matter what languages you use.

Enforce license policies across your organization

Receive a Microsoft Teams message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Get help migrating from Socket's free plan to Socket's paid plans.

Run Socket on-premises or in your own cloud environment.

Query for any dependency (at any version) across your entire organization

Integrate Socket into your CI/CD pipeline to prevent risky dependencies from being deployed to production.

Analyze an entire project to find supply chain risks

Tag projects to organize and filter your projects

Restrict access based on the roles of individual users within an organization.

Receive a Slack message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket is SOC2 Type II compliant and undergoes annual audits.

The Socket CLI allows teams to prevent risky dependencies from being installed, and to get dependency insights from the command line.

Socket supports SAML SSO for single sign-on and identity management.

Integrate Socket into your VS Code IDE to prevent risky dependencies from being installed.

Get a POST request anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket will analyzed your SBOMs up to a maximum number of dependencies.

API that allows you to analyze a project, lookup package scores and alerts, and more.

Create API tokens to authenticate with the Socket API and CLI.

The number of developers in your team. A developer is someone who made a commit to your organization's repositories scanned by Socket in the past month.

Use Socket to protect your private repositories.

Socket is always free for open source projects.

Socket retains all reporting data for 3 months, 1 year, or a custom term of your choice.

Access the threat feed that powers Socket.

Unlimited scale, self-hosting, and priority support for large teams.

For open-source projects, individuals, and small teams.

For growing teams with enhanced scale, security, and support.

There is a package with a similar name that is downloaded much more often.

There are packages with similar names that are downloaded much more often.

This may not be the package you want!

Instance

Alert Locations

Package

The {{ecosystem}} package {{- packageName}} receives a total of <strong>{{numWeeklyDownloadCount, number}}</strong> weekly downloads. As such, {{- packageName}} popularity was classified as <strong>{{popularity}}</strong>.

Is {{- packageName}} popular?

Is {{- packageName}} safe to use?

Is {{- packageName}} well maintained?

What is {{- packageName}}?

{{packageDescription}}Version: {{versionString}} was published by {{publisherName}}. Start using Socket to analyze {{- packageName}} and its {{dependencyCount, number}} dependencies to secure your app from supply chain attacks.

Sorry, it seems this package was removed from the registry

Package was removed

This package version has been unpublished, mostly likely due to security reasons

Package version was removed

Provide a detailed description of the malware...

Socket fights vulnerabilities and provides visibility, defense-in-depth, and proactive supply chain protection for JavaScript, Python, and Go dependencies.

Socket - Secure your dependencies. Ship with confidence.

Compare versions

{{- packageName}} - npm Package Compare versions

  "description": "A Node.js Tile38 client written in TypeScript",

    "url": "https://github.com/TierMobility/tile38-ts.git"

  "author": "V. Priem <vinzent.priem@gmail.com>",

    "_postinstall": "yarn husky install",

    "prepublishOnly": "pinst --disable && yarn run build",

    "clean": "rimraf {dist,tsconfig.tsbuildinfo,yarn-error.log,coverage}",

    "format": "prettier --write src/{*.ts,**/*.ts}",

    "u": "yarn upgrade-interactive --latest",

    "coverage": "FILE=./coverage/lcov-report/index.html; test -f $FILE && open $FILE || echo 'no coverage yet, run yarn test'"

    "@commitlint/config-conventional": "17.4.2",

    "@semantic-release/changelog": "6.0.2",

    "@semantic-release/release-notes-generator": "10.0.3",

    "@typescript-eslint/eslint-plugin": "5.51.0",

    "@typescript-eslint/parser": "5.56.0",

    "conventional-changelog-conventionalcommits": "5.0.0",

    "eslint-config-airbnb-base": "15.0.0",

    "eslint-import-resolver-typescript": "3.5.3",

<a  href="https://tier.engineering">tier.engineering</a> · <a  href="https://github.com/TierMobility/tile38-ts/issues">Report Bug</a>

· <a  href="https://github.com/TierMobility/tile38-ts/issues">Request Feature</a>

<a  href="#about-the-project">About The Project</a>

<li><a  href="#built-with">Built With</a></li>

<a  href="#getting-started">Getting Started</a>

<li><a  href="#requirements">Requirements</a></li>

<li><a  href="#installation">Installation</a></li>

<li><a  href="#commands">Commands</a></li>

<li><a  href="#geofencing">Geofencing</a></li>

<li><a  href="#server">Server / Connection</a></li>

<li><a  href="#contributing">Contributing</a></li>

<li><a  href="#contact">Maintainer</a></li>

<li><a  href="#acknowledgements">Acknowledgements</a></li>

This is a Typescript client for Tile38 that allows for a type-safe interaction with the worlds fastest in-memory geodatabase [Tile38](https://www.tile38.com).

-   optional build-in leader/follower logic

-   no external dependencies other than redis

-   [ioredis](https://www.npmjs.com/package/ioredis)

import { Tile38 } from '@tiermobility/tile38-ts';

const tile38 = new Tile38({ url: 'leader:9851' });

const tile38 = new Tile38('leader:9851');

When it comes to replication, Tile38 follows a leader-follower model. The leader receives all commands that `SET` data, a follower on the other hand is `read-only` and can only query data. For more on replication in Tile38 refer to the [official documentation](https://tile38.com/topics/replication).

This client is not meant to setup a replication, because this should happen in your infrastructure. But it helps you to specifically execute commands on leader or follower. This way you can make sure that the leader always has enough resources to execute `SET`s and fire `geofence` events on `webhooks`.

For now we allow for one follower `URI` to bet set alongside the leader `URI`.

const tile38 = new Tile38({ url: 'leader:9851', followerUrl: 'follower:9851' });

const tile38 = new Tile38('leader:9851', 'follower:9851');

Once the client is instantiated with a follower, commands can be explicitly send

to the follower, but adding `.follower()` to your command chaining.

await tile38.follower().get('fleet', 'truck1').asObjects();

We expose `ioredis` [RedisOptions](https://redis.github.io/ioredis/index.html#RedisOptions).

            return Math.min(times * 50, 2000);

Tile38 has hidden limits set for the amount of objects that can be returned in one request. For most queries/searches this limit is set to `100`. This client gives you the option to either paginate the results yourself by add `.cursor()` and `.limit()` to your queries, or it abstracts pagination away from the user by adding `.all()`.

Let's say your `fleet` in `Berlin` extends 100 vehicles, then

await tile38.within('fleet').get('cities', 'Berlin').asObjects();

will only return 100 vehicle objects. Now you can either get the rest by setting the limit to the amount of vehicles you have in the city and get them all.

await tile38.within('fleet').limit(10000).get('cities', 'Berlin').asObjects();

Or, you can paginate the results in multiple concurrent requests to fit your requirements.

Or, you use `.all()` to get all objects with a concurrency of 1 and a limit of 100:

Set the value of an id. If a value is already associated to that key/id, it'll be overwritten.

    .fields({ maxSpeed: 90, milage: 90000 })

await tile38.set('fleet', 'truck1:driver').string('John Denton').exec();

| `.fields()` | Optional additional fields. **MUST BE** numerical|

| `.ex(value)` | Set the specified expire time, in seconds.|

| `.nx()` | Only set the object if it does not already exist.|

| `.xx()` | Only set the object if it already exist.|

| `.point(lat, lon)` | Set a simple point in latitude, longitude |

| `.bounds(minlat, minlon, maxlat, maxlon)` | Set as minimum bounding rectangle |

| `.string(value)` | Set as string. To retrieve string values you can use `.get()`, `scan()` or `.search()` |

Set the value for one or more fields of an object. Fields must be double precision floating points. Returns the integer count of how many fields changed their values.

await tile38.fSet('fleet', 'truck1', { maxSpeed: 90, milage: 90000 });

| `.xx()` | `FSET` returns error if fields are set on non-existing ids. `xx()` options changes this behaviour and instead returns `0` if id does not exist. If key does not exist `FSET` still returns error |

		{
		"name": "@tiermobility/tile38-ts",
		"version": "2.0.0-beta.3",
		"version": "2.0.0-beta.4",
		"description": "A Node.js Tile38 client written in TypeScript",
		@@ -5,0 +5,0 @@ "main": "dist/index.js",

		@@ -79,3 +79,4 @@ <br />
		import { Tile38 } from '@tiermobility/tile38-ts';
		const tile38 = new Tile38({ url: 'leader:9851' });

		const tile38 = new Tile38('leader:9851');
		```
		@@ -92,4 +93,3 @@
		```typescript
		import { Tile38 } from '@tiermobility/tile38-ts';
		const tile38 = new Tile38({ url: 'leader:9851', followerUrl: 'follower:9851' });
		const tile38 = new Tile38('leader:9851', 'follower:9851');
		```
		@@ -109,8 +109,7 @@
		```typescript
		import { Tile38 } from '@tiermobility/tile38-ts';
		const tile38 = new Tile38({
		url: 'leader:9851',
		followerUrl: 'follower:9851',
		new Tile38(
		'leader:9851',
		'follower:9851',
		// e.g. to set a retry strategy
		redisOptions: {
		{
		retryStrategy: (times) => {
		@@ -120,3 +119,3 @@ return Math.min(times * 50, 2000);
		},
		});
		);
		```
		@@ -123,0 +122,0 @@

Worsened metrics