CompassApi
CompassRequests
api
compass-api
compound-types
graphql-types

Rate this page:

@atlassian/forge-graphql / compound-types / ApiPayload

Interface: ApiPayload<T>

compound-types.ApiPayload

Payload shape of requests in Toolkit

Type parameters

NameType
Tundefined

Properties

data

Optional data: T

Response data relevant to request

Defined in

compound-types.ts:215


errors

errors: SdkError[]

Collection of error details due to a failed request

Defined in

compound-types.ts:211


success

success: boolean

Status of whether or not the request was successful

Defined in

compound-types.ts:213

Rate this page: