Skip to content

🆒 CoolMasterNet API Client for TypeScript

License

Notifications You must be signed in to change notification settings

bdsoha/coolmaster-client

Repository files navigation

CoolMasterNet Client

CoolMasterNet API Client for TypeScript

GitHub Workflow Code Climate maintainability Code Climate coverage

Banner


Installation

npm install coolmaster-client

Usage

import { CoolMasterNetClient } from 'coolmaster-client'

const client = CoolMasterNetClient.create({
    host:   '192.168.1.111',
    port:   1234,             // Optional, defaults to `10103`
    secure: true,             // Optional, defaults to `false`
    device: '443B960055F0',
})

const results = await client.ls2()

Using Environment Variables

Instead of using the ConnectionConfigs, you can opt-in to use environment variables. The lookup precedence is as follows:

  1. Values found in the ConnectionConfigs.
  2. Environment variable equivalent.
  3. Default values (if applicable).
Name Default
COOLMASTER_CLIENT_HOST undefined
COOLMASTER_CLIENT_PORT 10103
COOLMASTER_CLIENT_SECURE false
COOLMASTER_CLIENT_DEVICE undefined