@eggjs/background-task

@eggjs/background-task

install

npm i --save @eggjs/background-task

Usage

import { BackgroundTaskHelper } from '@eggjs/background-task';

@ContextProto()
export default class BackgroundService {
  @Inject()
  private readonly backgroundTaskHelper: BackgroundTaskHelper;

  async backgroundAdd() {
    this.backgroundTaskHelper.run(async () => {
      // do the background task
    });
  }
}

Background

tegg release the request context after request is done. So use the process.nextTick, setTimeout, setInterval in request is not safe. Please use the backgroundTaskHelper, the release process will wait all the background tasks are done.

Timeout

The release process will wait tasks done, but not forever. The default timeout is 5s, if task will cost more than 5s, two ways to resolve

• use the SingletonProto to do the work, SingletonProto never release
• set longer timeout to backgroundTaskHelper.timeout