ModuleEvent — Kuito Documentation

Usage

Notify JavaScript when a native device connection changes.

This type is used by event

tsx

// Notify JavaScript when a native device connection changes.
import { defineModule, event } from 'kuito';

export default defineModule('Accessory', {
  connected: event<{ name: string }>(),
  ios: { class: 'AccessoryModule' },
  android: { class: 'com.example.modules.accessory.AccessoryModule' },
});

// Implement startConnected/stopConnected on each platform. The consumer uses
// Accessory.connected.addListener(({ name }) => console.log(name)) and calls
// remove() on the returned subscription when observation is no longer needed.

Type declaration

export interface ModuleEvent<Payload> {
  /** The platform sends the event from the first listener until the last is removed. */
  addListener(listener: (payload: Payload) => void): EventSubscription;
}

Members 1

Name	Type	Required	Description
`addListener`	`(listener: (payload: Payload) => void) => EventSubscription`	Yes	The platform sends the event from the first listener until the last is removed.

addListener — method signatures

Signatures

(listener: (payload: Payload) => void): EventSubscription

Parameters

Name	Type	Required	Description
`listener`	`(payload: Payload) => void`	Yes	—

Returns

EventSubscription

Generated from the public TypeScript declarations: signatures, props and defaults come from the checked source, descriptions from its JSDoc. No defaults are invented.