Class Client

Low-level HTTP bridge used by the Pubky facade and actors.

Supports http(s):// URLs targeting Pubky or ICANN hosts.
In browsers/undici, passes credentials: "include" to send cookies.

Index

Constructors

Methods

[dispose] fetch free testnet

Constructors

constructor

new Client(config_opt?: PubkyClientConfig | null): Client
Create a Pubky HTTP client.
Parameters
- Optionalconfig_opt: PubkyClientConfig | null
Returns Client
A configured low-level client. Prefer new Pubky().client unless you need custom relays/timeouts.
Throws
If any PKARR relay URL is invalid.
Example
```
const client = new Client({
  pkarr: { relays: ["https://relay1/","https://relay2/"], request_timeout: 8000 }
});
const pubky = Pubky.withClient(client);
```
- Defined in pubky.d.ts:527

Methods

[dispose]

"[dispose]"(): void
Returns void
- Defined in pubky.d.ts:494

fetch

fetch(url: string, init?: RequestInit | null): Promise<Response>
Perform a raw fetch. Works with http(s):// URLs.
Parameters
- url: string
- Optionalinit: RequestInit | null
  Standard fetch options; credentials: "include" recommended for session I/O.
Returns Promise<Response>
Example
```
const client = pubky.client;
const res = await client.fetch(`https://_pubky.${user}/pub/app/file.txt`, { method: "PUT", body: "hi", credentials: "include" });
```
- Defined in pubky.d.ts:506

free

free(): void
Returns void
- Defined in pubky.d.ts:493

`Static`testnet

testnet(host?: string | null): Client
Create a client wired for local testnet.

Configures PKARR relays for the testnet and remembers the hostname for WASM _pubky mapping.
Parameters
- Optionalhost: string | null
  Testnet hostname or IP.
Returns Client
A client ready to talk to your local testnet.
Example
```
const client = Client.testnet();           // localhost
const pubky  = Pubky.withClient(client);
```
Example
```
const client = Client.testnet("docker0");  // custom host
```
- Defined in pubky.d.ts:546