The `flipper-server-client` package provides a lightweight JavaScript/TypeScript abstraction for connecting to and interacting with a Flipper Server instance. It is part of the broader Flipper ecosystem, an open-source debugging platform for iOS, Android, and React Native applications, developed by Meta (formerly Facebook). The current stable version is 0.273.0, and the project demonstrates a rapid release cadence, often releasing new versions weekly or bi-weekly, reflecting active development. Its primary role is to enable external tools or scripts to programmatically communicate with a running Flipper Server, allowing for automation, custom debugging flows, or integration with non-standard environments. Key differentiators include its tight integration with the Flipper ecosystem and its focus on providing a simple API for server interaction, distinct from the desktop Flipper application itself.
npm install flipper-server-clientVerified import paths — ran on the pinned version, not inferred.
Demonstrates how to instantiate `FlipperServerClient`, establish a connection to a Flipper server, register event listeners for errors and status changes, send an example message to a plugin, and listen for incoming messages from the server before gracefully disconnecting. This provides a foundational setup for custom Flipper integrations.
Always consult the official Flipper `CHANGELOG.md` (located at `desktop/static/CHANGELOG.md` in the main Flipper repository) before upgrading `flipper-server-client` to understand potential API changes and required migration steps for your integration.
Ensure the Flipper desktop application is running, or start the `flipper-server` manually before attempting to connect. Verify network configurations and firewall rules if experiencing `Connection refused` errors to the default WebSocket port.
Strive to keep your `flipper-server-client` package version synchronized with the version of the Flipper desktop application (and thus `flipper-server`) you are targeting. Check Flipper documentation or release notes for any explicit compatibility matrices.
Start the Flipper desktop application or ensure `flipper-server` is running independently. Check local firewall settings and confirm no other process is using port 52787.
Verify your project is configured for ES Modules (e.g., `"type": "module"` in `package.json` for Node.js) and use `import { FlipperServerClient } from 'flipper-server-client';`. If forced to use CommonJS, ensure your bundler/transpiler correctly handles ESM imports.Consult the TypeScript type definitions (`.d.ts` files) for `flipper-server-client` to determine the exact string literals for supported events. The specific events exposed might vary by version.
No dependency data recorded yet.