REST SDK Constructor
import { QPub } from "@qpub/sdk";
const rest = new QPub.Rest({
apiKey: process.env.QPUB_API_KEY,
});
Options
Shares the same options type as Socket for auth/hosts/logging. REST-relevant defaults:
| Option | Default | Description |
|---|---|---|
apiKey | — | API key |
authUrl / tokenRequest | — | Alternate auth |
alias | — | Sent as X-Alias when set |
httpHost | rest.qpub.io | REST host |
httpPort | null | Optional port |
isSecure | true | https vs http |
debug / logLevel / logger | — | Logging |
Socket-only options (autoConnect, reconnect, …) are ignored for REST behavior.
Base URL: {https|http}://{httpHost}[:port]/v1
Instance
| Property / method | Description |
|---|---|
rest.channels | Publish API — Channels |
rest.queues | Queue API — Queues |
rest.auth | Same token helpers as Socket |
rest.reset() | Reset instance |
rest.getInstanceId() | Instance id |
REST does not subscribe to channels.