TypeScript SDK

TL;DR

Install

npm install @flung.dev/sdk

The client

The Flung API client. Every resource of the API is a property: flung.posts.create({ content, accountIds }). Failed calls throw FlungError. Network failures, timeouts, 429 and 5xx answers are retried with backoff, honouring Retry-After. Every POST carries an Idempotency-Key (generated unless you pass one), so a retry never schedules a post twice.

Options

Helpers

Beyond one method per endpoint, the client has these.

uploadMedia(data: Blob \| Uint8Array \| ArrayBuffer, options: { contentType: string; filename?: string })

Uploads a file in one call and resolves with it ready, for mediaIds: reserves it, then sends the bytes, in parts when it is over 100 MB. Flung reads the real type from the file itself; contentType is what you expect.

1const image = await flung.uploadMedia(await readFile('launch.png'), { contentType: 'image/png', filename: 'launch.png' })2await flung.posts.create({ content: 'Launching today.', accountIds, mediaIds: [image.id] })

waitForConnection(sessionId: string, options: { intervalMs?: number; timeoutMs?: number } = {})

Waits until the person finishes a connect or reconnect: resolves with the session once it is connected, failed or expired. Sessions last ten minutes, so this never waits longer than that unless timeoutMs says so.

1const session = await flung.accounts.connect({ platform: 'linkedin' })2console.warn(`Open ${session.authorizationUrl}`)3const done = await flung.waitForConnection(session.id)

paginate(list: (params: P & { startingAfter?: string }) => Promise<{ data: T[]; hasMore: boolean }>, params = {} as P)

Walks every page of a list: for await (const post of flung.paginate((page) => flung.posts.list(page))). Pass the first page's parameters (such as limit) as the second argument.

Errors

What every failed call throws. Branch on code, which never changes; message is for people and may.

1try { await flung.posts.create({ content, accountIds }) }2catch (error) { if (error instanceof FlungError && error.code === 'account_needs_reconnect') ... }

Every code is listed in Errors.

Webhooks

Checks a webhook from Flung and returns the parsed event, or throws FlungWebhookError. Flung signs to the Standard Webhooks spec, so any Standard Webhooks library verifies its events too.

1export async function POST(request: Request): Promise<Response> {2  const body = await request.text()3  const event = await verifyWebhook({ body, headers: request.headers, secret: process.env.FLUNG_WEBHOOK_SECRET! })4  if (event.type === 'post.failed') console.warn(`Post ${event.data.post.id} failed`)5  return new Response(null, { status: 204 })6}

Input

Every method

flung.posts

flung.accounts

flung.webhookEndpoints

flung.connectTokens

flung.connectSessions

flung.apiKeys

flung.me

flung.members

flung.media

flung.templates

flung.variables

flung.feeds

flung.platforms

flung.analytics

flung.inbox

flung.experience

See also