Class PublicStorage

Read-only public storage using addressed paths ("pubky<user>/pub/...").

Index

Constructors

Methods

[dispose] exists free get getBytes getJson getText list stats

Constructors

constructor

new PublicStorage(): PublicStorage
Construct PublicStorage using global client (mainline relays).

Returns PublicStorage
- Defined in pubky.d.ts:1566

Methods

[dispose]

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

exists

exists(address: Address): Promise<boolean>
Check if a path exists.
Parameters
- address: Address
Returns Promise<boolean>
- Defined in pubky.d.ts:1523

free

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

get

get(address: Address): Promise<Response>
Perform a streaming GET and expose the raw Response object.
Parameters
- address: Address
Returns Promise<Response>
- Defined in pubky.d.ts:1530

getBytes

getBytes(address: Address): Promise<Uint8Array<ArrayBufferLike>>
Fetch bytes from an addressed path.
Parameters
- address: Address
Returns Promise<Uint8Array<ArrayBufferLike>>
- Defined in pubky.d.ts:1537

getJson

getJson(address: Address): Promise<any>
Fetch JSON from an addressed path.
Parameters
- address: Address
  "pubky<user>/pub/.../file.json" (preferred) or pubky://<user>/pub/....
Returns Promise<any>
- Defined in pubky.d.ts:1544

getText

getText(address: Address): Promise<string>
Fetch text from an addressed path as UTF-8 text.
Parameters
- address: Address
Returns Promise<string>
- Defined in pubky.d.ts:1551

list

list(
    address: Address,
    cursor?: string | null,
    reverse?: boolean | null,
    limit?: number | null,
    shallow?: boolean | null,
): Promise<string[]>
List a directory. Results are pubky://… identifier URLs.
Parameters
- address: Address
  Addressed directory (must end with /).
- Optionalcursor: string | null
  Optional suffix or full URL to start after.
- Optionalreverse: boolean | null
  Default false. When true, newest/lexicographically-last first.
- Optionallimit: number | null
  Optional result limit.
- Optionalshallow: boolean | null
  Default false. When true, lists only first-level entries.
Returns Promise<string[]>
- Defined in pubky.d.ts:1562

stats

stats(address: Address): Promise<ResourceStats | undefined>
Get metadata for an address
Parameters
- address: Address
  "pubky<user>/pub/.../file.json" (preferred) or pubky://<user>/pub/....
Returns Promise<ResourceStats | undefined>
undefined if the resource does not exist.

Throws
On invalid input or transport/server errors.
- Defined in pubky.d.ts:1574