Documentation
    Preparing search index...

    Class Filter

    Implements

    Index

    Constructors

    constructor

    Accessors

    multicodec

    Methods

    start stop subscribe unsubscribe unsubscribeAll

    Constructors

    • Parameters

      • params: FilterConstructorParams

      Returns Filter

    Accessors

    • get multicodec(): string

      Returns string

    Methods

    • Starts the filter protocol.

      Returns Promise<void>

    • Stops the filter protocol.

      Returns Promise<void>

    • Subscribes to messages that match the filtering criteria defined in the specified decoders. Executes a callback upon receiving each message. Checks for a valid peer connection before starting. Will wait until a peer is available.

      Type Parameters

      Parameters

      Returns Promise<boolean>

      Promise that resolves to boolean indicating if the subscription was created successfully.

      // Subscribe to a single decoder
      await filter.subscribe(decoder, (msg) => console.log(msg));

      // Subscribe to multiple decoders with the same pubsub topic
      await filter.subscribe([decoder1, decoder2], (msg) => console.log(msg));

      // Handle subscription failure
      const success = await filter.subscribe(decoder, handleMessage);
      if (!success) {
        console.error("Failed to subscribe");
      }

    • Unsubscribes from messages with specified decoders.

      Type Parameters

      Parameters

      Returns Promise<boolean>

      Promise that resolves to true if unsubscription was successful, false otherwise.

      // Unsubscribe from a single decoder
      await filter.unsubscribe(decoder);

      // Unsubscribe from multiple decoders at once
      await filter.unsubscribe([decoder1, decoder2]);

      // Handle unsubscription failure
      const success = await filter.unsubscribe(decoder);
      if (!success) {
        console.error("Failed to unsubscribe");
      }

    • Unsubscribes from all active subscriptions across all pubsub topics.

      Returns void

      // Clean up all subscriptions when React component unmounts
      useEffect(() => {
        return () => filter.unsubscribeAll();
      }, [filter]);

      // Reset subscriptions and start over
      filter.unsubscribeAll();
      await filter.subscribe(newDecoder, newCallback);

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods