Skip to main content

Installing

The TypeScript SDK can be installed via your favourite package manager, e.g. pnpm

Basic Usage

Importing and initialising

The SailhouseClient class from the package has everything we need to get started. Provided you have generated a token, you can create a client from the class.

Sending an event

The client has an async publish method for sending data to a given topic.
The second argument can be any object. Ideally, this should just be a map, as the contents are stringified via JSON.stringify(...) and we don’t want that to get messy.

Recieving events from a pull subscription

The client has a getEvents method for pull subscriptions.

Admin Operations

The admin client provides methods for managing subscriptions programmatically.

Registering Push Subscriptions

Rate Limiting and Deduplication

  • Rate Limit: Controls delivery frequency using formats like “100/h” (100 per hour), “10/m” (10 per minute)
  • Deduplication: Prevents duplicate deliveries within a time window using formats like “5m” (5 minutes), “1h” (1 hour)