Sage SDK
  • Getting Started
    • Installation
    • Frontend
    • Server
    • Error Handling
  • Channel
    • Create
    • Membership
    • Moderation
  • Post
  • Update
  • Invite
    • Creation
    • Deletion
  • Post
    • Comment
    • Like
  • User
    • Create
    • Membership
    • Post
    • Update
Powered by GitBook
On this page
  • Install
  • Usage
  1. Getting Started

Installation

NextFrontend

Last updated 9 months ago

Install

To use this library in your own project pull it in from npm:

npm i @sage-app/sdk

The SDK is written with TypeScript and exposes all the types needed for integration.

Usage

The Sage SDK is expected to run within one of two different contexts: either in a or environment.

Depending on your use case, the following imports are available:

import { SageClient } from '@sage-app/sdk/client';

import {
  SageProvider,
  useChannel,
  usePost,
  useUser
} from '@sage-app/sdk/react';

server
frontend