Class Session

Readonlycookie

Readonlygrant

Readonlyinfo

Readonlystorage

[dispose]

• "[dispose]"(): void

  Returns void

export

• export(): string

  Export the session metadata so it can be restored after a tab refresh.

  The export string contains no secrets; it only serializes the public SessionInfo. Browsers remain responsible for persisting the HTTP-only session cookie.

  Returns string

  A base64 string to store (e.g. in localStorage).

  Deprecated

  Prefer exportLocalSecret() for grant sessions.

exportLocalSecret

• exportLocalSecret(): Promise<string>

  Export the local secret material needed to restore this session.

  For local grant sessions this exports the grant JWS and PoP client secret; restoring mints a fresh bearer. For legacy cookie sessions this exports the cookie secret when the SDK owns it. Delegated browser grant sessions cannot export raw secret material; use BrowserSessionStore.

  Treat the returned string as a bearer-equivalent secret until the grant or cookie session expires or is revoked.

  Returns Promise<string>

  A secret token that can be passed to pubky.restoreSession().

free

• free(): void

  Returns void

signout

• signout(): Promise<void>

  Invalidate the session on the server (clears server cookie). Further calls to storage API will fail.

  Returns Promise<void>

Staticrestore

• restore(exported: string, client?: Client | null): Promise<Session>

  Restore a session from an export() string.

  The HTTP-only cookie must still be present in the browser; this function does not read or write any secrets.

  Parameters

  • exported: string

    A string produced by session.export().

  • Optionalclient: Client | null

    Optional client to reuse transport configuration.

  Returns Promise<Session>

  Deprecated

  Prefer Pubky.restoreSession(...).