Marmot-TS
    Preparing search index...

    Type Alias MarmotGroupOptions<THistory, TMedia>

    type MarmotGroupOptions<
        THistory extends BaseGroupHistory
        | undefined = undefined,
        TMedia extends BaseGroupMedia | undefined = undefined,
    > = {
        ciphersuite: CiphersuiteImpl;
        history?: THistory | GroupHistoryFactory<THistory>;
        media?: TMedia | GroupMediaFactory<TMedia>;
        network: NostrNetworkInterface;
        signer: EventSigner;
        store: GenericKeyValueStore<SerializedClientState>;
    }

    Type Parameters

    Index

    Client - Group

    ciphersuite history? media? network signer store

    Client - Group

    ciphersuite: CiphersuiteImpl

    The ciphersuite implementation to use for the group

    history?: THistory | GroupHistoryFactory<THistory>

    The storage interface for the groups application message history (optional)

    media?: TMedia | GroupMediaFactory<TMedia>

    Backend (or pre-wrapped store) for the plaintext blob cache used by MarmotGroup.decryptMedia. Defaults to an in-memory cache when not provided.

    network: NostrNetworkInterface

    The nostr relay pool to use for the group. Should implement GroupNostrInterface for group operations.

    signer: EventSigner

    The signer used for the clients identity

    store: GenericKeyValueStore<SerializedClientState>

    The key-value backend where serialized group state bytes are persisted

    Settings

    Member Visibility

    On This Page

    Client - Group