summaryrefslogtreecommitdiff
path: root/platform/node
diff options
context:
space:
mode:
authorDane Springmeyer <springmeyer@users.noreply.github.com>2019-10-08 16:27:04 -0700
committerGitHub <noreply@github.com>2019-10-08 16:27:04 -0700
commitd0281e3ca4686ca52b1b4d886dad4e8de27bdcfa (patch)
tree0a276075abad753498278b6c41d903bcb44520c5 /platform/node
parent563f9d0534cf6540652121f468cb0526148d70b9 (diff)
downloadqtlocation-mapboxgl-d0281e3ca4686ca52b1b4d886dad4e8de27bdcfa.tar.gz
node package improvements (#15748)
* node package improvements * npm run test-suite does not do anything anymore
Diffstat (limited to 'platform/node')
-rw-r--r--platform/node/DEVELOPING.md21
-rw-r--r--platform/node/README.md6
2 files changed, 14 insertions, 13 deletions
diff --git a/platform/node/DEVELOPING.md b/platform/node/DEVELOPING.md
index 3d07253ee3..1466052155 100644
--- a/platform/node/DEVELOPING.md
+++ b/platform/node/DEVELOPING.md
@@ -8,27 +8,28 @@ 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
+```
-To recompile just the C++ code while developing, run `make node`.
+If you are rebuilding after time has passed.
-To create an Xcode project and use a GUI debugger in the case of a crash, run `make xnode`.
+Then do:
+
+```bash
+make node
+```
## Testing
To test the Node.js bindings:
-```
+```bash
npm test
```
-To run the visual render test suite:
-
-```
-npm run test-suite
-```
## Merging your pull request
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));