@displayduck/socket

Generic TCP socket support for DisplayDuck widgets and integrations.

import { createTcpSocket } from '@displayduck/socket';

const socket = createTcpSocket({
  host: '127.0.0.1',
  port: 49123,
  allowLocalhostAccess: true,
});

socket.on('open', () => {
  console.log('Connected');
});

socket.on('data', (data) => {
  console.log(data);
});

socket.on('close', (event) => {
  console.log('Closed', event.error);
});

await socket.connect();

DisplayDuck widgets must have the Allow localhost access permission enabled. The data event contains raw Uint8Array chunks; TCP message framing and decoding are the responsibility of the widget.