Documentation

OpenSocket JavaScript SDKs

👋 Hey there! Thanks for checking out the OpenSocket JavaScript SDKs

What is OpenSocket?

The OpenSocket JS SDK is a monorepo that provides JavaScript-based SDKs for building real-time, socket-based applications across multiple JavaScript frameworks and environments. With vendor-agnostic APIs, you can switch between socket providers (like Ably, Socket.IO, and Pusher) effortlessly while maintaining a consistent API.

Overview

The js-sdk repository includes the following packages:

• core: The foundational package for OpenSocket, providing a vendor-agnostic API.
• react: The SDK for React applications, providing easy-to-use hooks and components.
• next: The SDK for Next.js applications, designed for server-side and client-side usage.
• vanilla: The SDK for plain JavaScript applications, allowing integration without any specific framework.
• angular: The SDK for Angular applications, featuring services and dependency injection for real-time communication.

🔧 Repository Structure

js-sdk/
├── packages/
│   ├── core/          # Provides the core API and Provider Interface
│   ├── react/         # SDK for React
│   ├── next/          # SDK for Next.js
│   ├── vanilla/       # SDK for Vanilla JavaScript
│   └── angular/       # SDK for Angular
Copy

Installation

Core SDK installation

npm install @opensocket/core-js

React SDK installation

npm install @opensocket/react-sdk

🤝 Contributing

Interested in contributing? Great, we'd love your help! To get started, take a look at the CONTRIBUTING guide.

Thanks to everyone that has already contributed

Made with ❤

📜 License

Apache License 2.0