Skip to content

Commit a0199a6

Browse files
committed
docs: fix the typeParams in the docs
1 parent 423b7fe commit a0199a6

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

src/index.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ export type MessageLike =
5151
/**
5252
* Describes sockets that can send messages.
5353
*
54-
* @typeparam M The type of the message or message parts that can be sent.
55-
* @typeparam O Rest type for any options, if applicable to the socket type
54+
* @typeParam M The type of the message or message parts that can be sent.
55+
* @typeParam O Rest type for any options, if applicable to the socket type
5656
* (DRAFT only).
5757
*/
5858
export interface Writable<
@@ -176,7 +176,7 @@ type ReceiveType<T> = T extends {receive(): Promise<infer U>} ? U : never
176176
/**
177177
* Describes sockets that can receive messages.
178178
*
179-
* @typeparam M The type of the message or message parts that can be read.
179+
* @typeParam M The type of the message or message parts that can be read.
180180
*/
181181
export interface Readable<M extends object[] = Message[]> {
182182
/**
@@ -269,7 +269,7 @@ export interface Readable<M extends object[] = Message[]> {
269269
* socket type, for example `new Dealer({...})`. Readonly options
270270
* for the particular socket will be omitted.
271271
*
272-
* @typeparam S The socket type to which the options should be applied.
272+
* @typeParam S The socket type to which the options should be applied.
273273
*/
274274
export type SocketOptions<S extends Socket> = Options<S, {context: Context}>
275275

src/native.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ export type EventType = Event["type"]
279279
* Represents the event data object given one particular event type, for example
280280
* `EventOfType<"accept">`.
281281
*
282-
* @typeparam E The specific event type.
282+
* @typeParam E The specific event type.
283283
*/
284284
export type EventOfType<E extends EventType = EventType> = Expand<
285285
Extract<Event, Event & EventFor<E>>
@@ -365,8 +365,8 @@ export declare class Observer {
365365
* [Review the ØMQ documentation](http://api.zeromq.org/4-3:zmq-proxy#toc3) for
366366
* an overview of some example applications of a proxy.
367367
*
368-
* @typeparam F The front-end socket type.
369-
* @typeparam B The back-end socket type.
368+
* @typeParam F The front-end socket type.
369+
* @typeParam B The back-end socket type.
370370
*/
371371
export declare class Proxy<
372372
F extends Socket = Socket,

0 commit comments

Comments
 (0)