Interface: Response

Represents the format of a standard response from a Synapse API

Hierarchy

• Response

Index

Properties

• message
• payload
• query
• status
• type

Properties

message

• message: string

Defined in lib/client/Client.ts:4

A message describing the response.

---

payload

• payload: any

Defined in lib/client/Client.ts:6

The state of the requested resource.

---

query

• query: string

Defined in lib/client/Client.ts:8

The normalized query string that uniquely represents the request.

---

status

• status: number

Defined in lib/client/Client.ts:10

The HTTP status code of the response.

---

type

• type: string

Defined in lib/client/Client.ts:12

The class name of the requested resource. All responses from a Synapse API are objects that derive from State.