Version 3.18.1
Show:

Subscriber Class

Stores the subscriber information to be used when the event fires.

Constructor

Subscriber

(
  • fn
  • context
  • args
)

Parameters:

  • fn Function

    The wrapped function to execute.

  • context Object

    The value of the keyword 'this' in the listener.

  • args Array multiple

    0..n additional arguments to supply the listener.

Item Index

Methods

Properties

Methods

contains

(
  • fn
  • context
)
Boolean

Returns true if the fn and obj match this objects properties. Used by the unsubscribe method to match the right subscriber.

Parameters:

  • fn Function

    the function to execute.

  • context Object

    optional 'this' keyword for the listener.

Returns:

Boolean:

true if the supplied arguments match this subscriber's signature.

notify

(
  • args
  • ce
)

Executes the subscriber.

Parameters:

  • args Array

    Arguments array for the subscriber.

  • ce CustomEvent

    The custom event that sent the notification.

Properties

args

Array

Additional arguments to propagate to the subscriber

context

Object

Optional 'this' keyword for the listener

events

EventTarget

Custom events for a given fire transaction.

fn

Function

The callback that will be execute when the event fires This is wrapped by Y.rbind if obj was supplied.

id

String

Unique subscriber id

once

Unknown

This listener only reacts to the event once