AlgoHttpClientWithRetry
@algorandfoundation/algokit-utils / types/algo-http-client-with-retry / AlgoHttpClientWithRetry
types/algo-http-client-with-retry.AlgoHttpClientWithRetry
A HTTP Client that wraps the Algorand SDK HTTP Client with retries
Hierarchy
Section titled “Hierarchy”-
URLTokenBaseHTTPClient↳
AlgoHttpClientWithRetry
Table of contents
Section titled “Table of contents”Constructors
Section titled “Constructors”Properties
Section titled “Properties”Methods
Section titled “Methods”Constructors
Section titled “Constructors”constructor
Section titled “constructor”• new AlgoHttpClientWithRetry(tokenHeader, baseServer, port?, defaultHeaders?): AlgoHttpClientWithRetry
Parameters
Section titled “Parameters”| Name | Type |
|---|---|
tokenHeader | TokenHeader |
baseServer | string |
port? | string | number |
defaultHeaders? | Record<string, any> |
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”URLTokenBaseHTTPClient.constructor
Defined in
Section titled “Defined in”node_modules/algosdk/dist/types/client/urlTokenBaseHTTPClient.d.ts:27
Properties
Section titled “Properties”MAX_BACKOFF_MS
Section titled “MAX_BACKOFF_MS”▪ Static Private Readonly MAX_BACKOFF_MS: 10000
Defined in
Section titled “Defined in”src/types/algo-http-client-with-retry.ts:8
MAX_TRIES
Section titled “MAX_TRIES”▪ Static Private Readonly MAX_TRIES: 5
Defined in
Section titled “Defined in”src/types/algo-http-client-with-retry.ts:7
RETRY_ERROR_CODES
Section titled “RETRY_ERROR_CODES”▪ Static Private Readonly RETRY_ERROR_CODES: string[]
Defined in
Section titled “Defined in”src/types/algo-http-client-with-retry.ts:13
RETRY_STATUS_CODES
Section titled “RETRY_STATUS_CODES”▪ Static Private Readonly RETRY_STATUS_CODES: number[]
Defined in
Section titled “Defined in”src/types/algo-http-client-with-retry.ts:12
Methods
Section titled “Methods”callWithRetry
Section titled “callWithRetry”▸ callWithRetry(func): Promise<BaseHTTPClientResponse>
Parameters
Section titled “Parameters”| Name | Type |
|---|---|
func | () => Promise<BaseHTTPClientResponse> |
Returns
Section titled “Returns”Promise<BaseHTTPClientResponse>
Defined in
Section titled “Defined in”src/types/algo-http-client-with-retry.ts:25
delete
Section titled “delete”▸ delete(relativePath, data, query?, requestHeaders?): Promise<BaseHTTPClientResponse>
Parameters
Section titled “Parameters”| Name | Type |
|---|---|
relativePath | string |
data | Uint8Array |
query? | Query<string> |
requestHeaders | Record<string, string> |
Returns
Section titled “Returns”Promise<BaseHTTPClientResponse>
Overrides
Section titled “Overrides”URLTokenBaseHTTPClient.delete
Defined in
Section titled “Defined in”src/types/algo-http-client-with-retry.ts:100
▸ get(relativePath, query?, requestHeaders?): Promise<BaseHTTPClientResponse>
Parameters
Section titled “Parameters”| Name | Type |
|---|---|
relativePath | string |
query? | Query<string> |
requestHeaders | Record<string, string> |
Returns
Section titled “Returns”Promise<BaseHTTPClientResponse>
Overrides
Section titled “Overrides”URLTokenBaseHTTPClient.get
Defined in
Section titled “Defined in”src/types/algo-http-client-with-retry.ts:57
▸ post(relativePath, data, query?, requestHeaders?): Promise<BaseHTTPClientResponse>
Parameters
Section titled “Parameters”| Name | Type |
|---|---|
relativePath | string |
data | Uint8Array |
query? | Query<string> |
requestHeaders | Record<string, string> |
Returns
Section titled “Returns”Promise<BaseHTTPClientResponse>
Overrides
Section titled “Overrides”URLTokenBaseHTTPClient.post