Interface: Operation<Request, JSONRequest, Response, JSONResponse>

moralis-monorepo / @moralisweb3/common-core / Operation

Interface: Operation<Request, JSONRequest, Response, JSONResponse>

@moralisweb3/common-core.Operation

Type parameters

Name
Request
JSONRequest
Response
JSONResponse

Hierarchy

• Operation

  ↳ PaginatedOperation

Table of contents

Properties

• bodyParamNames
• bodyType
• firstPageIndex
• groupName
• id
• isNullable
• method
• name
• urlPathParamNames
• urlPathPattern
• urlSearchParamNames

Methods

• deserializeRequest
• deserializeResponse
• getRequestBody
• getRequestUrlParams
• serializeRequest

Properties

bodyParamNames

• Optional bodyParamNames: keyof Request[]

---

bodyType

• Optional bodyType: OperationBodyType

---

firstPageIndex

• Optional firstPageIndex: number

---

groupName

• groupName: string

---

id

• id: string

---

isNullable

• Optional isNullable: boolean

---

method

• method: OperationRequestMethod

---

name

• name: string

---

urlPathParamNames

• Optional urlPathParamNames: keyof Request[]

---

urlPathPattern

• urlPathPattern: string

---

urlSearchParamNames

• Optional urlSearchParamNames: keyof Request[]

Methods

deserializeRequest

▸ deserializeRequest(jsonRequest, core): Request

Parameters

Name	Type
jsonRequest	JSONRequest
core	Core

Returns

Request

---

deserializeResponse

▸ deserializeResponse(jsonResponse, request, core): Response

Parameters

Name	Type
jsonResponse	JSONResponse
request	Request
core	Core

Returns

Response

---

getRequestBody

▸ Optional getRequestBody(request, core): OperationRequestBody

Parameters

Name	Type
request	Request
core	Core

Returns

OperationRequestBody

---

getRequestUrlParams

▸ getRequestUrlParams(request, core): OperationRequestUrlParams

Parameters

Name	Type
request	Request
core	Core

Returns

OperationRequestUrlParams

---

serializeRequest

▸ serializeRequest(request, core): JSONRequest

Parameters

Name	Type
request	Request
core	Core

Returns

JSONRequest