Worker Namespace

  1. Documentation
  2. Framework
  3. Reference
  4. App
  5. Worker

Sub-namespaces


Base


Middleware

Classes

App

constructor

With the help of this method you can create a new instance of App.

Signature

constructor(Object worker) : Object

Parameters

  • worker
    • Worker object
    • Type: Object

Returns

  • Object
    • Worker object

rebuildLinkingCache

Rebuild linking cache.

Signature

rebuildLinkingCache(void) : void

Build a link to a controller action.

Signature

link(String controller, String action, Object params, [String absoluteUrl]) : String

Parameters

  • controller
    • Controller path (eg. admin.users)
    • Type: String
  • action
    • Name of the action to link to
    • Type: String
  • params
    • Parameters object
    • Type: Object
  • [absoluteUrl]
    • If given, it will be prefixed
    • Type: String

Returns

  • String
    • The return value is not further described

linkContext

Build a link to a context.

Signature

linkContext(String context, [String path]) : String

Parameters

  • context
    • Name of the context
    • Type: String
  • [path]
    • Path to suffix to the context link
    • Type: String

Returns

  • String
    • The return value is not further described

preConfigure

Pre-Configure the given objects.

Signature

preConfigure(Object app, Object server, Function callback) : void

Parameters

  • app
    • Application to configure
    • Type: Object
  • server
    • Server to configure
    • Type: Object
  • callback
    • Function to call on finish
    • Type: Function

configure

Configure the given objects to fit the Greppy needs.

Signature

configure(Object app, Object server, Function callback) : void

Parameters

  • app
    • Application to configure
    • Type: Object
  • server
    • Server to configure
    • Type: Object
  • callback
    • Function to call on finish
    • Type: Function

postConfigure

Post configure the given objects to fit the Greppy needs.

Signature

postConfigure(Object app, Object server, Function callback) : void

Parameters

  • app
    • Application to configure
    • Type: Object
  • server
    • Server to configure
    • Type: Object
  • callback
    • Function to call on finish
    • Type: Function

Context

constructor

With the help of this method you can create a new instance of Context.

Signature

constructor(String childFilename) : String

Parameters

  • childFilename
    • Path of the child which extends this class
    • Type: String

Returns

  • String
    • Path of the child which extends this class

preConfigure

Worker context pre configure method.

Signature

preConfigure(Object app, Object server, Function callback) : void

Parameters

  • app
    • The application object
    • Type: Object
  • server
    • Server object
    • Type: Object
  • callback
    • Function to call on finish
    • Type: Function

configure

Worker context configure method.

Signature

configure(Object app, Object server, Function callback) : void

Parameters

  • app
    • The application object
    • Type: Object
  • server
    • Server object
    • Type: Object
  • callback
    • Function to call on finish
    • Type: Function

postConfigure

Worker context post configure method.

Signature

postConfigure(Object app, Object server, Function callback) : void

Parameters

  • app
    • The application object
    • Type: Object
  • server
    • Server object
    • Type: Object
  • callback
    • Function to call on finish
    • Type: Function