Agent

Agent

Singleton instance in Agent Worker, extend EggApplication

Constructor

new Agent(options)

Parameters:
Name Type Description
options Object

see EggApplication
Source:

Extends

Members

BaseContextClass :BaseContextClass

Since:
  • 1.0.0
Overrides:
Source:

baseDir :String

The current directory of application

Since:
  • 1.0.0
Overrides:
Source:
See:

Boot :Boot

Retreive base boot

Overrides:
Source:

config :Config

The configuration of application

Since:
  • 1.0.0
Overrides:
Source:

Controller :Controller

Retrieve base controller

Since:
  • 1.0.0
Overrides:
Source:

coreLogger :Logger

core logger for framework and plugins, log file is $HOME/logs/{appname}/egg-web

Since:
  • 1.0.0
Overrides:
Source:

createAnonymousContext :String

Create an anonymous context, the context isn't request level, so the request is mocked. then you can use context level API like ctx.service

Overrides:
Source:

deprecate :function

Alias to https://npmjs.com/package/depd

Since:
  • 1.0.0
Overrides:
Source:

env

app.env delegate app.config.env

Overrides:
Deprecated:
  • Yes
Source:

httpclient :HttpClient

HttpClient instance

Overrides:
Source:
See:

loader :EggLoader

The loader instance, the default class is EggLoader. If you want define

Since:
  • 1.0.0
Overrides:
Source:

logger :Logger

application logger, log file is $HOME/logs/{appname}/{appname}-web

Since:
  • 1.0.0
Overrides:
Source:

loggers :Object

All loggers contain logger, coreLogger and customLogger

Since:
  • 1.0.0
Overrides:
Source:

messenger :Messenger

messenger instance

Since:
  • 1.0.0
Overrides:
Source:

name :String

The name of application

Since:
  • 1.0.0
Overrides:
Source:
See:

plugins :Object

Retrieve enabled plugins

Since:
  • 1.0.0
Overrides:
Source:

proxy

app.proxy delegate app.config.proxy

Overrides:
Deprecated:
  • Yes
Source:

router :Router

get router

Since:
  • 1.0.0
Overrides:
Source:

Service :Service

Retrieve base service

Since:
  • 1.0.0
Overrides:
Source:

type :String

Whether application or agent

Since:
  • 1.0.0
Overrides:
Source:

Methods

addSingleton(name, create)

create a singleton instance

Parameters:
Name Type Description
name String

unique name for singleton
create function | AsyncFunction

method will be invoked when singleton instance create
Overrides:
Source:

beforeClose(fn)

Register a function that will be called when app close.

Notice: This method is now NOT recommanded directly used, Developers SHOULDN'T use app.beforeClose directly now, but in the form of class to implement beforeClose instead.

Parameters:
Name Type Description
fn function

the function that can be generator function or async function.
Overrides:
Source:
See:

beforeStart(scope)

Execute scope after loaded and before app start.

Notice: This method is now NOT recommanded and reguarded as a deprecated one, For plugin development, we should use didLoad instead. For application development, we should use willReady instead.

Parameters:
Name Type Description
scope function | GeneratorFunction | AsyncFunction

function will execute before app start
Overrides:
Source:
See:

(async) close() → {Promise}

Close all, it will close

  • callbacks registered by beforeClose
  • emit close event
  • remove add listeners

If error is thrown when it's closing, the promise will reject. It will also reject after following call.

Since:
  • 1.0.0
Overrides:
Source:

cluster(clientClass, optionsopt) → {ClientWrapper}

almost the same as Agent.cluster API, the only different is that this method create Follower.

Parameters:
Name Type Description
clientClass function

client class function
[ options ] Object
  • {Boolean} [autoGenerate] - whether generate delegate rule automatically, default is true
    • {Function} [formatKey] - a method to tranform the subscription info into a stringļ¼Œdefault is JSON.stringify
    • {Object} [transcode|JSON.stringify/parse]
      • {Function} encode - custom serialize method
      • {Function} decode - custom deserialize method
    • {Boolean} [isBroadcast] - whether broadcast subscrption result to all followers or just one, default is true
    • {Number} [responseTimeout] - response timeout, default is 3 seconds
    • {Number} [maxWaitTime|30000] - leader startup max time, default is 30 seconds
Overrides:
Source:
See:

createContext(req, res) → {Context}

Create egg context

