WDX - WS - Client - JS

A TypeScript Web Socket Service Library for Managing WDX.

See API specification for Client library calls avaiable on ws interface.

Table of Contents

• Requirements
• Installation
• Usage
  • Using Client
• Examples
• API
• License

Requirements

• nodejs version 18.18.2 or higher is required.

Installation

To install the library, use npm or yarn:

npm install @wago/wdx-ws-client-js

or

yarn add @wago/wdx-ws-client-js

Usage

Using Client

Here's an example:

const WDXWSClient = require('@wago/wdx-ws-client-js');

(async () => {
    try {
        const c = new WDXWSClient.WDX.WS.Client.JS.Service.ClientService(
            { protocol: 'ws', host: 'localhost', port: 82 }
        );
        await c.connect();

        console.log('Connected successfully');

        const path = 'Virtual.virtual-store.test';

        c.dataService.getSchema(path, 1).subscribe(
            {
                next: (schema) => {
                    console.log(JSON.stringify(schema, null, 2));
                },

                error: async (error) => {
                    console.error('Error: ' + error.message);

                    await c.disconnect();
                    console.log('Disconnected successfully');
                },

                complete: async () => {
                    await c.disconnect();
                    console.log('Disconnected successfully');
                }
            },
        );

    } catch (e) {
        console.error('Error: ' + e.message);
        console.error('Error: ' + e.stack);
    }
})();

For more examples, see github repository example directory.

License

This library is licensed under the MIT License. See the LICENSE.md file for more details.

© 2024

This README.md provides a clear introduction to the TypeScript model schema library, with examples of how to use it, and includes the required copyright and licensing information under the MIT License.