Interface: PaginatedOperation<Request, JSONRequest, Response, JSONResult>

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

Interface: PaginatedOperation<Request, JSONRequest, Response, JSONResult>

@moralisweb3/common-core.PaginatedOperation

Type parameters

Name	Type
Request	extends PaginatedRequest
JSONRequest	JSONRequest
Response	Response
JSONResult	JSONResult

Hierarchy

• Operation<Request, JSONRequest, Response, PaginatedJSONResponse<JSONResult>>

  ↳ 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[]

Inherited from

Operation.bodyParamNames

---

bodyType

• Optional bodyType: OperationBodyType

Inherited from

Operation.bodyType

---

firstPageIndex

• firstPageIndex: number

Overrides

Operation.firstPageIndex

---

groupName

• groupName: string

Inherited from

Operation.groupName

---

id

• id: string

Inherited from

Operation.id

---

isNullable

• Optional isNullable: boolean

Inherited from

Operation.isNullable

---

method

• method: OperationRequestMethod

Inherited from

Operation.method

---

name

• name: string

Inherited from

Operation.name

---

urlPathParamNames

• Optional urlPathParamNames: keyof Request[]

Inherited from

Operation.urlPathParamNames

---

urlPathPattern

• urlPathPattern: string

Inherited from

Operation.urlPathPattern

---

urlSearchParamNames

• Optional urlSearchParamNames: keyof Request[]

Inherited from

Operation.urlSearchParamNames

Methods

deserializeRequest

▸ deserializeRequest(jsonRequest, core): Request

Parameters

Name	Type
jsonRequest	JSONRequest
core	Core

Returns

Request

Inherited from

Operation.deserializeRequest

---

deserializeResponse

▸ deserializeResponse(jsonResponse, request, core): Response

Parameters

Name	Type
jsonResponse	PaginatedJSONResponse<JSONResult>
request	Request
core	Core

Returns

Response

Inherited from

Operation.deserializeResponse

---

getRequestBody

▸ Optional getRequestBody(request, core): OperationRequestBody

Parameters

Name	Type
request	Request
core	Core

Returns

OperationRequestBody

Inherited from

Operation.getRequestBody

---

getRequestUrlParams

▸ getRequestUrlParams(request, core): OperationRequestUrlParams

Parameters

Name	Type
request	Request
core	Core

Returns

OperationRequestUrlParams

Inherited from

Operation.getRequestUrlParams

---

serializeRequest

▸ serializeRequest(request, core): JSONRequest

Parameters

Name	Type
request	Request
core	Core

Returns

JSONRequest

Inherited from

Operation.serializeRequest