# @mapbox/mapbox-gl-sync-move

> Sync movement around two Mapbox GL JS maps

Latest version **0.3.1** (published 2022-08-26) · ISC license · 0 weekly downloads

## Install

```sh
npm install @mapbox/mapbox-gl-sync-move
pnpm add @mapbox/mapbox-gl-sync-move
yarn add @mapbox/mapbox-gl-sync-move
bun add @mapbox/mapbox-gl-sync-move
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.3.1 |
| Published | 2022-08-26 |
| First published | 2017-01-24 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 12.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 53 |
| Author | Mapbox |
| Maintainers | mapbox-npm-01, mapbox-npm-02, mapbox-npm-07, mapbox-npm-03, mapbox-npm-04, mapbox-npm-09, mapbox-npm-05, mapbox-npm-06, mapbox-npm-08, mapbox-npm-advanced-actions, mapbox-npm-ci, mapbox-npm, mapbox-admin, mapbox-machine-user |
| Keywords | mapbox, mapboxgl |

## Links

- npm: https://www.npmjs.com/package/@mapbox/mapbox-gl-sync-move
- Repository: https://github.com/mapbox/mapbox-gl-sync-move
- Homepage: https://github.com/mapbox/mapbox-gl-sync-move#readme
- Issues: https://github.com/mapbox/mapbox-gl-sync-move/issues
- npm.io page: https://npm.io/package/@mapbox/mapbox-gl-sync-move

## Recent versions

- 0.3.1 (latest) — 2022-08-26
- 0.3.0 — 2019-06-05
- 0.2.0 — 2017-01-24

## README

# @mapbox/mapbox-gl-sync-move [![CircleCI](https://circleci.com/gh/mapbox/mapbox-gl-sync-move.svg?style=svg)](https://circleci.com/gh/mapbox/mapbox-gl-sync-move)

Sync movement between two or more [Mapbox GL JS](https://www.mapbox.com/mapbox-gl-js) maps.

## Install

```
npm install @mapbox/mapbox-gl-sync-move
```

## Usage

This module exports a function that receives as arguments two or more [Mapbox GL JS](https://www.mapbox.com/mapbox-gl-js) maps whose movements you'd like to sync.

```js
var mapboxgl = require('mapbox-gl');
var syncMaps = require('mapbox-gl-sync-move');

var mapA = new mapboxgl.Map(..);
var mapB = new mapboxgl.Map(..);

syncMaps(mapA, mapB);
```

## Developing

There are unit tests with mocked maps, and there's a page for manual testing.

Run the unit tests with `npm test`.

To manually test, ensure you have a `MapboxAccessToken` environment variable set. Then start the server with `npm run start`.

---
_Source: https://npm.io/package/@mapbox/mapbox-gl-sync-move · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._