Skip to content

Exports

This is everything exposed by the package’s public entry point (src/index.ts):

export { Tabus } from "./core/tabus";
export type { ITransport } from "./transport/transport.interface";
export type { EventMap, InternalEvents, Handler, TabusMessage, TabusOptions } from "./core/types";
Export Export kind Description
Tabus Class The only public class. See Tabus class.
ITransport Type-only Contract implemented by the internal transports. See Transports.
EventMap Type-only Generic constraint for your events. See Types.
InternalEvents Type-only Shape of tab:join / tab:leave. See Types.
Handler Type-only Signature of an event handler. See Types.
TabusMessage Type-only Shape of the internal message. See Types.
TabusOptions Type-only Constructor options. See Options.

In practice, most integrations only need:

import { Tabus } from "tabus-js";
import type { TabusOptions } from "tabus-js";