#

API Docs for: 3.10.3
Show: Inherited Protected Private Deprecated

# Subscriber Class

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

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

## Constructor

### `Subscriber`

(

- `fn`
- `context`
- `args`

)

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

#### 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.

- Index
- Methods
- Properties

## Item Index

### Methods

- contains
- notify

### Properties

- args
- context
- events
- fn
- id
- once

## Methods

### `contains`

(

- `fn`
- `context`

)
Boolean

Defined in `event-custom/js/subscriber.js:124`

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`

)

Defined in `event-custom/js/subscriber.js:96`

Executes the subscriber.

#### Parameters:

- `args` Array

  Arguments array for the subscriber.

- `ce` CustomEvent

  The custom event that sent the notification.

## Properties

### `args`

Array

Defined in `event-custom/js/subscriber.js:34`

Additional arguments to propagate to the subscriber

### `context`

Object

Defined in `event-custom/js/subscriber.js:20`

Optional 'this' keyword for the listener

### `events`

EventTarget

Defined in `event-custom/js/subscriber.js:43`

Custom events for a given fire transaction.

### `fn`

Function

Defined in `event-custom/js/subscriber.js:12`

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

### `id`

String

Defined in `event-custom/js/subscriber.js:27`

Unique subscriber id

### `once`

Unknown

Defined in `event-custom/js/subscriber.js:50`

This listener only reacts to the event once