space-engineers - npm Package Compare versions

Comparing version 1.0.3 to 1.0.5

lib/bridge.js

@@ -21,8 +21,2 @@ const config = require('config');
 
-  console.log(
-    url,
-    message,
-    query
-  )
-
   return {
@@ -29,0 +23,0 @@ url: url + query,

lib/session.js

@@ -27,3 +27,3 @@ const {demotePlayer, banPlayer, kickPlayer, promotePlayer} = require('./admin');
       entity.remove = () => {
-        return send('DELETE', `${path}/${EntityId}`, {log: true});
+        return send('DELETE', `${path}/${EntityId}`);
       }
@@ -63,3 +63,3 @@ }
   if (message) {
-    return send('POST', path, {body: message, log: true});
+    return send('POST', path, {body: message});
   }
@@ -74,3 +74,3 @@
 
-  const {Messages} = await send('GET', path, {qs: {Date: date, MessageCount: count}, log: true});
+  const {Messages} = await send('GET', path, {qs: {Date: date, MessageCount: count}});
 
@@ -77,0 +77,0 @@ return Messages;

package.json

 {
   "name": "space-engineers",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "A complete Node.js API for the Space Engineers Remote API.",
@@ -5,0 +5,0 @@ "author": "Brian Jemilo II<[e-mail]>",

readme.md

@@ -18,1 +18,66 @@ # space-engineers
 ```
+
+If you already use config, make sure to add the following to your `default.json`
+
+```json
+{
+  "SpaceEngineers": {
+    "baseUrl": "http://localhost",
+    "port": 8080,
+    "prefix": "/vrageremote"
+  }
+}
+```
+
+Exports
+
+```js
+{
+  // Admin Routes
+  admin: {
+    demotePlayer,
+    bannedPlayers,
+    banPlayer,
+    kickedPlayers,
+    kickPlayer,
+    promotePlayer
+  },
+  // API Routes
+  api: {
+    api
+  },
+  // Express Server Instance
+  app,
+  // Server Routes
+  server: {
+    info,
+    ping,
+    stop
+  },
+  // Session Routes
+  session: {
+    asteroids,
+    characters,
+    chat,
+    economyAnalysis,
+    floatingObjects,
+    grids,
+    planets,
+    players,
+    save 
+  }
+}
+```
+
+Most methods will return an array or single object.
+In every object, you might find additional methods attached:
+- remove
+- stop
+- power.on
+- power.off
+
+For the players method, objects will have additional methods.
+- ban
+- kick
+- promote
+- demote

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

11387

increased by7.92%

Number of lines in readme file

82

increased by355.56%

Worsened metrics

Lines of code

265

decreased by-1.85%

No dependency changes