uws-connect
Version:
Use connect like middlewares with uWebSockets.js
66 lines (65 loc) • 1.81 kB
TypeScript
/** @typedef {import('node:stream').ReadableOptions} ReadableOptions */
/** @typedef {import('uWebSockets.js').HttpRequest} uWs.HttpRequest */
/** @typedef {import('uWebSockets.js').HttpResponse} uWs.HttpResponse */
/**
* @typedef {ReadableOptions} ReadableOptionsExt
* @property {'http'|'https'} protocol
*/
export class Request extends Readable {
/**
* @param {uWs.HttpResponse} uwsRes
* @param {uWs.HttpRequest} uwsReq
* @param {ReadableOptionsExt} [options]
*/
constructor(uwsRes: uWs.HttpResponse, uwsReq: uWs.HttpRequest, options?: import("stream").ReadableOptions | undefined);
_uwsReq: import("uWebSockets.js").HttpRequest;
_uwsRes: import("uWebSockets.js").HttpResponse;
headers: {};
params: {};
/** @type {'http'|'https'} */
protocol: "http" | "https";
method: string;
connection: {};
socket: {};
set url(newUrl: any);
/**
* request url
*/
get url(): any;
_url: any;
/**
* request query
*
* uses URLSearchParams for query string parsing
*
* @returns {object}
*/
get query(): any;
/**
* get parsed cookies
* @returns {object}
*/
get cookies(): any;
_read(_size: any): void;
/**
* pauses stream
*/
pause(): this;
/**
* resumes stream
*/
resume(): this;
/**
* get `uWs.HttpRequest.getParameter()`
* @param {number} index
* @returns {string}
*/
getParameter(index: number): string;
}
export type ReadableOptions = import("node:stream").ReadableOptions;
export namespace uWs {
type HttpRequest = import("uWebSockets.js").HttpRequest;
type HttpResponse = import("uWebSockets.js").HttpResponse;
}
export type ReadableOptionsExt = ReadableOptions;
import { Readable } from 'stream';