Get unlimited public & private packages + team-based management with npm Teams.Learn more »

@eclipse-ditto/ditto-javascript-client-dom_1.0

1.0.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 with two different module types to the npm registry:

  • IIFE (dist/index.bundle.js), for using it directly in a browser. The functionality is available under the base name EclipseDittoJavascriptClient. You can use a CDN like UNPKG to directly use it in a HTML document without the need to compile or pack anything.
  • ES Module (dist/index.es.js)

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

# replace <ditto-major.minor> with the major and minor version number of Eclipse Ditto you are using.
npm i --save  @eclipse/ditto-javascript-client-api_<ditto-major.minor> @eclipse/ditto-javascript-client-dom_<ditto-major.minor>

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))
            .apiVersion2()
            .build();

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.

Install

npm i @eclipse-ditto/ditto-javascript-client-dom_1.0

DownloadsWeekly Downloads

1

Version

1.0.0

License

SEE LICENSE IN LICENSE

Unpacked Size

88.6 kB

Total Files

27

Last publish

Collaborators

  • avatar
  • avatar