Typescript SDK - Feeds API

About 173 wordsLess than 1 minute

Comprehensive code examples for the Stream feeds typescript SDK.

Common (35 methods)
Feeds (61 methods)
Moderation (12 methods)
Types Reference - interfaces for API requests/responses

Overview

This documentation covers 108 API methods across 3 categories.

Installation

npm install @stream-io/feeds-client
# or
yarn add @stream-io/feeds-client

Basic Setup

import { FeedsClient } from "@stream-io/feeds-client";

// Initialize the client
const client = new FeedsClient("YOUR_API_KEY");

// Connect the user
await client.connectUser({ id: "john" }, "USER_TOKEN");

Categories

Common

getApp() - Get App Settings
listBlockLists() - List block lists
createBlockList() - Create block list
updateBlockList() - Update block list
deleteBlockList() - Delete block list
... and 30 more methods

Feeds

addActivity() - Add a single activity
upsertActivities() - Upsert multiple activities
deleteActivities() - Remove multiple activities
queryActivities() - Query activities
addBookmark() - Add bookmark
... and 56 more methods

Moderation

appeal() - Appeal against the moderation decision
getAppeal() - Get appeal item
queryAppeals() - Query Appeals
ban() - Ban
upsertConfig() - Create or update moderation configuration
... and 7 more methods

Generated from Stream OpenAPI specification