@types/k6 0.47.3 → 0.48.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
k6/ws.d.ts CHANGED
@@ -2,7 +2,7 @@ import { CookieJar } from "./http";
2
2
 
3
3
  /**
4
4
  * Open WebSocket connection.
5
- * https://k6.io/docs/javascript-api/k6-ws/connect-url-params-callback/
5
+ * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/connect/
6
6
  * @param url - Request URL.
7
7
  * @param callback - Logic to execute with socket.
8
8
  * @returns HTTP response to connection request.
@@ -18,7 +18,7 @@ export function connect(url: string, callback: Executor): Response;
18
18
 
19
19
  /**
20
20
  * Open WebSocket connection.
21
- * https://k6.io/docs/javascript-api/k6-ws/connect-url-params-callback/
21
+ * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/connect/
22
22
  * @param url - Request URL.
23
23
  * @param params - Request parameters.
24
24
  * @param callback - Logic to execute with socket.
@@ -95,14 +95,14 @@ export interface Response {
95
95
 
96
96
  /**
97
97
  * Created socket.
98
- * https://k6.io/docs/javascript-api/k6-ws/socket/
98
+ * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/socket/
99
99
  */
100
100
  export abstract class Socket {
101
101
  protected __brand: never;
102
102
 
103
103
  /**
104
104
  * Close connection.
105
- * https://k6.io/docs/javascript-api/k6-ws/socket/socket-close/
105
+ * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/socket/socket-close/
106
106
  * @param code - WebSocket status code.
107
107
  * @example
108
108
  * socket.close();
@@ -111,7 +111,7 @@ export abstract class Socket {
111
111
 
112
112
  /**
113
113
  * Listen to event.
114
- * https://k6.io/docs/javascript-api/k6-ws/socket/socket-on-event-callback/
114
+ * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/socket/socket-on/
115
115
  * @param event - Event type.
116
116
  * @param handler - Event handler.
117
117
  * @example
@@ -126,7 +126,7 @@ export abstract class Socket {
126
126
 
127
127
  /**
128
128
  * Send ping.
129
- * https://k6.io/docs/javascript-api/k6-ws/socket/socket-ping/
129
+ * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/socket/socket-ping/
130
130
  * @example
131
131
  * socket.ping();
132
132
  */
@@ -134,7 +134,7 @@ export abstract class Socket {
134
134
 
135
135
  /**
136
136
  * Send data.
137
- * https://k6.io/docs/javascript-api/k6-ws/socket/socket-send-data/
137
+ * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/socket/socket-send/
138
138
  * @param data - Data to send.
139
139
  * @example
140
140
  * socket.send(JSON.stringify({ data: 'hola' }));
@@ -162,7 +162,7 @@ export abstract class Socket {
162
162
 
163
163
  /**
164
164
  * Call a function repeatedly, while the WebSocket connection is open.
165
- * https://k6.io/docs/javascript-api/k6-ws/socket/socket-setinterval-callback-interval/
165
+ * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/socket/socket-setinterval/
166
166
  * @param handler - The function to call every `interval` milliseconds.
167
167
  * @param interval - Milliseconds between two calls to `callback`.
168
168
  * @example
@@ -176,7 +176,7 @@ export abstract class Socket {
176
176
  /**
177
177
  * Call a function at a later time,
178
178
  * if the WebSocket connection is still open then.
179
- * https://k6.io/docs/javascript-api/k6-ws/socket/socket-settimeout-callback-delay/
179
+ * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/socket/socket-settimeout/
180
180
  * @param handler - The function to call when `delay` has expired.
181
181
  * @param delay - Delay in milliseconds.
182
182
  * @example
@@ -282,12 +282,12 @@ export abstract class WebSocketError {
282
282
 
283
283
  /**
284
284
  * This module provides a WebSocket client implementing the WebSocket protocol.
285
- * https://k6.io/docs/javascript-api/k6-ws/
285
+ * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/
286
286
  */
287
287
  declare namespace ws {
288
288
  /**
289
289
  * Open WebSocket connection.
290
- * https://k6.io/docs/javascript-api/k6-ws/connect-url-params-callback/
290
+ * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/connect/
291
291
  * @param url - Request URL.
292
292
  * @param callback - Logic to execute with socket.
293
293
  * @returns HTTP response to connection request.
@@ -303,7 +303,7 @@ declare namespace ws {
303
303
 
304
304
  /**
305
305
  * Open WebSocket connection.
306
- * https://k6.io/docs/javascript-api/k6-ws/connect-url-params-callback/
306
+ * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/connect/
307
307
  * @param url - Request URL.
308
308
  * @param params - Request parameters.
309
309
  * @param callback - Logic to execute with socket.