add typings

Author: bdchauvette

index.d.ts

@@ -0,0 +1,73 @@
+import {
+  MqttClient,
+  IClientOptions,
+  IClientPublishOptions,
+  IClientSubscribeOptions,
+  IPublishPacket,
+  ISubscriptionGrant,
+  ISubscriptionMap,
+  IUnsubackPacket,
+  PacketCallback,
+} from 'mqtt';
+
+export * from 'mqtt/types/lib/client-options';
+export * from 'mqtt/types/lib/store';
+
+export {
+  // mqtt/types/lib/client
+  ISubscriptionGrant,
+  ISubscriptionRequest,
+  ISubscriptionMap,
+  OnMessageCallback,
+  OnPacketCallback,
+  OnErrorCallback,
+  IStream,
+
+  // mqtt-packet
+  QoS,
+  PacketCmd,
+  IPacket,
+  IConnectPacket,
+  IPublishPacket,
+  IConnackPacket,
+  ISubscription,
+  ISubscribePacket,
+  ISubackPacket,
+  IUnsubscribePacket,
+  IUnsubackPacket,
+  IPubackPacket,
+  IPubcompPacket,
+  IPubrelPacket,
+  IPubrecPacket,
+  IPingreqPacket,
+  IPingrespPacket,
+  IDisconnectPacket,
+  Packet
+} from 'mqtt'
+
+export interface IMqttClient extends MqttClient {}
+
+export declare class AsyncMqttClient extends MqttClient {
+  constructor (client: IMqttClient);
+
+  public subscribe (topic: string | string[], opts: IClientSubscribeOptions): Promise<ISubscriptionGrant[]>
+  public subscribe (topic: string | string[] | ISubscriptionMap): Promise<ISubscriptionGrant[]>
+  /* original */ public subscribe (topic: string | string[], opts: IClientSubscribeOptions, callback: never): this
+  /* original */ public subscribe (topic: string | string[] | ISubscriptionMap, callback: never): this
+
+  public unsubscribe (topic: string | string[]): Promise<IUnsubackPacket>
+  /* original */ public unsubscribe (topic: string | string[], callback: never): this;
+
+  public publish (topic: string, message: string | Buffer, opts: IClientPublishOptions): Promise<IPublishPacket>
+  public publish (topic: string, message: string | Buffer): Promise<IPublishPacket>
+  /* original */ public publish (topic: string, message: string | Buffer, opts: IClientPublishOptions, callback: never): this
+  /* original */ public publish (topic: string, message: string | Buffer, callback: never): this
+
+  public end (force?: boolean): Promise<void>
+  /* original */ public end (force: boolean, callback: never): this;
+}
+
+export declare function connect (brokerUrl?: string | any, opts?: IClientOptions): AsyncMqttClient
+
+export { AsyncMqttClient as AsyncClient }
+

package.json

@@ -3,6 +3,7 @@
   "version": "2.0.0",
   "description": "Promise wrapper over MQTT.js",
   "main": "index.js",
+  "types": "index.d.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
@@ -28,6 +29,7 @@
     "mqtt": "^2.3.1"
   },
   "devDependencies": {
+    "@types/node": "^10.12.10",
     "eslint": "^4.8.0",
     "mqtt-connection": "^3.0.0",
     "tape": "^4.6.3"