@gala-chain/api • Readme | API

---

@gala-chain/api / GalaChainResponse

Class: abstract GalaChainResponse\<T>

Extended by

• GalaChainErrorResponse
• GalaChainSuccessResponse

Type parameters

• T

Constructors

new GalaChainResponse()

new GalaChainResponse\<T>(): GalaChainResponse\<T>

Returns

GalaChainResponse\<T>

Properties

Data?

optional readonly Data: T

Source

chain-api/src/types/contract.ts:31

---

ErrorCode?

optional readonly ErrorCode: number

Source

chain-api/src/types/contract.ts:28

---

ErrorKey?

optional readonly ErrorKey: string

Source

chain-api/src/types/contract.ts:29

---

ErrorPayload?

optional readonly ErrorPayload: unknown

Source

chain-api/src/types/contract.ts:30

---

Message?

optional readonly Message: string

Source

chain-api/src/types/contract.ts:27

---

Status

readonly Status: GalaChainResponseType

Source

chain-api/src/types/contract.ts:26

Methods

Error()

Error(e)

static Error\<T>(e): GalaChainResponse\<T>

Type parameters

• T

Parameters

• e

• e.message?: string

Returns

GalaChainResponse\<T>

Source

chain-api/src/types/contract.ts:35

Error(e)

static Error\<T>(e): GalaChainResponse\<T>

Type parameters

• T

Parameters

• e: ChainError

Returns

GalaChainResponse\<T>

Source

chain-api/src/types/contract.ts:36

Error(Message, ErrorCode, ErrorKey, ErrorPayload)

static Error\<T>(Message, ErrorCode, ErrorKey, ErrorPayload?): GalaChainResponse\<T>

Type parameters

• T

Parameters

• Message: string

• ErrorCode: number

• ErrorKey: string

• ErrorPayload?: Record\<string, unknown>

Returns

GalaChainResponse\<T>

Source

chain-api/src/types/contract.ts:37

---

Success()

static Success\<T>(Data): GalaChainResponse\<T>

Type parameters

• T

Parameters

• Data: T

Returns

GalaChainResponse\<T>

Source

chain-api/src/types/contract.ts:32

---

Wrap()

static Wrap\<T>(op): Promise\<GalaChainResponse\<T>>

Type parameters

• T

Parameters

• op: Promise\<T>

Returns

Promise\<GalaChainResponse\<T>>

Source

chain-api/src/types/contract.ts:57

---

deserialize()

static deserialize\<T>(constructor, object): GalaChainResponse\<T>

Type parameters

• T

Parameters

• constructor: undefined | ClassConstructor\<Inferred\<T>>

• object: string | Record\<string, unknown>

Returns

GalaChainResponse\<T>

Source

chain-api/src/types/contract.ts:71

---

isError()

static isError\<T>(r): r is GalaChainErrorResponse<T>

Type parameters

• T

Parameters

• r: GalaChainResponse\<T>

Returns

r is GalaChainErrorResponse<T>

Source

chain-api/src/types/contract.ts:67

---

isSuccess()

static isSuccess\<T>(r): r is GalaChainSuccessResponse<T>

Type parameters

• T

Parameters

• r: GalaChainResponse\<T>

Returns

r is GalaChainSuccessResponse<T>

Source

chain-api/src/types/contract.ts:63