Merge pull request #1192 from danielpeintner/issue-1187

docs: align import/require style in READMEs

Author: relu91

README.md

@@ -142,8 +142,8 @@ With node-wot you can create server-side Things, in WoT jargon we call this oper
 
 ```JavaScript
 // Required steps to create a servient for creating a thing
-const Servient = require('@node-wot/core').Servient;
-const HttpServer = require('@node-wot/binding-http').HttpServer;
+const { Servient } = require("@node-wot/core");
+const { HttpServer } = require("@node-wot/binding-http");
 
 const servient = new Servient();
 servient.addServer(new HttpServer());
@@ -181,7 +181,7 @@ Now supposing you want to interact with the device, you have to consume its Thin
 // client.js
 // Required steps to create a servient for a client
 const { Servient } = require("@node-wot/core");
-const { HttpClientFactory } = require('@node-wot/binding-http');
+const { HttpClientFactory } = require("@node-wot/binding-http");
 
 const servient = new Servient();
 servient.addClientFactory(new HttpClientFactory(null));
@@ -337,8 +337,7 @@ export interface ContentCodec {
 Finally you can add to your servient the new codec as follows:
 
 ```JavaScript
-const ContentSerdes = require('@node-wot/core').ContentSerdes
-const JsonCodec = require('@node-wot/core').JsonCodec
+const { ContentSerdes, JsonCodec } = require("@node-wot/core");
 
 // e.g., assign built-in codec for *new* contentType
 const cs = ContentSerdes.get();

packages/binding-file/README.md

@@ -21,9 +21,9 @@ The example tries to load an internal TestThing TD and reads the `fileContent` p
 `node example1.js`
 
 ```js
-// example.js1
-const Servient = require("@node-wot/core").Servient;
-const FileClientFactory = require("@node-wot/binding-file").FileClientFactory;
+// example1.js
+const { Servient } = require("@node-wot/core");
+const { FileClientFactory } = require("@node-wot/binding-file");
 
 // create Servient and add File binding
 const servient = new Servient();
@@ -81,8 +81,8 @@ The example tries to load a locally stored TestThing TD and reads the `fileConte
 
 ```js
 // example2.js
-const Servient = require("@node-wot/core").Servient;
-const FileClientFactory = require("@node-wot/binding-file").FileClientFactory;
+const { Servient } = require("@node-wot/core");
+const { FileClientFactory } = require("@node-wot/binding-file");
 
 // create Servient and add File binding
 const servient = new Servient();

packages/binding-http/README.md

@@ -26,11 +26,11 @@ The Thing Description is located under the following uri <http://plugfest.thingw
 
 ```js
 // example-client.js
-Servient = require("@node-wot/core").Servient;
-HttpClientFactory = require("@node-wot/binding-http").HttpClientFactory;
+const { Servient } = require("@node-wot/core");
+const { HttpClientFactory } = require("@node-wot/binding-http");
 
 // create Servient and add HTTP binding
-let servient = new Servient();
+const servient = new Servient();
 servient.addClientFactory(new HttpClientFactory(null));
 
 servient
@@ -60,13 +60,11 @@ The server example produces a thing that allows for setting a property `count`.
 
 ```js
 // example-server.js
-Servient = require("@node-wot/core").Servient;
-HttpServer = require("@node-wot/binding-http").HttpServer;
-
-Helpers = require("@node-wot/core").Helpers;
+const { Servient } = require("@node-wot/core");
+const { HttpServer } = require("@node-wot/binding-http");
 
 // create Servient add HTTP binding with port configuration
-let servient = new Servient();
+const servient = new Servient();
 servient.addServer(
     new HttpServer({
         port: 8081, // (default 8080)
@@ -110,21 +108,19 @@ The _secure_ server example shows how to add credentials and how to set up HTTPS
 
 ```js
 // example-server-secure.js
-Servient = require("@node-wot/core").Servient;
-HttpServer = require("@node-wot/binding-http").HttpServer;
-
-Helpers = require("@node-wot/core").Helpers;
+const { Servient } = require("@node-wot/core");
+const { HttpServer } = require("@node-wot/binding-http");
 
 // create secure Servient with username & password credentials
-let servient = new Servient();
+const servient = new Servient();
 servient.addCredentials({
     "urn:dev:wot:org:eclipse:thingweb:my-example-secure": {
         username: "node-wot",
         password: "hello",
         // token: "1/mZ1edKKACtPAb7zGlwSzvs72PvhAbGmB8K1ZrGxpcNM"
     },
 });
-let httpConfig = {
+const httpConfig = {
     allowSelfSigned: true, // client configuration
     serverKey: "privatekey.pem",
     serverCert: "certificate.pem",

packages/binding-mqtt/README.md

@@ -26,11 +26,11 @@ In addition, the Thing subscribes to the `resetCounter` topic (via its action ha
 it can handle requests to reset the counter value.
 
 ```js
-Servient = require("@node-wot/core").Servient;
-MqttBrokerServer = require("@node-wot/binding-mqtt").MqttBrokerServer;
+const { Servient } = require("@node-wot/core");
+const { MqttBrokerServer } = require("@node-wot/binding-mqtt");
 
 // create Servient add MQTT binding
-let servient = new Servient();
+const servient = new Servient();
 servient.addServer(new MqttBrokerServer({ uri: "mqtt://test.mosquitto.org" }));
 
 servient.start().then((WoT) => {
@@ -111,17 +111,15 @@ The Thing Description corresponding to the previous example is shown below:
 This example takes the Thing Description of the previous example and subscribes to the `counterEvent` and resets the counter every 20s via the `resetCounter` action.
 
 ```js
-Servient = require("@node-wot/core").Servient;
-MqttClientFactory = require("@node-wot/binding-mqtt").MqttClientFactory;
-
-Helpers = require("@node-wot/core").Helpers;
+const { Servient } = require("@node-wot/core");
+const { MqttClientFactory } = require("@node-wot/binding-mqtt");
 
 // create Servient and add MQTT binding
-let servient = new Servient();
+const servient = new Servient();
 servient.addClientFactory(new MqttClientFactory(null));
 
 // Thing Description can be also fetched
-let td = `{
+const td = `{
     "@context": "https://www.w3.org/2019/td/v1",
     "title": "MQTT-Test",
     "id": "urn:dev:wot:mqtt:counter",

packages/td-tools/README.md

@@ -18,23 +18,22 @@ The example parses a TD and also serializes yet another newly created TD.
 
 ```
 // example.js
-TDTools = require("@node-wot/td-tools");
-Thing = require("@node-wot/td-tools").Thing;
-
+const TDTools = require("@node-wot/td-tools");
+const { Thing } = require("@node-wot/td-tools");
 
 // parse TD
-let tdString = JSON.stringify({
+const tdString = JSON.stringify({
     id : "123",
     title: "MyThing"
 });
-let dd = TDTools.parseTD(tdString);
+const dd = TDTools.parseTD(tdString);
 console.log("**** PARSED TD ****");
 console.log(dd);
 console.log("****");
 
 
 // init Thing and serialize to TD
-let thing = new Thing();
+const thing = new Thing();
 thing.id = "789";
 thing["@type"] = "Thing";
 thing.support = "foo@example.com"
@@ -43,7 +42,7 @@ thing.properties = {
         type: "integer"
     }
 }
-let tdString2 = TDTools.serializeTD(thing);
+const tdString2 = TDTools.serializeTD(thing);
 console.log("**** SERIALIZED TD ****");
 console.log(tdString2);
 console.log("****");