@displayduck/ipc
v0.1.0
Published
IPC transport types and backend placeholders for DisplayDuck plugins.
Readme
@displayduck/ipc
IPC transport types and backend placeholders for DisplayDuck plugins.
Install
npm install -D @displayduck/ipcPurpose
This package is intentionally not the runtime implementation.
The real behavior for these APIs is provided by the DisplayDuck backend build/runtime pipeline:
new IpcTransport(...)ipcTransportEndpointExists(...)
This package exists so plugin authors get:
- TypeScript types
- autocomplete
- stable imports for plugin source code
Exports
IpcTransportipcTransportEndpointExiststype IpcTransportOpenEventtype IpcTransportCloseEvent
Example
import { IpcTransport } from '@displayduck/ipc';
const transport = new IpcTransport({ endpoint: '\\\\.\\pipe\\discord-ipc-0' });
await transport.connect();If you execute these APIs outside the DisplayDuck backend pipeline, the placeholder implementation will throw by design.
