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

    2.3.0 • Public • Published

    Ditto JavaScript Node.js client

    Implementation of the Eclipse Ditto JavaScript API that uses functionality of a Node.js environment, e.g. Buffer.

    It is published to the npm registry as CommonJS module.

    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-node

    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 = DittoNodeClient.newHttpClient()
                .withoutTls()
                .withDomain(domain)
                .withAuthProvider(NodeHttpBasicAuth.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.

    Proxy

    The Node.js implementation supports setting up a proxy. Currently, it supports either reading directly from 'https_proxy' (or 'HTTPS_PROXY') environment variable or manually setting the proxy settings.

    // may also omit one or more of the options
    const proxyOptions = {
      url: 'PROXY-URL:PROXYPORT',
      username: 'PROXY-USERNAME',
      password: 'PROXY-PASSWORD'
    }
    
    DittoNodeClient.newHttpClient(proxyOptions)
    //  ...

    Any options that are set manually will override options that are read from an environment variable.

    Install

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

    DownloadsWeekly Downloads

    15

    Version

    2.3.0

    License

    EPL-2.0

    Unpacked Size

    619 kB

    Total Files

    173

    Last publish

    Collaborators

    • eclipse_ditto
    • florian.fendt.bosch