API Docs for: 3.8.0
Show:

Do.Method Class

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

Wrapper for a displaced method with aop enabled

Constructor

Do.Method

(
  • obj
  • sFn
)

Defined in event-custom/js/event-do.js:196

Parameters:

  • obj Object

    The object to operate on

  • sFn Object

    The name of the method to displace

Item Index

Methods

Methods

delete

(
  • sid
  • fn
  • when
)

Defined in event-custom/js/event-do.js:226

Unregister a aop subscriber

Parameters:

  • sid String

    the subscriber id

  • fn Function

    the function to execute

  • when String

    when to execute the function

exec

(
  • arg
)
Any

Defined in event-custom/js/event-do.js:239

Execute the wrapped method. All arguments are passed into the wrapping functions. If any of the before wrappers return an instance of Y.Do.Halt or Y.Do.Prevent, neither the wrapped function nor any after phase subscribers will be executed.

The return value will be the return value of the wrapped function or one provided by a wrapper function via an instance of Y.Do.Halt or Y.Do.AlterReturn.

Parameters:

  • arg Any multiple

    Arguments are passed to the wrapping and wrapped functions

Returns:

Any: Return value of wrapped function unless overwritten (see above)

register

(
  • sid
  • fn
  • when
)

Defined in event-custom/js/event-do.js:211

Register a aop subscriber

Parameters:

  • sid String

    the subscriber id

  • fn Function

    the function to execute

  • when String

    when to execute the function