#

API Docs for: 3.10.3
Show: Inherited Protected Private Deprecated

# EventHandle Class

Defined in: `event-custom/js/handle.js:1`
Module: event-custom

Return value from all subscribe operations

## Constructor

### `EventHandle`

(

- `evt`
- `sub`

)

Defined in `event-custom/js/handle.js:1`

#### Parameters:

- `evt` CustomEvent

  the custom event.

- `sub` Subscriber

  the subscriber.

- Index
- Methods
- Properties

## Item Index

### Methods

- detach
- monitor

### Properties

- evt
- sub

## Methods

### `detach`

() Int

Defined in `event-custom/js/handle.js:37`

Detaches this subscriber

#### Returns:

Int: the number of detached listeners

### `monitor`

(

- `what`

)
EventHandle

Defined in `event-custom/js/handle.js:60`

Monitor the event state for the subscribed event. The first parameter is what should be monitored, the rest are the normal parameters when subscribing to an event.

#### Parameters:

- `what` String

  what to monitor ('attach', 'detach', 'publish').

#### Returns:

EventHandle: return value from the monitor event subscription.

## Properties

### `evt`

CustomEvent

Defined in `event-custom/js/handle.js:10`

The custom event

### `sub`

Subscriber

Defined in `event-custom/js/handle.js:18`

The subscriber object