Class OINOApiRequest

Specialized result for HTTP responses.

Hierarchy (View Summary)

OINOHttpRequest
- OINOApiRequest

Index

Constructors

constructor

new OINOApiRequest(init: OINOApiRequestInit): OINOApiRequest
Parameters
- init: OINOApiRequestInit
Returns OINOApiRequest
Overrides OINOHttpRequest.constructor
- Defined in common/src/OINOApi.ts:70

Properties

body

body: OINOHttpData

`Optional`etags

etags?: string[]

headers

headers: OINOHeaders

`Optional`lastModified

lastModified?: number

method

method: string

`Optional`multipartBoundary

multipartBoundary?: string

`Optional`params

params?: Record<string, string>

Key-value parameters

queryParams

queryParams: OINOQueryParams

requestType

requestType: OINOContentType

`Optional`responseDownload

responseDownload?: string

responseType

responseType: OINOContentType

rowData

rowData: OINOApiData

rowId

rowId: string

`Optional`url

url?: URL

Methods

bodyAsBuffer

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

Returns Buffer
Inherited from OINOHttpRequest.bodyAsBuffer
- Defined in common/src/OINORequest.ts:186

bodyAsFormData

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

Returns URLSearchParams
Inherited from OINOHttpRequest.bodyAsFormData
- Defined in common/src/OINORequest.ts:178

bodyAsParsedJson

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

Returns any
Inherited from OINOHttpRequest.bodyAsParsedJson
- Defined in common/src/OINORequest.ts:170

bodyAsText

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

Returns string
Inherited from OINOHttpRequest.bodyAsText
- Defined in common/src/OINORequest.ts:151

`Static`fromFetchRequest

fromFetchRequest(
    request: Request,
    rowId?: string,
    rowData?: OINOApiData,
    queryParams?: OINOQueryParams,
): Promise<OINOApiRequest>
Creates a OINOHttpRequest from a Fetch API Request object.
Parameters
- request: Request
  Fetch request
- OptionalrowId: string
- OptionalrowData: OINOApiData
- OptionalqueryParams: OINOQueryParams
Returns Promise<OINOApiRequest>
Overrides OINOHttpRequest.fromFetchRequest
- Defined in common/src/OINOApi.ts:147

`Static`fromHttpRequest

fromHttpRequest(
    request: OINOHttpRequest,
    rowId?: string,
    rowData?: OINOApiData,
    queryParams?: OINOQueryParams,
): OINOApiRequest
Parameters
- request: OINOHttpRequest
- OptionalrowId: string
- OptionalrowData: OINOApiData
- OptionalqueryParams: OINOQueryParams
Returns OINOApiRequest
- Defined in common/src/OINOApi.ts:158