New Event

Utility for creating well-formed player event payloads.

Stamps the common fields (id, createdAt, status, initiatedBy) onto a player event payload so every event you emit is well-formed. It’s plain JS, identical across frameworks.

Installation

npm

npx @beyondwords/cli components add new-event

Usage

import { newEvent } from '@/lib/newEvent';

player.onEvent(
  newEvent({
    type: 'PressedPlay',
    description: 'The play button was pressed.',
  }),
);
// => { id, createdAt, status: 'pending', initiatedBy: 'user', type, description }