notif.sh

TypeScript SDK for notif.sh event hub.

Installation

npm install notif.sh

Quick Start

import { Notif } from 'notif.sh'

// Uses NOTIF_API_KEY env var by default
const n = new Notif()

// Emit an event
await n.emit('leads.new', { name: 'John', email: '[email protected]' })

// Subscribe to events (auto-ack by default)
for await (const event of n.subscribe('leads.*')) {
  console.log(`Received: ${event.topic} - ${JSON.stringify(event.data)}`)
}

n.close()

Configuration

import { Notif } from 'notif.sh'

// Using environment variable (recommended)
// Set NOTIF_API_KEY=nsh_your_api_key
const client = new Notif()

// Or pass API key directly
const client = new Notif({ apiKey: 'nsh_your_api_key' })

// With custom server
const client = new Notif({ server: 'http://localhost:8080' })

// With custom timeout (ms)
const client = new Notif({ timeout: 60000 })

Emitting Events

const n = new Notif()

const result = await n.emit('orders.created', {
  orderId: '12345',
  amount: 99.99,
})

console.log(`Event ID: ${result.id}`)

n.close()

Subscribing to Events

const n = new Notif()

// Subscribe to multiple topics
for await (const event of n.subscribe('orders.*', 'payments.*')) {
  console.log(`${event.topic}: ${JSON.stringify(event.data)}`)
}

// Manual acknowledgment
for await (const event of n.subscribe('orders.*', { autoAck: false })) {
  try {
    await process(event.data)
    await event.ack()
  } catch (err) {
    await event.nack('5m') // Retry in 5 minutes
  }
}

// Consumer groups (load-balanced)
for await (const event of n.subscribe('jobs.*', { group: 'worker-pool' })) {
  await processJob(event.data)
}

// Start from beginning
for await (const event of n.subscribe('orders.*', { from: 'beginning' })) {
  console.log(event.data)
}

n.close()

Error Handling

import { Notif, AuthError, APIError, ConnectionError } from 'notif.sh'

try {
  const n = new Notif()
  await n.emit('test', { data: 'value' })
  n.close()
} catch (err) {
  if (err instanceof AuthError) {
    console.log('Invalid API key')
  } else if (err instanceof APIError) {
    console.log(`API error (${err.statusCode}): ${err.message}`)
  } else if (err instanceof ConnectionError) {
    console.log(`Connection failed: ${err.message}`)
  }
}

Requirements

• Node.js 18+

License

MIT