Skip to content

Commit 5dd2013

Browse files
committed
docs: use normal - in the docs
1 parent 9422764 commit 5dd2013

File tree

2 files changed

+40
-40
lines changed

2 files changed

+40
-40
lines changed

src/index.ts

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ export interface Writable<
159159
* they are dropped**, you should implement a [simple
160160
* queue](examples/queue/queue.ts) in JavaScript. Such a queue is not
161161
* provided by this library because most real world applications need to
162-
* deal with undeliverable messages in more complex ways for example, they
162+
* deal with undeliverable messages in more complex ways - for example, they
163163
* might need to reply with a status message; or first retry delivery a
164164
* certain number of times before giving up.
165165
*
@@ -902,14 +902,14 @@ declare module "./native" {
902902
* Returns the current security mechanism for the socket, if any. The
903903
* security mechanism is set implictly by using any of the relevant security
904904
* options. The returned value is one of:
905-
* * `null` No security mechanism is used.
906-
* * `"plain"` The PLAIN mechanism defines a simple username/password
905+
* * `null` - No security mechanism is used.
906+
* * `"plain"` - The PLAIN mechanism defines a simple username/password
907907
* mechanism that lets a server authenticate a client. PLAIN makes no
908908
* attempt at security or confidentiality.
909-
* * `"curve"` The CURVE mechanism defines a mechanism for secure
909+
* * `"curve"` - The CURVE mechanism defines a mechanism for secure
910910
* authentication and confidentiality for communications between a client
911911
* and a server. CURVE is intended for use on public networks.
912-
* * `"gssapi"` The GSSAPI mechanism defines a mechanism for secure
912+
* * `"gssapi"` - The GSSAPI mechanism defines a mechanism for secure
913913
* authentication and confidentiality for communications between a client
914914
* and a server using the Generic Security Service Application Program
915915
* Interface (GSSAPI). The GSSAPI mechanism can be used on both public and
@@ -1002,7 +1002,7 @@ export class Publisher extends Socket {
10021002
*
10031003
* If set to `true`, a socket shall keep only one message in its
10041004
* inbound/outbound queue: the last message to be received/sent. Ignores any
1005-
* high water mark options. Does not support multi-part messages in
1005+
* high water mark options. Does not support multi-part messages - in
10061006
* particular, only one part of it is kept in the socket internal queue.
10071007
*/
10081008
conflate: boolean
@@ -1041,7 +1041,7 @@ export class Subscriber extends Socket {
10411041
*
10421042
* If set to `true`, a socket shall keep only one message in its
10431043
* inbound/outbound queue: the last message to be received/sent. Ignores any
1044-
* high water mark options. Does not support multi-part messages in
1044+
* high water mark options. Does not support multi-part messages - in
10451045
* particular, only one part of it is kept in the socket internal queue.
10461046
*/
10471047
conflate: boolean
@@ -1268,7 +1268,7 @@ export class Dealer extends Socket {
12681268
*
12691269
* If set to `true`, a socket shall keep only one message in its
12701270
* inbound/outbound queue: the last message to be received/sent. Ignores any
1271-
* high water mark options. Does not support multi-part messages in
1271+
* high water mark options. Does not support multi-part messages - in
12721272
* particular, only one part of it is kept in the socket internal queue.
12731273
*/
12741274
conflate: boolean
@@ -1398,7 +1398,7 @@ export interface Pull extends Readable {
13981398
*
13991399
* If set to `true`, a socket shall keep only one message in its
14001400
* inbound/outbound queue: the last message to be received/sent. Ignores any
1401-
* high water mark options. Does not support multi-part messages in
1401+
* high water mark options. Does not support multi-part messages - in
14021402
* particular, only one part of it is kept in the socket internal queue.
14031403
*/
14041404
conflate: boolean
@@ -1429,7 +1429,7 @@ export interface Push extends Writable {
14291429
*
14301430
* If set to `true`, a socket shall keep only one message in its
14311431
* inbound/outbound queue: the last message to be received/sent. Ignores any
1432-
* high water mark options. Does not support multi-part messages in
1432+
* high water mark options. Does not support multi-part messages - in
14331433
* particular, only one part of it is kept in the socket internal queue.
14341434
*/
14351435
conflate: boolean
@@ -1485,11 +1485,11 @@ export class XPublisher extends Socket {
14851485
* ZMQ_XPUB_VERBOSE / ZMQ_XPUB_VERBOSER
14861486
*
14871487
* Whether to pass any duplicate subscription/unsuscription messages.
1488-
* * `null` (default) Only unique subscribe and unsubscribe messages are
1488+
* * `null` (default) - Only unique subscribe and unsubscribe messages are
14891489
* visible to the caller.
1490-
* * `"allSubs"` All subscribe messages (including duplicates) are visible
1490+
* * `"allSubs"` - All subscribe messages (including duplicates) are visible
14911491
* to the caller, but only unique unsubscribe messages are visible.
1492-
* * `"allSubsUnsubs"` All subscribe and unsubscribe messages (including
1492+
* * `"allSubsUnsubs"` - All subscribe and unsubscribe messages (including
14931493
* duplicates) are visible to the caller.
14941494
*/
14951495
set verbosity(value: null | "allSubs" | "allSubsUnsubs") {

src/native.ts

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ export declare const version: string
1919
* Unavailable capabilities will be absent or set to `false`.
2020
*
2121
* Possible keys include:
22-
* * `ipc` Support for the `ipc://` protocol.
23-
* * `pgm` Support for the `pgm://` protocol.
24-
* * `tipc` Support for the `tipc://` protocol.
25-
* * `norm` Support for the `norm://` protocol.
26-
* * `curve` Support for the CURVE security mechanism.
27-
* * `gssapi` Support for the GSSAPI security mechanism.
28-
* * `draft` Wether the library is built with support for DRAFT sockets.
22+
* * `ipc` - Support for the `ipc://` protocol.
23+
* * `pgm` - Support for the `pgm://` protocol.
24+
* * `tipc` - Support for the `tipc://` protocol.
25+
* * `norm` - Support for the `norm://` protocol.
26+
* * `curve` - Support for the CURVE security mechanism.
27+
* * `gssapi` - Support for the GSSAPI security mechanism.
28+
* * `draft` - Wether the library is built with support for DRAFT sockets.
2929
*/
3030
export declare const capability: Partial<{
3131
ipc: boolean
@@ -65,7 +65,7 @@ export declare function curveKeyPair(): {
6565
* A ØMQ context. Contexts manage the background I/O to send and receive
6666
* messages of their associated sockets.
6767
*
68-
* It is usually not necessary to instantiate a new context the global
68+
* It is usually not necessary to instantiate a new context - the global
6969
* {@link context} is used for new sockets by default. The global context is the
7070
* only context that is shared between threads (when using
7171
* [worker_threads](https://nodejs.org/api/worker_threads.html)). Custom
@@ -176,76 +176,76 @@ type EventFor<T extends string, D = {}> = Expand<{type: T} & D>
176176
* errors) that correspond to a specific operation are namespaced with a colon
177177
* `:`, e.g. `bind:error` or `connect:retry`.
178178
*
179-
* * **accept** ZMQ_EVENT_ACCEPTED The socket has accepted a connection from a
179+
* * **accept** - ZMQ_EVENT_ACCEPTED The socket has accepted a connection from a
180180
* remote peer.
181181
*
182-
* * **accept:error** ZMQ_EVENT_ACCEPT_FAILED The socket has rejected a
182+
* * **accept:error** - ZMQ_EVENT_ACCEPT_FAILED The socket has rejected a
183183
* connection from a remote peer.
184184
*
185185
* The following additional details will be included with this event:
186186
*
187-
* * `error` An error object that describes the specific error
187+
* * `error` - An error object that describes the specific error
188188
* that occurred.
189189
*
190-
* * **bind** ZMQ_EVENT_LISTENING The socket was successfully bound to a
190+
* * **bind** - ZMQ_EVENT_LISTENING The socket was successfully bound to a
191191
* network interface.
192192
*
193-
* * **bind:error** ZMQ_EVENT_BIND_FAILED The socket could not bind to a given
193+
* * **bind:error** - ZMQ_EVENT_BIND_FAILED The socket could not bind to a given
194194
* interface.
195195
*
196196
* The following additional details will be included with this event:
197197
*
198-
* * `error` An error object that describes the specific error
198+
* * `error` - An error object that describes the specific error
199199
* that occurred.
200200
*
201-
* * **connect** ZMQ_EVENT_CONNECTED The socket has successfully connected to
201+
* * **connect** - ZMQ_EVENT_CONNECTED The socket has successfully connected to
202202
* a remote peer.
203203
*
204-
* * **connect:delay** ZMQ_EVENT_CONNECT_DELAYED A connect request on the
204+
* * **connect:delay** - ZMQ_EVENT_CONNECT_DELAYED A connect request on the
205205
* socket is pending.
206206
*
207-
* * **connect:retry** ZMQ_EVENT_CONNECT_RETRIED A connection attempt is being
207+
* * **connect:retry** - ZMQ_EVENT_CONNECT_RETRIED A connection attempt is being
208208
* handled by reconnect timer. Note that the reconnect interval is
209209
* recalculated at each retry.
210210
*
211211
* The following additional details will be included with this event:
212212
*
213-
* * `interval` The current reconnect interval.
213+
* * `interval` - The current reconnect interval.
214214
*
215-
* * **close** ZMQ_EVENT_CLOSED The socket was closed.
215+
* * **close** - ZMQ_EVENT_CLOSED The socket was closed.
216216
*
217-
* * **close:error** ZMQ_EVENT_CLOSE_FAILED The socket close failed. Note that
217+
* * **close:error** - ZMQ_EVENT_CLOSE_FAILED The socket close failed. Note that
218218
* this event occurs **only on IPC** transports..
219219
*
220220
* The following additional details will be included with this event:
221221
*
222-
* * `error` An error object that describes the specific error
222+
* * `error` - An error object that describes the specific error
223223
* that occurred.
224224
*
225-
* * **disconnect** ZMQ_EVENT_DISCONNECTED The socket was disconnected
225+
* * **disconnect** - ZMQ_EVENT_DISCONNECTED The socket was disconnected
226226
* unexpectedly.
227227
*
228-
* * **handshake** ZMQ_EVENT_HANDSHAKE_SUCCEEDED The ZMTP security mechanism
228+
* * **handshake** - ZMQ_EVENT_HANDSHAKE_SUCCEEDED The ZMTP security mechanism
229229
* handshake succeeded. NOTE: This event may still be in DRAFT statea and not
230230
* yet available in stable releases.
231231
*
232-
* * **handshake:error:protocol** ZMQ_EVENT_HANDSHAKE_FAILED_PROTOCOL The ZMTP
232+
* * **handshake:error:protocol** - ZMQ_EVENT_HANDSHAKE_FAILED_PROTOCOL The ZMTP
233233
* security mechanism handshake failed due to some mechanism protocol error,
234234
* either between the ZMTP mechanism peers, or between the mechanism server
235235
* and the ZAP handler. This indicates a configuration or implementation error
236236
* in either peer resp. the ZAP handler. NOTE: This event may still be in
237237
* DRAFT state and not yet available in stable releases.
238238
*
239-
* * **handshake:error:auth** ZMQ_EVENT_HANDSHAKE_FAILED_AUTH The ZMTP
239+
* * **handshake:error:auth** - ZMQ_EVENT_HANDSHAKE_FAILED_AUTH The ZMTP
240240
* security mechanism handshake failed due to an authentication failure. NOTE:
241241
* This event may still be in DRAFT state and not yet available in stable
242242
* releases.
243243
*
244-
* * **handshake:error:other** ZMQ_EVENT_HANDSHAKE_FAILED_NO_DETAIL
244+
* * **handshake:error:other** - ZMQ_EVENT_HANDSHAKE_FAILED_NO_DETAIL
245245
* Unspecified error during handshake. NOTE: This event may still be in DRAFT
246246
* state and not yet available in stable releases.
247247
*
248-
* * **end** ZMQ_EVENT_MONITOR_STOPPED Monitoring on this socket ended.
248+
* * **end** - ZMQ_EVENT_MONITOR_STOPPED Monitoring on this socket ended.
249249
*
250250
* * **unknown** An event was generated by ZeroMQ that the Node.js library could
251251
* not interpret. Please submit a pull request for new event types if they are

0 commit comments

Comments
 (0)