TypeScript API

Concise reference for the high-level TypeScript configuration, endpoint methods, streams, events, and public errors on Node.js and React Native.

The TypeScript SDK has one interface on two runtimes. Install @minip2p/node or @minip2p/react-native and import application APIs from that package.

Choose the import for the application’s runtime:

import {
  Minip2p,
  PubsubRouter,
  circuitAddress,
  generateSecretKey,
  peerIdFromSecretKey,
} from "@minip2p/node";

import {
  Minip2p,
  PubsubRouter,
  bindAppState,
  circuitAddress,
  generateSecretKey,
  peerIdFromSecretKey,
  useMinip2p,
} from "@minip2p/react-native";

Setup per runtime: Node.js, React Native.

Configuration

Minip2p.create(config) constructs and starts an endpoint synchronously.

discovery.topic is required when signed discovery is enabled. Both discovery options objects accept autoDial; remaining timing and capacity fields are typed in the exported declarations and use defaults when omitted. Signed discovery and mDNS share one automatic-dial policy. If both set autoDial, the values must match.

Each transport accepts true or { listen?: readonly [string, ...string[]] }; omit a transport to disable it. true listens on that transport’s IPv4 and IPv6 defaults. An explicit listen array replaces those defaults exactly; an empty array is rejected. QUIC accepts at most one explicit listener per IP family. An omitted or empty transports object defaults to QUIC.

// QUIC only, IPv4 + IPv6 (also the default when `transports` is omitted)
transports: { quic: true }

// QUIC + TCP, both IPv4 + IPv6
transports: { quic: true, tcp: true }

// TCP on exactly these listeners
transports: {
  tcp: {
    listen: [
      "/ip4/0.0.0.0/tcp/4001",
      "/ip6/::/tcp/4001",
    ],
  },
}

Identity and lifecycle

Node.js A started endpoint keeps the Node.js process alive until close(). See Endpoint lifecycle for signal handling and shutdown order.

State queries

Operations

Promise operations use { timeoutMs?, signal? }. Their default timeout is 65 seconds; timeoutMs: 0 disables it.

Pubsub and protocols

Stream

Stream events are data, remoteWriteClosed, closed, and dataOverflow.

Events

on(name, handler) is the typed application path. once and waitFor expose the same named map as Promises. on(handler) receives catch-all metadata with a discriminating type.

events({ signal?, bufferCap? }) returns an async iterator over the catch-all event stream. It ends when the endpoint closes or the signal aborts. A slow iterator yields queueOverflow before continuing with retained events.

The catch-all stream uses inboundStream metadata instead of the live stream handle. Subscribe to the named stream event to claim an inbound stream.

Public errors

Use instanceof for control flow and the typed kind fields for telemetry.