kernl API
    Preparing search index...

    Interface KernlOptions

    interface KernlOptions {
        accounts?: AccountManager<any>;
        artifactCache?: () => Promise<NappletArtifactCache | undefined>;
        bridges?: BridgeRegistry;
        builtins?: readonly BuiltinApplet[];
        eventCache?: EventCacheOpener;
        eventStore?: EventStore<NostrEvent>;
        guard?: { profile?: GuardProfile };
        host: KernlHost;
        intentRetry?: { attempts: number; intervalMs: number };
        messaging?: MessagingRegistry;
        messagingBackends?: MessagingBackendFactories;
        pool?: RelayPool;
        relays?: Partial<Record<RelayTier, readonly string[]>>;
        theme?: Record<string, unknown>;
        torrent?: TorrentBackend;
    }
    Index
    accounts? artifactCache? bridges? builtins? eventCache? eventStore? guard? host intentRetry? messaging? messagingBackends? pool? relays? theme? torrent?
    accounts?: AccountManager<any>

    Supplied by the app so it can register its own account types first.

    artifactCache?: () => Promise<NappletArtifactCache | undefined>

    Opens the verified-artifact cache. Defaults to Cache Storage when the page has it, otherwise none.

    bridges?: BridgeRegistry
    builtins?: readonly BuiltinApplet[]

    Applets that come with the host, opened by kernl:<id> without a lookup.

    eventCache?: EventCacheOpener

    Opens the event cache, such as () => openEventCache(defaultWebCacheAdapters()) from @kernlize/core/cache. Without one the shell keeps events in memory only (D-030).

    eventStore?: EventStore<NostrEvent>
    guard?: { profile?: GuardProfile }
    host: KernlHost
    intentRetry?: { attempts: number; intervalMs: number }

    How intent delivery waits for a target to come up; DELIVERY_RETRY by default.

    messaging?: MessagingRegistry
    messagingBackends?: MessagingBackendFactories

    Backends for the messaging providers; absent ones stay unavailable.

    pool?: RelayPool
    relays?: Partial<Record<RelayTier, readonly string[]>>
    theme?: Record<string, unknown>

    Theme pushed to applets that hold theme:read.

    torrent?: TorrentBackend

    The engine for magnet links when bridges is not given. With one, magnet links download inside kernl instead of handing off to an app on the device (D-017).

    Settings
    Member Visibility

    On This Page
    Properties