For AI agents: visit https://docs.rainway.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Rainway DocumentationHubBlogChangelogSupport Forum
HomeGuidesAPI Reference
HubBlogChangelogSupport ForumLog InRainway Documentation
Guides
Log In
HomeGuidesAPI Reference

Overview

  • What is Rainway?

SDKs

  • Web
    • Getting Started
    • Rainway Network
    • Exchanging Messages
    • Streaming
    • API Reference
  • React
    • Getting Started
    • API Reference
  • .NET
    • Getting Started
    • Rainway Network
    • Exchanging Messages
    • Streaming
    • API Reference
  • Node.js
    • Getting Started
    • Rainway Network
    • Exchanging Messages
    • Streaming
    • API Reference
  • C++
    • Getting Started
    • Rainway Network
    • Exchanging Messages
    • Streaming
    • API Reference

Rainway API

  • Getting Started

Features

  • Data Channels
  • Input
    • Input Filtering
  • Stream Types
    • Full Desktop
    • App Isolation
    • BYOFB

Troubleshooting

  • Connectivity
  • Peer Connection States
  • System Requirements

Examples

  • Overview
  • Web Demo Repository
  • React Examples
  • .NET Examples
  • Node.js Examples
  • C++ Examples

Getting Started

Suggest Edits

This is a guide to help you start writing a web application using the Rainway Web SDK in TypeScript (or JavaScript).

For a Rainway Native SDK application, see "Getting Started with Node.js".

Adding Rainway to your project

npm install @rainway/web

See @rainway/web on npm.

Updated almost 4 years ago


What’s Next

Once you've installed the SDK, it's time to connect to the Rainway Network.

    • Table of Contents
      • Adding Rainway to your project