Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Axel Boberg <[email protected]>
  • Loading branch information
axelboberg committed Feb 18, 2024
1 parent a926e48 commit 29dbb9f
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,17 @@ bridge.events.on('item.stop', item => {
| Event | Description |
| ----- | ----------- |
| `state.change` | Emitted every time the remote state changes |
| `client.select` | Emitted locally, i.e. only within the one client when a selection is made |
| `item.play` | Emitted when an item is played, after an optional delay |
| `item.stop` | Emitted when an item is stopped |
| `shortcut` | Emitted when a shortcut is triggered |

### `bridge.events.emit(event, ...parameters)`
Emit an event with or without any data

### `bridge.events.emitLocally(event, ...parameters)`
Emit an event with or without any data but only to handlers registered in the local context
Events emitted this way will not reach other processes

### `bridge.events.on(event, handler)`
Listen for an event

Expand Down

0 comments on commit 29dbb9f

Please sign in to comment.