@mxraven/mail - v0.6.0
    Preparing search index...

    Class NotificationClient

    Consumes one listener's mxRaven client notification events over NATS JetStream.

    Notifications are off by default. Enable them for the listener with the mxRaven administrative API first; that creates the durable consumer this client reads from.

    The connection authenticates with the listener's ordinary API key and only grants access to that listener's consumer, so the key prefix and secret are the same values used for SMTP submission.

    A client is safe for concurrent use. A consume call and an events iterator share the durable consumer with any other client using the same API key: events are distributed between them, not duplicated to each.

    const client = await NotificationClient.connect({
      url: "wss://notifications.mxraven.com",
      username: "mxr_tx_ab12cd34ef56",
      secret: process.env.MXRAVEN_SECRET!,
      listener: listenerId,
    });

    await client.consume((event) => {
      if (event.kind === "accepted") {
        console.log("accepted", event.accepted.task_id);
      } else {
        console.log("attempt", event.attempt.taskId, event.attempt.status);
      }
    });
    Index
    close consume events connect

    • Releases the client's connection.

      Active consume calls and iterators stop, and events they did not acknowledge are redelivered later. Close is safe to call more than once.

      Returns Promise<void>

      NotificationError When the connection cannot be closed cleanly.

    • Consumes events until the signal aborts, the client closes, or the handler returns stopConsuming.

      A handler that returns normally acknowledges the event. A handler that throws leaves it unacknowledged, and the server redelivers it after a delay that doubles with each attempt up to 30 seconds. Events are handled one at a time, so a slow handler applies backpressure to the pull.

      Cancellation is a normal stop and resolves the promise; it is not an error. A decode failure without an error handler rejects with DecodeError. A permanently lost consumer or connection rejects with NotificationError.

      Parameters

      Returns Promise<void>

      Resolves when consumption stops.

      NotificationError When consumption fails.

    • Iterates events without automatic acknowledgement.

      The caller acknowledges each event with ack, nak, or term on the yielded delivery. Stopping iteration leaves unacknowledged events for redelivery after the consumer's acknowledgement timeout.

      Parameters

      Returns NotificationIterator

      An async iterator over the listener's events.

      NotificationError When used after close, or when iteration fails.

      for await (const { event, ack, nak } of client.events({ signal })) {
        try {
          await process(event);
          ack();
        } catch {
          nak({ delay: 5_000 });
        }
      }

    • Connects to the notification tier and resolves the listener's durable consumer.

      The initial connection and the consumer lookup fail here rather than on the first event. After a successful connection the transport reconnects indefinitely when the tier is unreachable, and the consumer resumes from its acknowledgement floor.

      Parameters

      Returns Promise<NotificationClient>

      A connected client.

      NotificationError When an option is invalid, the server rejects the API key, or the listener's consumer does not exist.

      const client = await NotificationClient.connect({
        url: "wss://notifications.mxraven.com",
        username: "mxr_tx_ab12cd34ef56",
        secret: process.env.MXRAVEN_SECRET!,
        listener: "0b0b0b0b-1111-2222-3333-444444444444",
      });

    Settings
    Member Visibility

    On This Page
    Methods