Class ImplementationHttpContext`Abstract`

Index

Constructors

Properties

Methods

aborted clientIP clientPort compress compressionHeader getCompression getHeaders header method onBodyChunk path status type upgrade write writeFile

Constructors

constructor

new ImplementationHttpContext(): ImplementationHttpContext
Returns ImplementationHttpContext

Properties

`Private` compression

compression: null | CompressionAlgorithm = null

Methods

`Abstract` aborted

aborted(): AbortSignal
Returns AbortSignal
- Defined in src/types/implementation/contexts/http.ts:9

`Abstract` clientIP

clientIP(): string
Returns string
- Defined in src/types/implementation/contexts/http.ts:15

`Abstract` clientPort

clientPort(): number
Returns number
- Defined in src/types/implementation/contexts/http.ts:16

compress

compress(algorithm): this
Parameters
- algorithm: null | CompressionAlgorithm
Returns this
- Defined in src/types/implementation/contexts/http.ts:21

compressionHeader

compressionHeader(chunked): this
Parameters
- chunked: boolean
Returns this
- Defined in src/types/implementation/contexts/http.ts:31

getCompression

getCompression(): null | CompressionAlgorithm
Returns null | CompressionAlgorithm
- Defined in src/types/implementation/contexts/http.ts:27

`Abstract` getHeaders

getHeaders(): ValueCollection<string, string, string>
Returns ValueCollection<string, string, string>
- Defined in src/types/implementation/contexts/http.ts:18

`Abstract` header

header(key, value): this
Parameters
- key: string
- value: string
Returns this
- Defined in src/types/implementation/contexts/http.ts:41

`Abstract` method

method(): "CONNECT" | "TRACE" | "OPTIONS" | "DELETE" | "PATCH" | "HEAD" | "POST" | "PUT" | "GET"
Returns "CONNECT" | "TRACE" | "OPTIONS" | "DELETE" | "PATCH" | "HEAD" | "POST" | "PUT" | "GET"
- Defined in src/types/implementation/contexts/http.ts:12

`Abstract` onBodyChunk

onBodyChunk(callback): Promise<void>
Parameters
- callback: ((chunk, isLast) => Promise<any>)
  - - (chunk, isLast): Promise<any>
    - Parameters
      chunk: ArrayBuffer
      isLast: boolean
      Returns Promise<any>
Returns Promise<void>
- Defined in src/types/implementation/contexts/http.ts:19

`Abstract` path

path(): string
Returns string
- Defined in src/types/implementation/contexts/http.ts:13

`Abstract` status

status(code, message): this
Parameters
- code: number
- message: string
Returns this
- Defined in src/types/implementation/contexts/http.ts:40

`Abstract` type

type(): "http" | "ws"
Returns "http" | "ws"
- Defined in src/types/implementation/contexts/http.ts:11

`Abstract` upgrade

upgrade(data): boolean
Parameters
- data: ImplementationWebsocketData
Returns boolean
- Defined in src/types/implementation/contexts/http.ts:44

`Abstract` write

write(data): Promise<void>
Parameters
- data: ArrayBuffer | Readable
Returns Promise<void>
- Defined in src/types/implementation/contexts/http.ts:42

`Abstract` writeFile

writeFile(file, start?, end?): void
Parameters
- file: string
- Optional start: number
- Optional end: number
Returns void
- Defined in src/types/implementation/contexts/http.ts:43