Package Exports

quickrtc-types
quickrtc-types/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (quickrtc-types) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

📦 quickrtc_types

Shared TypeScript type definitions for QuickRTC client and server applications.

Overview

This package provides comprehensive type-safe interfaces for MediaSoup WebRTC communications, socket events, and application state management. It's designed to be shared between client and server implementations to ensure type consistency across your MediaSoup application.

Installation

npm install quickrtc_types

Usage

import {
  MediasoupConfig,
  JoinConferenceParams,
  CreateTransportParams,
  SocketEventData,
} from "quickrtc_types";

Category-Specific Imports

// Core types
import { ConferenceMap, ParticipantsMap } from "quickrtc-types/core";

// Transport types
import { ProduceParams, ConsumeParams } from "quickrtc-types/transport";

// Socket types
import { SocketEventType, MeetingParams } from "quickrtc-types/socket";

// Client types
import { ClientConfig, ClientConnectionState } from "quickrtc-types/client";

Type Categories

Core Types (`/core`)

MediasoupConfig - Server configuration
Conference - Conference entity interface
Participant - Participant entity interface
ConferenceMap, ParticipantsMap - Type aliases

Transport Types (`/transport`)

CreateTransportParams - WebRTC transport creation
ConnectTransportParams - Transport connection
ProduceParams - Media production
ConsumeParams - Media consumption
ConsumerResponse - Consumer creation response

Conference Types (`/conference`)

JoinConferenceParams - Conference joining
AppState - Application state management

Socket Types (`/socket`)

SocketEventType - Supported event types
SocketEventData - Event data structure
MeetingParams - Base meeting parameters
SocketResponse - Standard response format

Client Types (`/client`)

ClientConfig - Client configuration
ClientConnectionState - Connection states
MediaConstraints - Media constraints
ClientParticipant - Client-side participant info

Utility Types (`/utils`)

DeepPartial<T> - Deep partial utility
AsyncResult<T> - Async operation result
Callback<T> - Callback function type

Peer Dependencies

This package requires the following peer dependencies:

mediasoup ^3.19.0
socket.io ^4.8.0

Development

# Build the package
pnpm build

# Watch mode for development
pnpm dev

# Clean build artifacts
pnpm clean

License

ISC

quickrtc-types