forked from nats-io/stan.js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.d.ts
243 lines (202 loc) · 7.09 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
/*
* Copyright 2016-2018 The NATS Authors
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import events = require('events');
import nats = require('nats');
// import proto = require('./lib/pb');
export const version: string;
/**
* Connect to a nats-server and return the client.
* Argument can be a url, or an object with a 'url'
* property and additional options.
*/
export function connect(clusterID: string, clientID: string, opts?: StanOptions): Stan;
export interface StanOptions {
url?: string,
connectTimeout?: number,
ackTimeout?: number,
discoverPrefix?: string,
maxPubAcksInflight?: number,
stanEncoding?: string,
nc?: nats.Client
}
declare class Message {
/**
* Returns the subject associated with this Message
*/
getSubject():string;
/**
* Returns the sequence number of the message in the stream.
*/
getSequence():number;
/**
* Returns a Buffer with the raw message payload
*/
getRawData():Buffer;
/**
* Returns the data associated with the message payload. If the stanEncoding is not
* set to 'binary', a string is returned.
*/
getData():String|Buffer;
/**
* Returns the raw timestamp set on the message. This number is not a valid time in JavaScript.
*/
getTimestampRaw():number;
/**
* Returns a Date object representing the timestamp of the message. This is an approximation of the timestamp.
*/
getTimestamp():Date;
/**
* Returns a boolean indicating if the message is being redelivered
*/
isRedelivered():boolean;
/**
* Returns an optional IEEE CRC32 checksum
*/
getCrc32():number;
/**
* Acks the message, note this method shouldn't be called unless
* the manualAcks option was set on the subscription.
*/
ack(): void;
}
declare class Subscription extends events.EventEmitter {
/**
* Returns true if the subscription has been closed or unsubscribed from.
*/
isClosed():boolean;
/**
* Unregisters the subscription from the streaming server.
*/
unsubscribe(): void;
/**
* Close removes the subscriber from the server, but unlike the Subscription#unsubscribe(),
* the durable interest is not removed. If the client has connected to a server
* for which this feature is not available, Subscription#Close() will emit a
* Subscription#error(NO_SERVER_SUPPORT) error. Note that this affects durable clients only.
* If called on a non-durable subscriber, this is equivalent to Subscription#close()
*/
close(): void;
}
/**
* Callback informs the client that the message was processed by the server
* @param err - undefined if there is no error processing the message
* @param guid - the guid correlating the message with the callback invocation.
*/
interface AckHandlerCallback { (err: Error, guid: string): void; }
declare class Stan extends events.EventEmitter {
/**
* Close the connection to the server.
*/
close(): void;
/**
* Publishes a message to the streaming server with the specified subject and data.
* @param subject
* @param data
* @param callback
* @returns guid generated for the published message
*/
publish(subject: string, data?: Uint8Array|string|Buffer, callback?:AckHandlerCallback): string;
/**
* Subscribes to a given subject as an optional member of a queue group.
* @param subject
* @param qGroup
* @param opts
*/
subscribe(subject: string, opts?: SubscriptionOptions): Subscription
subscribe(subject: string, qGroup: string, opts?: SubscriptionOptions): Subscription
/**
* Returns a SubscriptionOptions initialized to defaults
*/
subscriptionOptions(): SubscriptionOptions;
}
declare enum StartPosition {
NEW_ONLY = 0,
LAST_RECEIVED,
TIME_DELTA_START,
SEQUENCE_START,
FIRST
}
declare interface SubscriptionOptions {
durableName?: string;
maxInFlight?: number;
ackWait?: number;
startPosition: StartPosition;
startSequence?: number;
startTime?: number;
manualAcks?: boolean;
/**
* Sets the maximun number of unacknowledged messages that the streaming server will allow
* before it sends a message.
* @param n
*/
setMaxInFlight(n: number):SubscriptionOptions;
/**
* Sets the number of milliseconds before a message is considered unacknowledged by
* the streaming server.
*/
setAckWait(millis: number): SubscriptionOptions;
/**
* Configures the subscription start mode.
* Typically you would invoke this message with StartPostion#FIRST, StartPosition#NEW_ONLY or
* StartPosition#LAST_RECEIVED. For all other uses (SubscriptionOptions#setStartSequence,
* SubscriptionOptions#setStartTime, SubscriptionOptions#setStartAtTimeDelta, or
* SubscriptionOptions#setStartWithLastReceived), the method will configure
* the startup value and position.
*
* @param startPosition
*/
setStartAt(startPosition: StartPosition): SubscriptionOptions;
/**
* Configures the subscription to start with the message having the specified
* sequence number.
*
* @param sequence
*/
setStartAtSequence(sequence: number): SubscriptionOptions;
/**
* Configures the subscription to start with messages sent at the specified date.
* @param date
*/
setStartTime(date: Date): SubscriptionOptions;
/**
* Configures the subscription to replay messages sent milliseconds ago.
* @param millis - the number of milliseconds ago to use as the start time
*/
setStartAtTimeDelta(millis: number):SubscriptionOptions;
/**
* Configures the subscription to replay with the last received message.
*/
setStartWithLastReceived():SubscriptionOptions;
/**
* Configures the subscription to replay from first available message.
*/
setDeliverAllAvailable():SubscriptionOptions;
/**
* Configures the subscription to require manual acknowledgement of messages
* using Message#acknowledge.
* @param tf - true if manual acknowlegement is required.
*/
setManualAckMode(tf: boolean): SubscriptionOptions;
/**
* Sets a durable subscription name that the client can specify for the subscription.
* This enables the subscriber to close the connection without canceling the subscription and
* resume the subscription with same durable name. Note the server will resume the
* subscription with messages
* that have not been acknowledged.
*
* @param durableName
*/
setDurableName(durableName: string): SubscriptionOptions;
}