Skip to content

nooschain v0.1.0


nooschain / cli/http-client / CliHttpClient

Class: CliHttpClient

Defined in: cli/http-client.ts:50

Minimal JSON HTTP client used by all API-backed CLI commands.

Constructors

Constructor

new CliHttpClient(config): CliHttpClient

Defined in: cli/http-client.ts:54

Creates a client from already-resolved CLI configuration.

Parameters

config

CliConfig

Returns

CliHttpClient

Methods

get()

get<T>(path, options?): Promise<T>

Defined in: cli/http-client.ts:141

Sends a JSON GET request.

Type Parameters

T

T = unknown

Parameters

path

string

options?
requireOperatorToken?

boolean

Returns

Promise<T>


getText()

getText(path, options?): Promise<string>

Defined in: cli/http-client.ts:146

Sends a GET request and returns the raw text body.

Parameters

path

string

options?
requireOperatorToken?

boolean

Returns

Promise<string>


post()

post<T>(path, body?, options?): Promise<T>

Defined in: cli/http-client.ts:153

Sends a JSON POST request.

Type Parameters

T

T = unknown

Parameters

path

string

body?

unknown

options?
requireOperatorToken?

boolean

Returns

Promise<T>


request()

request<T>(method, path, body?, options?): Promise<T>

Defined in: cli/http-client.ts:62

Sends one JSON request to the configured node API.

requireOperatorToken fails locally before making the request, which gives operators a clearer message than a later 401/403 from the node.

Type Parameters

T

T = unknown

Parameters

method

"GET" | "POST"

path

string

body?

unknown

options?
requireOperatorToken?

boolean

Returns

Promise<T>


requestText()

requestText(method, path, body?, options?): Promise<string>

Defined in: cli/http-client.ts:98

Sends a request and returns the raw response body as text.

Parameters

method

"GET" | "POST"

path

string

body?

unknown

options?
requireOperatorToken?

boolean

Returns

Promise<string>

Audience-first NOOSChain documentation.