JavaScript / TypeScript

Official @serverme/sdk for Node.js and TypeScript.

Install

bash

npm install @serverme/sdk

Quick start

typescript

const client = new ServerMe({ authtoken: 'sm_live_...' });

const tunnels = await client.tunnels.list(); const requests = await client.inspect.list(tunnels[0].url); const result = await client.inspect.replay(tunnels[0].url, requests[0].id); ```

Live traffic streaming

typescript

for await (const req of stream) { console.log(${req.method} ${req.path} -> ${req.statusCode}); }

stream.close(); ```

API keys

typescript

const keys = await client.apiKeys.list();
const { apiKey, info } = await client.apiKeys.create('my-app');
await client.apiKeys.delete(info.id);

Domains

typescript

const { domain, instructions } = await client.domains.create('api.example.com');
await client.domains.verify(domain.id);
const all = await client.domains.list();

Error handling

typescript

try { await client.tunnels.list(); } catch (err) { if (err instanceof AuthError) { /* bad token */ } if (err instanceof RateLimitError) { /* retry in err.retryAfter seconds */ } if (err instanceof ApiError) { /* err.statusCode, err.message */ } } ```

Self-hosted

typescript

const client = new ServerMe({
  authtoken: 'sm_live_...',
  serverUrl: 'https://api.yourdomain.com',
});