Class: NetApi
NetApi - object-oriented interface
Export
Hierarchy
↳
NetApi
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new NetApi(configuration?, basePath?, fetch?)
Parameters
| Name | Type | Default value |
|---|---|---|
configuration? | Configuration | undefined |
basePath | string | BASE_PATH |
fetch | FetchAPI | portableFetch |
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:60
Properties
basePath
• Protected basePath: string = BASE_PATH
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:60
configuration
• Protected configuration: Configuration
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:58
fetch
• Protected fetch: FetchAPI = portableFetch
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:60
Methods
netAddrsGet
▸ netAddrsGet(options?): Promise<string[]>
This endpoint is used to get net addrs
Summary
Net Addrs
Throws
Memberof
NetApi
Parameters
| Name | Type | Description |
|---|---|---|
options? | any | Override http request option. |
Returns
Promise<string[]>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:5213
publicMinersFailuresMinerGet
▸ publicMinersFailuresMinerGet(miner, options?): Promise<Response>
This endpoint returns all miners
Summary
Get all miners
Throws
Memberof
NetApi
Parameters
| Name | Type | Description |
|---|---|---|
miner | string | Filter by miner |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:5225
publicMinersGet
▸ publicMinersGet(options?): Promise<Response>
This endpoint returns all miners
Summary
Get all miners
Throws
Memberof
NetApi
Parameters
| Name | Type | Description |
|---|---|---|
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:5236
publicNetAddrsGet
▸ publicNetAddrsGet(options?): Promise<string[]>
This endpoint is used to get net addrs
Summary
Net Addrs
Throws
Memberof
NetApi
Parameters
| Name | Type | Description |
|---|---|---|
options? | any | Override http request option. |
Returns
Promise<string[]>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:5247
publicNetPeersGet
▸ publicNetPeersGet(options?): Promise<string[]>
This endpoint is used to get net peers
Summary
Net Peers
Throws
Memberof
NetApi
Parameters
| Name | Type | Description |
|---|---|---|
options? | any | Override http request option. |
Returns
Promise<string[]>