Skip to content

Commit 6765fad

Browse files
authored
Merge pull request #10 from bdchauvette/typings
Add TypeScript typings
2 parents 98cb2e1 + e40b685 commit 6765fad

File tree

3 files changed

+74
-1144
lines changed

3 files changed

+74
-1144
lines changed

index.d.ts

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
import {
2+
MqttClient,
3+
IClientOptions,
4+
IClientPublishOptions,
5+
IClientSubscribeOptions,
6+
IPublishPacket,
7+
ISubscriptionGrant,
8+
ISubscriptionMap,
9+
IUnsubackPacket,
10+
PacketCallback,
11+
} from 'mqtt';
12+
13+
export * from 'mqtt/types/lib/client-options';
14+
export * from 'mqtt/types/lib/store';
15+
16+
export {
17+
// mqtt/types/lib/client
18+
ISubscriptionGrant,
19+
ISubscriptionRequest,
20+
ISubscriptionMap,
21+
OnMessageCallback,
22+
OnPacketCallback,
23+
OnErrorCallback,
24+
IStream,
25+
26+
// mqtt-packet
27+
QoS,
28+
PacketCmd,
29+
IPacket,
30+
IConnectPacket,
31+
IPublishPacket,
32+
IConnackPacket,
33+
ISubscription,
34+
ISubscribePacket,
35+
ISubackPacket,
36+
IUnsubscribePacket,
37+
IUnsubackPacket,
38+
IPubackPacket,
39+
IPubcompPacket,
40+
IPubrelPacket,
41+
IPubrecPacket,
42+
IPingreqPacket,
43+
IPingrespPacket,
44+
IDisconnectPacket,
45+
Packet
46+
} from 'mqtt'
47+
48+
export interface IMqttClient extends MqttClient {}
49+
50+
export declare class AsyncMqttClient extends MqttClient {
51+
constructor (client: IMqttClient);
52+
53+
public subscribe (topic: string | string[], opts: IClientSubscribeOptions): Promise<ISubscriptionGrant[]>
54+
public subscribe (topic: string | string[] | ISubscriptionMap): Promise<ISubscriptionGrant[]>
55+
/* original */ public subscribe (topic: string | string[], opts: IClientSubscribeOptions, callback: never): this
56+
/* original */ public subscribe (topic: string | string[] | ISubscriptionMap, callback: never): this
57+
58+
public unsubscribe (topic: string | string[]): Promise<IUnsubackPacket>
59+
/* original */ public unsubscribe (topic: string | string[], callback: never): this;
60+
61+
public publish (topic: string, message: string | Buffer, opts: IClientPublishOptions): Promise<IPublishPacket>
62+
public publish (topic: string, message: string | Buffer): Promise<IPublishPacket>
63+
/* original */ public publish (topic: string, message: string | Buffer, opts: IClientPublishOptions, callback: never): this
64+
/* original */ public publish (topic: string, message: string | Buffer, callback: never): this
65+
66+
public end (force?: boolean): Promise<void>
67+
/* original */ public end (force: boolean, callback: never): this;
68+
}
69+
70+
export declare function connect (brokerUrl?: string | any, opts?: IClientOptions): AsyncMqttClient
71+
72+
export { AsyncMqttClient as AsyncClient }

0 commit comments

Comments
 (0)