API Documentation for: 0.11.8
Show:

platypus.Async Class

Defined in: platypus.Async:1
Module: platypus

Available since 0.10.0

This class defines an asynchronous set up wherein multiple calls can be made and a final function will be run once the calls are completed.

Constructor

platypus.Async

(
  • functions
  • callback
)
platypus.Async

Defined in platypus.Async:1

Available since 0.10.0

Parameters:

  • functions Array

    An array of functions where each function accepts a callback parameter and runs callback() on completion to notify the completion of the call.

  • callback Function

    The function to run once the list of functions has finished.

Returns:

platypus.Async:

Returns the new Async object.

Item Index

Methods

Async.recycle

(
  • async
)

Defined in Async.recycle:46

Returns an Async back to the cache.

Parameters:

Async.setUp

() platypus.Async

Defined in Async.setUp:40

Returns an Async from cache or creates a new one if none are available.

Returns:

platypus.Async:

The instantiated Async.

recycle

()

Defined in recycle:52

Relinquishes properties of the Async and recycles it.