Skip to content

ryanneilstroud/periscope-react-native

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

@ryanneilstroud/periscope-react-native

React Native bridge for PeriscopeKit (iOS) and PeriscopeAndroid (Android) with low-friction installation.

Status

Implemented for iOS and Android via React Native native module autolinking.

1.2.0

This release uses PeriscopeKit 1.2.0 and PeriscopeAndroid 1.2.0. Native WebSocket capture remains automatic on iOS. The React Native bridge continues to capture HTTP on Android; its JavaScript API does not yet route React Native WebSockets through PeriscopeAndroid's opt-in WebSocket factory.

Install

  1. Install from npm:
pnpm add @ryanneilstroud/periscope-react-native@1.2.0
# or: npm install @ryanneilstroud/periscope-react-native@1.2.0
  1. npx pod-install --repo-update (iOS)
  2. Rebuild your app

Usage

import {Periscope} from '@ryanneilstroud/periscope-react-native';

await Periscope.capture({
  receiver: {
    host: 'localhost', // simulator only; use your Mac LAN IP on physical devices
    port: 61337,
  },
});

Stop monitoring:

await Periscope.stop();

You can also call named exports:

import {capture, stop} from '@ryanneilstroud/periscope-react-native';

Platform support

  • iOS: HTTP and native URLSessionWebSocketTask capture
  • Android: HTTP capture through PeriscopeAndroid 1.2.0; React Native WebSocket capture is not yet exposed

iOS WebSocket limitations

PeriscopeKit dynamically observes native URLSessionWebSocketTask send and receive operations, so no WebSocket-specific React Native integration is required beyond starting Periscope normally. Capture is best effort: it does not cover third-party socket implementations, lower-level networking APIs, or traffic that occurred before Periscope started. Keep Periscope disabled in release builds.

About

React Native bridge package for Periscope SDK

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages