|
| 1 | +export type RecognizedString = |
| 2 | + | string |
| 3 | + | ArrayBuffer |
| 4 | + | Uint8Array |
| 5 | + | Int8Array |
| 6 | + | Uint16Array |
| 7 | + | Int16Array |
| 8 | + | Uint32Array |
| 9 | + | Int32Array |
| 10 | + | Float32Array |
| 11 | + | Float64Array; |
| 12 | + |
| 13 | +export interface HttpRequest { |
| 14 | + /** Returns the lowercased header value or empty string. */ |
| 15 | + getHeader(lowerCaseKey: RecognizedString): string; |
| 16 | + /** Returns the URL including initial /slash */ |
| 17 | + getUrl(): string; |
| 18 | + /** Returns the HTTP method, useful for "any" routes. */ |
| 19 | + getMethod(): string; |
| 20 | + /** Returns the raw querystring (the part of URL after ? sign) or empty string. */ |
| 21 | + getQuery(): string; |
| 22 | + /** Returns a decoded query parameter value or empty string. */ |
| 23 | + getQuery(key: string): string; |
| 24 | +} |
| 25 | + |
| 26 | +export interface HttpResponse { |
| 27 | + /** |
| 28 | + * Writes the HTTP status message such as "200 OK". |
| 29 | + * This has to be called first in any response, otherwise |
| 30 | + * it will be called automatically with "200 OK". |
| 31 | + * |
| 32 | + * If you want to send custom headers in a WebSocket |
| 33 | + * upgrade response, you have to call writeStatus with |
| 34 | + * "101 Switching Protocols" before you call writeHeader, |
| 35 | + * otherwise your first call to writeHeader will call |
| 36 | + * writeStatus with "200 OK" and the upgrade will fail. |
| 37 | + * |
| 38 | + * As you can imagine, we format outgoing responses in a linear |
| 39 | + * buffer, not in a hash table. You can read about this in |
| 40 | + * the user manual under "corking". |
| 41 | + */ |
| 42 | + writeStatus(status: RecognizedString): HttpResponse; |
| 43 | + /** |
| 44 | + * Writes key and value to HTTP response. |
| 45 | + * See writeStatus and corking. |
| 46 | + */ |
| 47 | + writeHeader(key: RecognizedString, value: RecognizedString): HttpResponse; |
| 48 | + /** Enters or continues chunked encoding mode. Writes part of the response. End with zero length write. Returns true if no backpressure was added. */ |
| 49 | + write(chunk: RecognizedString): boolean; |
| 50 | + /** Ends this response by copying the contents of body. */ |
| 51 | + end(body?: RecognizedString, closeConnection?: boolean): HttpResponse; |
| 52 | + /** Immediately force closes the connection. Any onAborted callback will run. */ |
| 53 | + close(): HttpResponse; |
| 54 | + /** |
| 55 | + * Every HttpResponse MUST have an attached abort handler IF you do not respond |
| 56 | + * to it immediately inside of the callback. Returning from an Http request handler |
| 57 | + * without attaching (by calling onAborted) an abort handler is ill-use and will terminate. |
| 58 | + * When this event emits, the response has been aborted and may not be used. |
| 59 | + */ |
| 60 | + onAborted(handler: () => void): HttpResponse; |
| 61 | + /** |
| 62 | + * Handler for reading data from POST and such requests. You MUST copy the |
| 63 | + * data of chunk if isLast is not true. We Neuter ArrayBuffers on return, |
| 64 | + * making it zero length. |
| 65 | + */ |
| 66 | + onData(handler: (chunk: ArrayBuffer, isLast: boolean) => void): HttpResponse; |
| 67 | + /** Returns the remote IP address as text. */ |
| 68 | + getRemoteAddressAsText(): ArrayBuffer; |
| 69 | + /** Corking a response is a performance improvement in both CPU and network, as you ready the IO system for writing multiple chunks at once. |
| 70 | + * By default, you're corked in the immediately executing top portion of the route handler. In all other cases, such as when returning from |
| 71 | + * await, or when being called back from an async database request or anything that isn't directly executing in the route handler, you'll want |
| 72 | + * to cork before calling writeStatus, writeHeader or just write. Corking takes a callback in which you execute the writeHeader, writeStatus and |
| 73 | + * such calls, in one atomic IO operation. This is important, not only for TCP but definitely for TLS where each write would otherwise result |
| 74 | + * in one TLS block being sent off, each with one send syscall. |
| 75 | + * |
| 76 | + * Example usage: |
| 77 | + * |
| 78 | + * res.cork(() => { |
| 79 | + * res.writeStatus("200 OK").writeHeader("Some", "Value").write("Hello world!"); |
| 80 | + * }); |
| 81 | + */ |
| 82 | + cork(cb: () => void): HttpResponse; |
| 83 | + /** Upgrades a HttpResponse to a WebSocket. See UpgradeAsync, UpgradeSync example files. */ |
| 84 | + upgrade<T>( |
| 85 | + userData: T, |
| 86 | + secWebSocketKey: RecognizedString, |
| 87 | + secWebSocketProtocol: RecognizedString, |
| 88 | + secWebSocketExtensions: RecognizedString, |
| 89 | + context: unknown, |
| 90 | + ): void; |
| 91 | + /** Arbitrary user data may be attached to this object */ |
| 92 | + [key: string]: any; |
| 93 | +} |
| 94 | + |
| 95 | +/** TemplatedApp is either an SSL or non-SSL app. See App for more info, read user manual. */ |
| 96 | +export interface TemplatedApp { |
| 97 | + /** Listens to hostname & port. Callback hands either false or a listen socket. */ |
| 98 | + listen(host: RecognizedString, port: number, cb: (listenSocket: unknown) => void): TemplatedApp; |
| 99 | + /** Registers an HTTP GET handler matching specified URL pattern. */ |
| 100 | + get(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void): TemplatedApp; |
| 101 | + /** Registers an HTTP POST handler matching specified URL pattern. */ |
| 102 | + post(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void): TemplatedApp; |
| 103 | + /** Registers an HTTP OPTIONS handler matching specified URL pattern. */ |
| 104 | + options(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void): TemplatedApp; |
| 105 | + /** Registers an HTTP DELETE handler matching specified URL pattern. */ |
| 106 | + del(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void): TemplatedApp; |
| 107 | + /** Registers an HTTP PATCH handler matching specified URL pattern. */ |
| 108 | + patch(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void): TemplatedApp; |
| 109 | + /** Registers an HTTP PUT handler matching specified URL pattern. */ |
| 110 | + put(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void): TemplatedApp; |
| 111 | + /** Registers an HTTP HEAD handler matching specified URL pattern. */ |
| 112 | + head(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void): TemplatedApp; |
| 113 | + /** Registers an HTTP CONNECT handler matching specified URL pattern. */ |
| 114 | + connect(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void): TemplatedApp; |
| 115 | + /** Registers an HTTP TRACE handler matching specified URL pattern. */ |
| 116 | + trace(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void): TemplatedApp; |
| 117 | + /** Registers an HTTP handler matching specified URL pattern on any HTTP method. */ |
| 118 | + any(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void): TemplatedApp; |
| 119 | + /** Registers a handler matching specified URL pattern where WebSocket upgrade requests are caught. */ |
| 120 | + ws(pattern: RecognizedString, behavior: WebSocketBehavior): TemplatedApp; |
| 121 | +} |
| 122 | + |
| 123 | +/** A structure holding settings and handlers for a WebSocket URL route handler. */ |
| 124 | +export interface WebSocketBehavior { |
| 125 | + /** Maximum length of received message. If a client tries to send you a message larger than this, the connection is immediately closed. Defaults to 16 * 1024. */ |
| 126 | + maxPayloadLength?: number; |
| 127 | + /** Maximum amount of seconds that may pass without sending or getting a message. Connection is closed if this timeout passes. Resolution (granularity) for timeouts are typically 4 seconds, rounded to closest. |
| 128 | + * Disable by using 0. Defaults to 120. |
| 129 | + */ |
| 130 | + idleTimeout?: number; |
| 131 | + /** What permessage-deflate compression to use. uWS.DISABLED, uWS.SHARED_COMPRESSOR or any of the uWS.DEDICATED_COMPRESSOR_xxxKB. Defaults to uWS.DISABLED. */ |
| 132 | + compression?: number; |
| 133 | + /** Maximum length of allowed backpressure per socket when publishing or sending messages. Slow receivers with too high backpressure will be skipped until they catch up or timeout. Defaults to 1024 * 1024. */ |
| 134 | + maxBackpressure?: number; |
| 135 | + /** Whether or not we should automatically send pings to uphold a stable connection given whatever idleTimeout. */ |
| 136 | + sendPingsAutomatically?: boolean; |
| 137 | + /** Upgrade handler used to intercept HTTP upgrade requests and potentially upgrade to WebSocket. |
| 138 | + * See UpgradeAsync and UpgradeSync example files. |
| 139 | + */ |
| 140 | + upgrade?: (res: HttpResponse, req: HttpRequest, context: unknown) => void; |
| 141 | + /** Handler for new WebSocket connection. WebSocket is valid from open to close, no errors. */ |
| 142 | + open?: (ws: WebSocket) => void; |
| 143 | + /** Handler for a WebSocket message. Messages are given as ArrayBuffer no matter if they are binary or not. Given ArrayBuffer is valid during the lifetime of this callback (until first await or return) and will be neutered. */ |
| 144 | + message?: (ws: WebSocket, message: ArrayBuffer, isBinary: boolean) => void; |
| 145 | + /** Handler for when WebSocket backpressure drains. Check ws.getBufferedAmount(). Use this to guide / drive your backpressure throttling. */ |
| 146 | + drain?: (ws: WebSocket) => void; |
| 147 | + /** Handler for close event, no matter if error, timeout or graceful close. You may not use WebSocket after this event. Do not send on this WebSocket from within here, it is closed. */ |
| 148 | + close?: (ws: WebSocket, code: number, message: ArrayBuffer) => void; |
| 149 | + /** Handler for received ping control message. You do not need to handle this, pong messages are automatically sent as per the standard. */ |
| 150 | + ping?: (ws: WebSocket, message: ArrayBuffer) => void; |
| 151 | + /** Handler for received pong control message. */ |
| 152 | + pong?: (ws: WebSocket, message: ArrayBuffer) => void; |
| 153 | +} |
| 154 | + |
| 155 | +/** A WebSocket connection that is valid from open to close event. |
| 156 | + * Read more about this in the user manual. |
| 157 | + */ |
| 158 | +export interface WebSocket { |
| 159 | + /** Sends a message. Returns 1 for success, 2 for dropped due to backpressure limit, and 0 for built up backpressure that will drain over time. You can check backpressure before or after sending by calling getBufferedAmount(). |
| 160 | + * |
| 161 | + * Make sure you properly understand the concept of backpressure. Check the backpressure example file. |
| 162 | + */ |
| 163 | + send(message: RecognizedString, isBinary?: boolean, compress?: boolean): number; |
| 164 | + /** Returns the bytes buffered in backpressure. This is similar to the bufferedAmount property in the browser counterpart. |
| 165 | + * Check backpressure example. |
| 166 | + */ |
| 167 | + getBufferedAmount(): number; |
| 168 | + /** Gracefully closes this WebSocket. Immediately calls the close handler. |
| 169 | + * A WebSocket close message is sent with code and shortMessage. |
| 170 | + */ |
| 171 | + end(code?: number, shortMessage?: RecognizedString): void; |
| 172 | + /** Forcefully closes this WebSocket. Immediately calls the close handler. |
| 173 | + * No WebSocket close message is sent. |
| 174 | + */ |
| 175 | + close(): void; |
| 176 | + /** Sends a ping control message. Returns sendStatus similar to WebSocket.send (regarding backpressure). This helper function correlates to WebSocket::send(message, uWS::OpCode::PING, ...) in C++. */ |
| 177 | + ping(message?: RecognizedString): number; |
| 178 | + /** Subscribe to a topic. */ |
| 179 | + subscribe(topic: RecognizedString): boolean; |
| 180 | + /** Unsubscribe from a topic. Returns true on success, if the WebSocket was subscribed. */ |
| 181 | + unsubscribe(topic: RecognizedString): boolean; |
| 182 | + /** Returns whether this websocket is subscribed to topic. */ |
| 183 | + isSubscribed(topic: RecognizedString): boolean; |
| 184 | + /** Returns a list of topics this websocket is subscribed to. */ |
| 185 | + getTopics(): string[]; |
| 186 | + /** Publish a message under topic. Backpressure is managed according to maxBackpressure, closeOnBackpressureLimit settings. |
| 187 | + * Order is guaranteed since v20. |
| 188 | + */ |
| 189 | + publish(topic: RecognizedString, message: RecognizedString, isBinary?: boolean, compress?: boolean): boolean; |
| 190 | + /** See HttpResponse.cork. Takes a function in which the socket is corked (packing many sends into one single syscall/SSL block) */ |
| 191 | + cork(cb: () => void): WebSocket; |
| 192 | + /** Returns the remote IP address. Note that the returned IP is binary, not text. |
| 193 | + * |
| 194 | + * IPv4 is 4 byte long and can be converted to text by printing every byte as a digit between 0 and 255. |
| 195 | + * IPv6 is 16 byte long and can be converted to text in similar ways, but you typically print digits in HEX. |
| 196 | + * |
| 197 | + * See getRemoteAddressAsText() for a text version. |
| 198 | + */ |
| 199 | + getRemoteAddress(): ArrayBuffer; |
| 200 | + /** Returns the remote IP address as text. See RecognizedString. */ |
| 201 | + getRemoteAddressAsText(): ArrayBuffer; |
| 202 | + /** Arbitrary user data may be attached to this object. In C++ this is done by using getUserData(). */ |
| 203 | + [key: string]: any; |
| 204 | +} |
0 commit comments