Class AccountInformation

Base abstract class for JSON requests.

Data: The type returned from the do() method

Body: The structure of the response's body

Hierarchy

JSONRequest
- AccountInformation

Index

Constructors

constructor

new AccountInformation(c: HTTPClient, intDecoding: IntDecoding, account: string): AccountInformation
Parameters
- c: HTTPClient
- intDecoding: IntDecoding
- account: string
Returns AccountInformation
Overrides JSONRequest.constructor
- Defined in client/v2/algod/accountInformation.ts:6

Properties

c

c: HTTPClient

intDecoding

intDecoding: IntDecoding

query

query: Record<string, any>

JSONRequest Methods

do

do(headers?: Record<string, any>): Promise<Record<string, any>>
Execute the request.

Returns
A promise which resolves to the parsed response data.
Parameters
- headers: Record<string, any> = {}
  
  Additional headers to send in the request. Optional.
Returns Promise<Record<string, any>>
Inherited from JSONRequest.do
- Defined in client/v2/jsonrequest.ts:56

doRaw

doRaw(headers?: Record<string, any>): Promise<Uint8Array>
Execute the request, but do not process the response data in any way.

Returns
A promise which resolves to the raw response data, exactly as returned by the server.
Parameters
- headers: Record<string, any> = {}
  
  Additional headers to send in the request. Optional.
Returns Promise<Uint8Array>
Inherited from JSONRequest.doRaw
- Defined in client/v2/jsonrequest.ts:71

prepare

prepare(body: Uint8Array | Record<string, any>): Record<string, any>
Prepare a JSON response before returning it.

Use this method to change and restructure response data as needed after receiving it from the do() method.
Parameters
- body: Uint8Array | Record<string, any>
  
  Response body received
Returns Record<string, any>
Inherited from JSONRequest.prepare
- Defined in client/v2/jsonrequest.ts:46

setIntDecoding

setIntDecoding(method: IntDecoding): AccountInformation
Configure how integers in this request's JSON response will be decoded.

The options are:
- "default": Integers will be decoded according to JSON.parse, meaning they will all be Numbers and any values greater than Number.MAX_SAFE_INTEGER will lose precision.
- "safe": All integers will be decoded as Numbers, but if any values are greater than Number.MAX_SAFE_INTEGER an error will be thrown.
- "mixed": Integers will be decoded as Numbers if they are less than or equal to Number.MAX_SAFE_INTEGER, otherwise they will be decoded as BigInts.
- "bigint": All integers will be decoded as BigInts.
Parameters
- method: IntDecoding
  
  The method to use when parsing the response for this request. Must be one of "default", "safe", "mixed", or "bigint".
Returns AccountInformation
Inherited from JSONRequest.setIntDecoding
- Defined in client/v2/jsonrequest.ts:92

Other Methods

path

path(): string
Returns
The path of this request.

Returns string
Overrides JSONRequest.path
- Defined in client/v2/algod/accountInformation.ts:15

query Methods

exclude

exclude(exclude: string): AccountInformation

Exclude assets and application data from results

Example

const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
const accountInfo = await algodClient.accountInformation(address)
       .exclude('all')
       .do();

Parameters

exclude: string

Class AccountInformation

Hierarchy

Index

Constructors

Properties

Methods - JSONRequest

Methods - Other

Methods - query

Constructors

constructor

Parameters

c: HTTPClient

intDecoding: IntDecoding

account: string

Returns AccountInformation

Properties

c

intDecoding

query

JSONRequest Methods

do

Returns

Parameters

headers: Record<string, any> = {}

Returns Promise<Record<string, any>>

doRaw

Returns

Parameters

headers: Record<string, any> = {}

Returns Promise<Uint8Array>

prepare

Parameters

body: Uint8Array | Record<string, any>

Returns Record<string, any>

setIntDecoding

Parameters

method: IntDecoding

Returns AccountInformation

Other Methods

path

Returns

Returns string

query Methods

exclude

Example

Parameters

exclude: string

Returns AccountInformation

Settings

Member Visibility

Theme