Marmot-TS
    Preparing search index...

    A group.history implementation that stores the parsed rumor events for a group and provies methods for querying

    Hierarchy

    Implements

    Index
    • Creates an async generator for paginated loading of historical rumor events.

      This method allows UI components to load historical messages in pages, enabling infinite scroll or paginated UI patterns.

      Parameters

      • Optionalfilter: Filter

        Optional filter to apply to the query

      Returns AsyncGenerator<Rumor[], void>

      Batches of Rumor events, with each batch containing up to filter.limit messages

    • Async generator that yields the current timeline of Rumor events whenever a matching rumor is saved, a rumor is removed, or history is cleared. Each snapshot is freshly queried so removal refills limited pages. Changes during loading or paused consumption are latched until the next pull.

      Abort, return, throw, or async disposal promptly releases listeners, even while a query is pending. Explicitly close iterators when no longer needed.

      Parameters

      • Optionalfilters: Filter | Filter[]
      • options: { signal?: AbortSignal } = {}

      Returns AsyncGenerator<Rumor[]>

    prefixed: string | boolean
    • Return an array listing the events for which the emitter has registered listeners.

      Returns (keyof GroupRumorHistoryEvents)[]

    • Return the number of listeners listening to a given event.

      Parameters

      Returns number

    • Return the listeners registered for a given event.

      Type Parameters

      Parameters

      • event: T

      Returns (
          (
              ...args: ArgumentMap<GroupRumorHistoryEvents>[Extract<
                  T,
                  keyof GroupRumorHistoryEvents,
              >],
          ) => void
      )[]

    • Type Parameters

      Parameters

      Returns this

    • Add a one-time listener for a given event.

      Type Parameters

      Parameters

      Returns this

    • Remove all listeners, or those of the specified event.

      Parameters

      • Optionalevent: keyof GroupRumorHistoryEvents

      Returns this

    • Remove the listeners of a given event.

      Type Parameters

      Parameters

      Returns this