{"_id":"@arendi/rms","name":"@arendi/rms","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@arendi/rms","version":"1.0.0","description":"Arendi RMS WebSocket client","main":"dist/src/index.js","types":"dist/src/index.d.ts","scripts":{"test":"node --trace-warnings ./dist/test/apiTest","build":"tsc","format":"prettier --config .prettierrc src/**/*.ts test/**/*.ts --write","lint":"eslint . --ext .ts","doc":"typedoc src/*.ts --name ArendiTesting"},"author":{"name":"Arendi Products GmbH"},"license":"ISC","devDependencies":{"@types/node":"^18.7.16","@typescript-eslint/eslint-plugin":"^5.36.2","@typescript-eslint/parser":"^5.36.2","typescript":"^4.8.3"},"dependencies":{"@arendi/testing":"^2.1.0","@raesch/ext-promise":"^1.0.3","events":"^3.3.0","websocket":"^1.0.34"},"homepage":"https://arendi.ch/rms","repository":{"type":"git","url":"git+https://bitbucket.org/arendiag/arendi_testing_rms_npm.git"},"engines":{"node":">=16"},"_id":"@arendi/rms@1.0.0","gitHead":"92f9e8e3f83bb92b70240359a30f11d3688460cd","bugs":{"url":"https://bitbucket.org/arendiag/arendi_testing_rms_npm/issues"},"_nodeVersion":"18.18.2","_npmVersion":"9.8.1","dist":{"integrity":"sha512-YjGcWHfrM5RCvbZCZa7XREcW2EFh+kSTQx/wst5SqTP8fChYKaBD/nyl8d2o0byRPeEfUrXNOahePJjDnByPEw==","shasum":"0a791158e5325d51a8749bfac5a4b05eb4a20f0f","tarball":"https://registry.npmjs.org/@arendi/rms/-/rms-1.0.0.tgz","fileCount":37,"unpackedSize":109543,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQD9PQsc4TInj22tikZePyMQgGgT5P92ytB8VNfair+uOgIgcbuk5q+9fLAGfYKzF/VaH+tMC+/BAy/rPx9iiP0cmr0="}]},"_npmUser":{"name":"arendi","email":"rashid.talib@arendi.ch"},"directories":{},"maintainers":[{"name":"arendi","email":"rashid.talib@arendi.ch"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/rms_1.0.0_1739730591874_0.020193239951952213"},"_hasShrinkwrap":false}},"time":{"created":"2025-02-16T18:29:51.796Z","1.0.0":"2025-02-16T18:29:52.057Z","modified":"2025-02-16T18:29:52.331Z"},"maintainers":[{"name":"arendi","email":"rashid.talib@arendi.ch"}],"description":"Arendi RMS WebSocket client","homepage":"https://arendi.ch/rms","repository":{"type":"git","url":"git+https://bitbucket.org/arendiag/arendi_testing_rms_npm.git"},"author":{"name":"Arendi Products GmbH"},"bugs":{"url":"https://bitbucket.org/arendiag/arendi_testing_rms_npm/issues"},"license":"ISC","readme":"# RMS WebSocket client API\r\n\r\nThis package contains JavaScript source files for communicating with the Arendi RMS server.\r\n\r\n## Prerequisite\r\n\r\n### WebSocket server\r\n\r\nAn instance of the WebSocket server must be running in order for the following sample code to run. To install the WebSocket server, download\r\nand execute the installer from https://www.arendi.ch/rms\r\n\r\n### Node\r\n\r\nNode.js (at least v16) must be installed on the target machine: https://nodejs.org\r\n\r\n---\r\n\r\n## Installation\r\n\r\nInstall with npm:\r\n\r\n```shell\r\nnpm install \"@arendi/rms\"\r\n```\r\n\r\n---\r\n\r\n## Usage\r\n\r\n```javascript\r\n\r\n```\r\n\r\n### Development\r\n\r\n#### Build\r\n\r\nTo build the project from source, perform the following steps:\r\n\r\n- clone the repository to a local folder:\r\n\r\n````\r\n\r\n- Open the created folder and run\r\n  ```bash\r\n  npm install\r\n  npm run build\r\n  ```\r\n\r\nThe 'npm run build' command described above must be executed in order to compile and copy any changes made to the source files located in the src directory\r\n\r\n#### Test\r\n\r\n- Run test\r\n  ```bash\r\n  npm run test\r\n  ```\r\n````\r\n","readmeFilename":"README.md"}