#

API Docs for: 3.10.3
Show: Inherited Protected Private Deprecated

# Do.Halt Class

Defined in: `event-custom/js/event-do.js:337`
Module: event-custom-base
Parent Module: event-custom

Return a Halt object when you want to terminate the execution of all subsequent subscribers as well as the wrapped method if it has not exectued yet. Useful for Do.before subscribers.

## Constructor

### `Do.Halt`

(

- `msg`
- `retVal`

)

Defined in `event-custom/js/event-do.js:337`

#### Parameters:

- `msg` String

  (optional) Explanation of why the termination was done

- `retVal` Any

  Return value passed to code that invoked the wrapped function.

- Index

## Item Index