@eclipse-ditto/ditto-javascript-client-dom
TypeScript icon, indicating that this package has built-in type declarations

3.5.0 • Public • Published

Ditto JavaScript DOM client

Implementation of the Eclipse Ditto JavaScript API that uses functionality of DOM environments, e.g. btoa() or WebSocket.

It is published as an ES6 module. You could also use a CDN like UNPKG to directly use it in an HTML document (although "very experimental", use the ?module-flag when importing from UNPKG).

Building

Basically it makes sense to trigger the build process once from the parent module. Then you'll be able to use the default build process in here:

npm install
npm run build
npm run lint
npm test
# or npm run test:watch

Using

npm i --save  @eclipse-ditto/ditto-javascript-client-dom

Create an instance of a client:

const domain = 'localhost:8080';
const username = 'ditto';
const password = 'ditto';

// could also use newWebSocketClient() for the WebSocket implementation
const client = DittoDomClient.newHttpClient()
            .withoutTls()
            .withDomain(domain)
            .withAuthProvider(DomHttpBasicAuth.newInstance(username, password))
            .build();

To use a path other than /api to connect to ditto, the optional step .withCustomPath('/path/to/api') can be used.

To find out how to use the client, have a look at the api documentation, since the API will stay the same no matter what implementation is used.

Package Sidebar

Install

npm i @eclipse-ditto/ditto-javascript-client-dom

Weekly Downloads

50

Version

3.5.0

License

EPL-2.0

Unpacked Size

637 kB

Total Files

184

Last publish

Collaborators

  • eclipse_ditto
  • florian.fendt.bosch