Class OINODbApiRequest

Hierarchy

OINOHttpRequest
- OINODbApiRequest

Index

Constructors

Properties

body etags? headers lastModified? method multipartBoundary? params? requestType responseType rowData rowId sqlParams url?

Methods

bodyAsBuffer bodyAsFormData bodyAsParsedJson bodyAsText fromFetchRequest

Constructors

constructor

new OINODbApiRequest(init: OINODbApiRequestInit): OINODbApiRequest
Parameters
- init: OINODbApiRequestInit
Returns OINODbApiRequest
Overrides OINOHttpRequest.constructor
- Defined in db/src/OINODbApi.ts:28

Properties

`Readonly`body

body: string | object | Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>

`Optional` `Readonly`etags

etags?: string[]

`Readonly`headers

headers: OINOHeaders

`Optional` `Readonly`lastModified

lastModified?: number

`Readonly`method

method: string

`Optional` `Readonly`multipartBoundary

multipartBoundary?: string

`Optional`params

params?: Record<string, string>

Key-value parameters

`Readonly`requestType

requestType: OINOContentType

`Readonly`responseType

responseType: OINOContentType

`Readonly`rowData

rowData:
    | string
    | object
    | OINODataRow[]
    | Buffer<ArrayBufferLike>
    | Uint8Array<ArrayBufferLike>

`Readonly`rowId

rowId: string

`Readonly`sqlParams

sqlParams: OINODbSqlParams

`Optional` `Readonly`url

url?: URL

Methods

bodyAsBuffer

bodyAsBuffer(): Buffer
Returns the request data as Buffer.

Returns Buffer
Inherited from OINOHttpRequest.bodyAsBuffer
- Defined in common/dist/types/OINORequest.d.ts:78

bodyAsFormData

bodyAsFormData(): URLSearchParams
Returns the request data as URLSearchParams (form data).

Returns URLSearchParams
Inherited from OINOHttpRequest.bodyAsFormData
- Defined in common/dist/types/OINORequest.d.ts:73

bodyAsParsedJson

bodyAsParsedJson(): any
Returns the request data parsed as JSON object.

Returns any
Inherited from OINOHttpRequest.bodyAsParsedJson
- Defined in common/dist/types/OINORequest.d.ts:68

bodyAsText

bodyAsText(): string
Returns the request data as a text string.

Returns string
Inherited from OINOHttpRequest.bodyAsText
- Defined in common/dist/types/OINORequest.d.ts:63

`Static`fromFetchRequest

fromFetchRequest(request: Request): Promise<OINODbApiRequest>
Creates a OINOHttpRequest from a Fetch API Request object.
Parameters
- request: Request
  Fetch request
Returns Promise<OINODbApiRequest>
Overrides OINOHttpRequest.fromFetchRequest
- Defined in db/src/OINODbApi.ts:100