geoserver-node-client 1.2.3 → 1.2.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -18
- package/dist/package.json +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,35 +4,35 @@
|
|
|
4
4
|
[](https://meggsimum.github.io/geoserver-node-client)
|
|
5
5
|
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
|
|
8
8
|
|
|
9
9
|
|
|
10
10
|
|
|
11
11
|
Node.js / JavaScript Client for the [GeoServer REST API](https://docs.geoserver.org/stable/en/user/rest/).
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
## API-Docs
|
|
14
14
|
|
|
15
15
|
Detailed [API-Docs](https://meggsimum.github.io/geoserver-node-client/) are automatically created with JSDoc.
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
## Meta information
|
|
18
18
|
|
|
19
19
|
Compatible with [GeoServer](https://geoserver.org)
|
|
20
20
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
21
|
+
- v2.22.x
|
|
22
|
+
- v2.21.x
|
|
23
|
+
- v2.20.x (no more maintained and officially deprecated)
|
|
24
|
+
- v2.19.x (no more maintained and officially deprecated)
|
|
25
|
+
- v2.18.x (no more maintained and officially deprecated)
|
|
26
|
+
- v2.17.x (no more maintained and officially deprecated)
|
|
27
27
|
|
|
28
|
-
|
|
29
|
-
### Usage
|
|
28
|
+
## Usage
|
|
30
29
|
|
|
31
30
|
```shell
|
|
32
31
|
npm i geoserver-node-client
|
|
33
32
|
```
|
|
34
33
|
|
|
35
34
|
usage with require (ES5):
|
|
35
|
+
|
|
36
36
|
```js
|
|
37
37
|
var grcImport = require('geoserver-node-client');
|
|
38
38
|
var GeoServerRestClient = grcImport.GeoServerRestClient;
|
|
@@ -52,6 +52,7 @@ main();
|
|
|
52
52
|
```
|
|
53
53
|
|
|
54
54
|
usage as ES module (ES6)
|
|
55
|
+
|
|
55
56
|
```js
|
|
56
57
|
import {GeoServerRestClient} from 'geoserver-node-client';
|
|
57
58
|
|
|
@@ -68,7 +69,7 @@ async function main () {
|
|
|
68
69
|
main();
|
|
69
70
|
```
|
|
70
71
|
|
|
71
|
-
|
|
72
|
+
## Setup
|
|
72
73
|
|
|
73
74
|
Run as local checkout (mainly for development purposes)
|
|
74
75
|
|
|
@@ -82,7 +83,7 @@ npm install
|
|
|
82
83
|
npm run demo
|
|
83
84
|
```
|
|
84
85
|
|
|
85
|
-
|
|
86
|
+
## Error Handling
|
|
86
87
|
|
|
87
88
|
A request either succeeds or throws the custom `GeoServerResponseError`. It has the standard `message` property with a "human-readable" text. Additionally the error has the property `geoServerOutput` which contains the direct response from GeoServer. This output is not guaranteed to exist and can either be a simple text or a complete HTML document. The latter is difficult to read, but might still be helpful for debugging. This example shows how these error properties can be used. It also shows how to filter by error type:
|
|
88
89
|
|
|
@@ -105,7 +106,7 @@ A request either succeeds or throws the custom `GeoServerResponseError`. It has
|
|
|
105
106
|
}
|
|
106
107
|
```
|
|
107
108
|
|
|
108
|
-
|
|
109
|
+
## Unit Tests
|
|
109
110
|
|
|
110
111
|
First start a test setup using this Docker compose file:
|
|
111
112
|
|
|
@@ -120,7 +121,7 @@ Then, in an other terminal, run:
|
|
|
120
121
|
GEOSERVER_VERSION=2.20.4 npm run test
|
|
121
122
|
```
|
|
122
123
|
|
|
123
|
-
|
|
124
|
+
## Release
|
|
124
125
|
|
|
125
126
|
Setting a git tag and increasing the version in the `package.json` as well as releasing to npm is done via [release-it](https://github.com/release-it/release-it).
|
|
126
127
|
|
|
@@ -152,11 +153,11 @@ npm run release
|
|
|
152
153
|
- makes a release commit and pushes it to GitHub
|
|
153
154
|
- publishes the new version to npm
|
|
154
155
|
|
|
155
|
-
|
|
156
|
+
## Who do I talk to?
|
|
156
157
|
|
|
157
|
-
|
|
158
|
+
- meggsimum (Christian Mayer) - info __at## meggsimum ~~dot** de
|
|
158
159
|
|
|
159
|
-
|
|
160
|
+
## Credits
|
|
160
161
|
|
|
161
162
|
This project was initiated by [meggsimum](https://meggsimum.de) within the [mFund](https://www.bmvi.de/EN/Topics/Digital-Matters/mFund/mFund.html) research project [SAUBER](https://sauber-projekt.de/) and is further developed in the mFund research project [KLIPS](http://www.klips-projekt.de/):
|
|
162
163
|
<p><img src="https://sauber-projekt.de/wp-content/uploads/2018/12/SAG_SAUBER_Logo_Dez3_transparent-1-e1543843688935.png" alt="SAUBER Logo" width="200"/></p>.
|
package/dist/package.json
CHANGED