summaryrefslogtreecommitdiff
path: root/platform
diff options
context:
space:
mode:
authorDane Springmeyer <dane@mapbox.com>2019-10-02 17:29:03 -0700
committerDane Springmeyer <dane@mapbox.com>2019-10-02 17:29:03 -0700
commit702d089e726e372040c06b4f56bc75de768e6501 (patch)
treecf8b6624fe8ba11966cebf04d89343fe9bf39c18 /platform
parentdaf8e1289c3c8b437c97e1ec4250b521fa6edc52 (diff)
downloadqtlocation-mapboxgl-702d089e726e372040c06b4f56bc75de768e6501.tar.gz
node package improvements
Diffstat (limited to 'platform')
-rw-r--r--platform/node/DEVELOPING.md20
-rw-r--r--platform/node/README.md6
2 files changed, 16 insertions, 10 deletions
diff --git a/platform/node/DEVELOPING.md b/platform/node/DEVELOPING.md
index 3d07253ee3..f7067235f4 100644
--- a/platform/node/DEVELOPING.md
+++ b/platform/node/DEVELOPING.md
@@ -8,25 +8,31 @@ To develop these bindings, you’ll need to build them from source. Building req
the [macOS](../macos/INSTALL.md#requirements) or [Linux](../linux/README.md#prerequisites) install documentation, depending
on the target platform.
-To compile the Node.js bindings and install module dependencies, from the repository root directory, run:
+To compile the Node.js bindings and install module dependencies, from the repository root directory, first run:
- npm install --build-from-source
+```
+make distclean
+```
+
+If you are rebuilding after time has passed.
-To recompile just the C++ code while developing, run `make node`.
+Then do:
-To create an Xcode project and use a GUI debugger in the case of a crash, run `make xnode`.
+```bash
+make node
+```
## Testing
To test the Node.js bindings:
-```
-npm test
+```bash
+make test-node
```
To run the visual render test suite:
-```
+```bash
npm run test-suite
```
diff --git a/platform/node/README.md b/platform/node/README.md
index 7273c0813a..859172108b 100644
--- a/platform/node/README.md
+++ b/platform/node/README.md
@@ -9,7 +9,7 @@ Requires a modern C++ runtime that supports C++14.
By default, installs binaries. On these platforms no additional dependencies are needed.
- 64 bit macOS or 64 bit Linux
-- Node.js v4.x _(note: v5+ is known to have issues)_
+- Node.js v10.x
Run:
@@ -168,9 +168,9 @@ var map = new mbgl.Map({
if (res.headers.modified) { response.modified = new Date(res.headers.modified); }
if (res.headers.expires) { response.expires = new Date(res.headers.expires); }
if (res.headers.etag) { response.etag = res.headers.etag; }
-
+
response.data = body;
-
+
callback(null, response);
} else {
callback(new Error(JSON.parse(body).message));