Installation

PubSubJS is distributed as multiple packages. Install only what you need.

Core Package

The core package is required for all PubSubJS applications:

# Using bun (recommended)
bun add @pubsubjs/core

# Using npm
npm install @pubsubjs/core

# Using yarn
yarn add @pubsubjs/core

# Using pnpm
pnpm add @pubsubjs/core

Schema Validation

PubSubJS supports any Standard Schema compatible validation library. Install your preferred library:

# Zod (recommended)
bun add zod

# Valibot (smaller bundle size)
bun add valibot

# ArkType
bun add arktype

Transport Packages

Install the transport(s) you need:

WebSocket Transport

For real-time browser-server communication:

bun add @pubsubjs/transport-websocket

Redis Transport

For distributed systems and microservices:

bun add @pubsubjs/transport-redis

SSE Transport

For server-to-client streaming:

bun add @pubsubjs/transport-sse

React Integration

For React applications:

bun add @pubsubjs/react

Peer Dependencies

Some packages have peer dependencies:

Package	Peer Dependencies
@pubsubjs/core	zod or valibot (optional)
@pubsubjs/react	react ^18.0.0 || ^19.0.0

TypeScript Configuration

PubSubJS is written in TypeScript and ships with type definitions. For the best experience, ensure your tsconfig.json includes:

{
  "compilerOptions": {
    "strict": true,
    "moduleResolution": "bundler",
    "esModuleInterop": true
  }
}

Verifying Installation

Create a simple test file to verify your installation:

test.ts

import { defineEvent } from "@pubsubjs/core";
import { z } from "zod";

const events = defineEvent([
  {
    name: "test.event",
    schema: z.object({ message: z.string() }),
  },
]);

console.log("PubSubJS installed successfully!");
console.log("Events:", Object.keys(events));

Run it:

bun test.ts
# or
npx ts-node test.ts

Next Steps

• Quick Start - Build your first application
• Events & Schemas - Learn about event definitions