Skip to content

ElectronSessionModule

Unofficial

The session module accessor exposed by Electron, providing the default session and a factory for partition-based sessions.

Import:

import type { ElectronSessionModule } from '@obsidian-typings/obsidian-catalyst-latest';

Signature:

export interface ElectronSessionModule

Properties

Property Type Description
defaultSession Session The default session object of the app.

Methods

Method Returns Description
fromPartition(partition, options?) Session Returns a session instance from a partition string. When there is an existing Session with the same partition, it will be returned; otherwise a new Session instance will be created with options.

If partition starts with persist:, the page will use a persistent session available to all pages in the app with the same partition. If there is no persist: prefix, the page will use an in-memory session. If the partition is empty then default session of the app will be returned.

Links to this page: