Evented

Extended by

• Step
• ShepherdBase
• Tour

Constructors

new Evented()

new Evented(): Evented

Returns

Evented

Properties

bindings

bindings: Bindings

Defined in

docs-src/node_modules/shepherd.js/src/evented.ts:11

Methods

off()

off(event, handler?): Evented

Removes an event listener for the given event string.

Parameters

• event: string

• handler?: AnyHandler

Returns

Evented

Defined in

docs-src/node_modules/shepherd.js/src/evented.ts:53

---

on()

on(event, handler, ctx?, once?): Evented

Adds an event listener for the given event string.

Parameters

• event: string

• handler: AnyHandler

• ctx?: unknown

• once?: boolean = false

Returns

Evented

Defined in

docs-src/node_modules/shepherd.js/src/evented.ts:22

---

once()

once(event, handler, ctx?): Evented

Adds an event listener that only fires once for the given event string.

Parameters

• event: string

• handler: AnyHandler

• ctx?: unknown

Returns

Evented

Defined in

docs-src/node_modules/shepherd.js/src/evented.ts:42

---

trigger()

trigger(event, …args): Evented

Triggers an event listener for the given event string.

Parameters

• event: string

• …args: any[]

Returns

Evented

Defined in

docs-src/node_modules/shepherd.js/src/evented.ts:78