Parameters:
Name Type Description
req Req

node native Request object
res Res

node native Response object
Overrides:
Source:

curl(url, opts) → {Object}

http request helper base on httpclient, it will auto save httpclient log. Keep the same api with httpclient.request(url, args).

See https://github.com/node-modules/urllib#api-doc for more details.

Parameters:
Name Type Description
url String

request url address.
opts Object
  • method {String} - Request method, defaults to GET. Could be GET, POST, DELETE or PUT. Alias 'type'.
  • data {Object} - Data to be sent. Will be stringify automatically.
  • dataType {String} - String - Type of response data. Could be text or json. If it's text, the callbacked data would be a String. If it's json, the data of callback would be a parsed JSON Object. Default callbacked data would be a Buffer.
  • headers {Object} - Request headers.
  • timeout {Number} - Request timeout in milliseconds. Defaults to exports.TIMEOUT. Include remote server connecting timeout and response timeout. When timeout happen, will return ConnectionTimeout or ResponseTimeout.
  • auth {String} - username:password used in HTTP Basic Authorization.
  • followRedirect {Boolean} - follow HTTP 3xx responses as redirects. defaults to false.
  • gzip {Boolean} - let you get the res object when request connected, default false. alias customResponse
  • nestedQuerystring {Boolean} - urllib default use querystring to stringify form data which don't support nested object, will use qs instead of querystring to support nested object by set this option to true.
  • more options see https://www.npmjs.com/package/urllib
Overrides:
Source:
Example
```js
const result = await app.curl('http://example.com/foo.json', {
  method: 'GET',
  dataType: 'json',
});
console.log(result.status, result.headers, result.data);
```

getLogger(name) → {Logger}

Get logger by name, it's equal to app.loggers['name'], but you can extend it with your own logical.

Parameters:
Name Type Description
name String

logger name
Overrides:
Source:

inspect() → {Object}

print the information when console.log(app)

Since:
  • 1.0.0
Overrides:
Source:
Example
```js
console.log(app);
=>
{
  name: 'mockapp',
  env: 'test',
  subdomainOffset: 2,
  config: '<egg config>',
  controller: '<egg controller>',
  service: '<egg service>',
  middlewares: '<egg middlewares>',
  urllib: '<egg urllib>',
  loggers: '<egg loggers>'
}
```

ready(flagOrFunction) → {Promise|null}

register an callback function that will be invoked when application is ready.

Parameters:
Name Type Description
flagOrFunction boolean | Error | function
Since:
  • 1.0.0
Overrides:
Source:
See:
Example
const app = new Application(...);
app.ready(err => {
  if (err) throw err;
  console.log('done');
});

readyCallback(name, opts) → {function}

If a client starts asynchronously, you can register readyCallback, then the application will wait for the callback to ready

It will log when the callback is not invoked after 10s

Recommend to use EggCore#beforeStart

Parameters:
Name Type Description
name String

readyCallback task name
opts object
  • {Number} [timeout=10000] - emit ready_timeout when it doesn't finish but reach the timeout
    • {Boolean} [isWeakDep=false] - whether it's a weak dependency
Since:
  • 1.0.0
Overrides:
Source:
Example
const done = app.readyCallback('mysql');
mysql.ready(done);

toAsyncFunction(fn) → {AsyncFunction}

Convert a generator function to a promisable one.

Notice: for other kinds of functions, it directly returns you what it is.

Parameters:
Name Type Description
fn function

The inputted function.
Overrides:
Source:
Example
```javascript
     const fn = function* (arg) {
        return arg;
      };
      const wrapped = app.toAsyncFunction(fn);
      wrapped(true).then((value) => console.log(value));
    ```

toPromise(obj) → {Promise}

Convert an object with generator functions to a Promisable one.

Parameters:
Name Type Description
obj Mixed

The inputted object.
Overrides:
Source:
Example
```javascript
     const fn = function* (arg) {
        return arg;
      };
      const arr = [ fn(1), fn(2) ];
      const promise = app.toPromise(arr);
      promise.then(res => console.log(res));
    ```

url(name, params) → {String}

Alias to Router#url

Parameters:
Name Type Description
name String

Router name
params Object

more parameters
Overrides:
Source:

use(fn) → {Application}

override koa's app.use, support generator function

Parameters:
Name Type Description
fn function

middleware
Since:
  • 1.0.0
Overrides:
Source: