Document us_socket_local_port

This commit is contained in:
alexhultman-2fa 2021-06-09 11:15:48 +02:00 committed by GitHub
parent 9b3efbdfa3
commit 8591a224cf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

12
docs/index.d.ts vendored
View file

@ -12,13 +12,20 @@
* limitations under the License. * limitations under the License.
*/ */
/** Native type representing a raw uSockets struct us_listen_socket. /** Native type representing a raw uSockets struct us_listen_socket_t.
* Careful with this one, it is entirely unchecked and native so invalid usage will blow up. * Careful with this one, it is entirely unchecked and native so invalid usage will blow up.
*/ */
export interface us_listen_socket { export interface us_listen_socket {
} }
/** Native type representing a raw uSockets struct us_socket_t.
* Careful with this one, it is entirely unchecked and native so invalid usage will blow up.
*/
export interface us_socket {
}
/** Native type representing a raw uSockets struct us_socket_context_t. /** Native type representing a raw uSockets struct us_socket_context_t.
* Used while upgrading a WebSocket manually. */ * Used while upgrading a WebSocket manually. */
export interface us_socket_context_t { export interface us_socket_context_t {
@ -312,6 +319,9 @@ export function SSLApp(options: AppOptions): TemplatedApp;
/** Closes a uSockets listen socket. */ /** Closes a uSockets listen socket. */
export function us_listen_socket_close(listenSocket: us_listen_socket): void; export function us_listen_socket_close(listenSocket: us_listen_socket): void;
/** Gets local port of socket (or listenSocket) or -1. */
export function us_socket_local_port(socket: us_socket): number;
export interface MultipartField { export interface MultipartField {
data: ArrayBuffer; data: ArrayBuffer;
name: string; name: string;