ApiEndpoint
Defined in: wp-typia-rest/src/client.ts:80
WordPress REST endpoint contract with request and response validators.
Remarks
Section titled “Remarks”Use this contract when integrating with @wordpress/api-fetch or the React
helpers from @wp-typia/rest/react.
Type Parameters
Section titled “Type Parameters”Req
Res
Properties
Section titled “Properties”buildRequestOptions?
Section titled “buildRequestOptions?”
optionalbuildRequestOptions?: (request) =>Partial<APIFetchOptions>
Defined in: wp-typia-rest/src/client.ts:81
Parameters
Section titled “Parameters”request
Section titled “request”Req
Returns
Section titled “Returns”Partial<APIFetchOptions>
method
Section titled “method”method:
"DELETE"|"GET"|"PATCH"|"POST"|"PUT"
Defined in: wp-typia-rest/src/client.ts:82
path:
string
Defined in: wp-typia-rest/src/client.ts:83
requestLocation?
Section titled “requestLocation?”
optionalrequestLocation?:"query"|"body"|"query-and-body"
Defined in: wp-typia-rest/src/client.ts:84
validateRequest
Section titled “validateRequest”validateRequest: (
input) =>ValidationResult<Req>
Defined in: wp-typia-rest/src/client.ts:85
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”ValidationResult<Req>
validateResponse
Section titled “validateResponse”validateResponse: (
input) =>ValidationResult<Res>
Defined in: wp-typia-rest/src/client.ts:86
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”ValidationResult<Res>