Class SessionStorage

Read/write storage scoped to your session (absolute paths: /pub/... or /priv/...).

Index

Methods

[dispose] delete exists free get getBytes getJson getText list putBytes putJson putText stats

Methods

[dispose]

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

delete

delete(path: Path): Promise<void>
Delete a path (file or empty directory).
Parameters
- path: Path
Returns Promise<void>
- Defined in pubky.d.ts:1718

exists

exists(path: Path): Promise<boolean>
Check existence.
Parameters
- path: Path
Returns Promise<boolean>
- Defined in pubky.d.ts:1725

free

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

get

get(path: Path): Promise<Response>
GET a streaming response for an absolute session path.
Parameters
- path: Path
Returns Promise<Response>
- Defined in pubky.d.ts:1732

getBytes

getBytes(path: Path): Promise<Uint8Array<ArrayBufferLike>>
GET bytes from an absolute session path.
Parameters
- path: Path
Returns Promise<Uint8Array<ArrayBufferLike>>
- Defined in pubky.d.ts:1739

getJson

getJson(path: Path): Promise<any>
GET JSON from an absolute session path.
Parameters
- path: Path
Returns Promise<any>
- Defined in pubky.d.ts:1746

getText

getText(path: Path): Promise<string>
GET text from an absolute session path.
Parameters
- path: Path
Returns Promise<string>
- Defined in pubky.d.ts:1753

list

list(
    path: Path,
    cursor?: string | null,
    reverse?: boolean | null,
    limit?: number | null,
    shallow?: boolean | null,
): Promise<string[]>
List a directory (absolute session path). Returns pubky://… URLs.
Parameters
- path: Path
  Must end with /.
- Optionalcursor: string | null
  Optional suffix or full URL to start after.
- Optionalreverse: boolean | null
  Default false.
- Optionallimit: number | null
  Optional result limit.
- Optionalshallow: boolean | null
  Default false.
Returns Promise<string[]>
- Defined in pubky.d.ts:1764

putBytes

putBytes(path: Path, body: Uint8Array): Promise<void>
PUT binary at an absolute session path.
Parameters
- path: Path
- body: Uint8Array
Returns Promise<void>
- Defined in pubky.d.ts:1772

putJson

putJson(path: Path, body: any): Promise<void>
PUT JSON at an absolute session path.
Parameters
- path: Path
  Absolute path (e.g. "/pub/app/data.json").
- body: any
Returns Promise<void>
- Defined in pubky.d.ts:1780

putText

putText(path: Path, body: string): Promise<void>
PUT text at an absolute session path.
Parameters
- path: Path
- body: string
Returns Promise<void>
- Defined in pubky.d.ts:1788

stats

stats(path: Path): Promise<ResourceStats | undefined>
Get metadata for an absolute, session-scoped path (e.g. "/pub/app/file.json").
Parameters
- path: Path
  Absolute path under your user (starts with /).
Returns Promise<ResourceStats | undefined>
undefined if the resource does not exist.

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

Class SessionStorage

Index

Methods

Methods

[dispose]

Returns void

delete

Parameters

Returns Promise<void>

exists

Parameters

Returns Promise<boolean>

free

Returns void

get

Parameters

Returns Promise<Response>

getBytes

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

getJson

Parameters

Returns Promise<any>

getText

Parameters

Returns Promise<string>

list

Parameters

Returns Promise<string[]>

putBytes

Parameters

Returns Promise<void>

putJson

Parameters

Returns Promise<void>

putText

Parameters

Returns Promise<void>

stats

Parameters

Returns Promise<ResourceStats | undefined>

Throws

Settings

On This Page