docs » cp.config.shutdownCallback


Shutdown Callback Module.

API Overview

API Documentation

Methods

callbackFn

Signature cp.config.shutdownCallback:callbackFn() -> function
Type Method
Description Returns the callbackFn of the current Shutdown Callback
Parameters
  • * None
Returns
  • The callbackFn of the current Shutdown Callback

get

Signature cp.config.shutdownCallback:get(id) -> table
Type Method
Description Creates a new Shutdown Callback.
Parameters
  • * `id` - The unique ID for the callback you want to return.
Returns
  • table containing the callback

getAll

Signature cp.config.shutdownCallback:getAll() -> table
Type Method
Description Returns all of the created Shutdown Callbacks
Parameters
  • * None
Returns
  • table containing all of the created callbacks

id

Signature cp.config.shutdownCallback:id() -> string
Type Method
Description Returns the ID of the current Shutdown Callback
Parameters
  • * None
Returns
  • The ID of the current Shutdown Callback as a `string`

new

Signature cp.config.shutdownCallback:new(id, callbackFn) -> table
Type Method
Description Creates a new Shutdown Callback.
Parameters
  • * `id` - The unique ID for this callback.
Returns
  • table that has been created

results matching ""

    No results matching ""