_esp32_javascript_modules_esp32_javascript_http_.md

esp32-javascript › "esp32-javascript/modules/esp32-javascript/http"

Module: "esp32-javascript/modules/esp32-javascript/http"

Index

Classes

• EventEmitter
• XMLHttpRequest

Interfaces

• Esp32JsRequest
• Esp32JsResponse

Variables

• closeSocket
• sockConnect
• sockListen
• socketEvents

Functions

• decodeQueryParam
• getDefaultPort
• httpClient
• httpServer
• parseHeaders
• parseQueryStr

Variables

Const closeSocket

• closeSocket: closeSocket = socketEvents.closeSocket

Defined in esp32-javascript/modules/esp32-javascript/http.ts:53

---

Const sockConnect

• sockConnect: sockConnect = socketEvents.sockConnect

Defined in esp32-javascript/modules/esp32-javascript/http.ts:52

---

Const sockListen

• sockListen: sockListen = socketEvents.sockListen

Defined in esp32-javascript/modules/esp32-javascript/http.ts:51

---

socketEvents

• socketEvents: "socket-events/modules/socket-events/index"

Defined in esp32-javascript/modules/esp32-javascript/http.ts:24

Functions

decodeQueryParam

▸ decodeQueryParam(value: string): string

Defined in esp32-javascript/modules/esp32-javascript/http.ts:394

Parameters:

Name	Type
value	string

Returns: string

---

getDefaultPort

▸ getDefaultPort(url: object): number

Defined in esp32-javascript/modules/esp32-javascript/http.ts:549

Parameters:

▪ url: object

Name	Type
port	string
protocol	string

Returns: number

---

httpClient

▸ httpClient(ssl: boolean, host: string, port: string, path: string, method: string, requestHeaders?: undefined | string, body?: undefined | object, successCB?: undefined, errorCB?: undefined | function, finishCB?: undefined | function, dataCB?: undefined | function, headCB?: undefined | function): object

Defined in esp32-javascript/modules/esp32-javascript/http.ts:411

Parameters:

Name	Type
ssl	boolean
host	string
port	string
path	string
method	string
requestHeaders?	undefined | string
body?	undefined | object
successCB?	undefined
errorCB?	undefined | function
finishCB?	undefined | function
dataCB?	undefined | function
headCB?	undefined | function

Returns: object

• cancel(): function

  • (): void

• cancelled: boolean

---

httpServer

▸ httpServer(port: string | number, isSSL: boolean, cb: function): void

Defined in esp32-javascript/modules/esp32-javascript/http.ts:90

Parameters:

▪ port: string | number

▪ isSSL: boolean

▪ cb: function

▸ (req: Esp32JsRequest, res: Esp32JsResponse): void

Parameters:

Name	Type
req	Esp32JsRequest
res	Esp32JsResponse

Returns: void

---

parseHeaders

▸ parseHeaders(complete: StringBuffer, endOfHeaders: number): object

Defined in esp32-javascript/modules/esp32-javascript/http.ts:55

Parameters:

Name	Type
complete	StringBuffer
endOfHeaders	number

Returns: object

• headers: Headers

• statusLine: undefined | string

---

parseQueryStr

▸ parseQueryStr(query: string | null): object

Defined in esp32-javascript/modules/esp32-javascript/http.ts:398

Parameters:

Name	Type
query	string | null

Returns: object

• [ key: string]: string