Options
All
  • Public
  • Public/Protected
  • All
Menu

Celery client. Supports Redis and RabbitMQ message brokers and Redis and RPC result backends.

Hierarchy

  • Client

Index

Constructors

Methods

Constructors

constructor

  • new Client(__namedParameters: object): Client
  • Parameters

    • __namedParameters: object

    Returns Client

    A Client ready to begin creating tasks.

Methods

createTask

  • createTask<T>(name: string): Task<T>
  • Type parameters

    • T

    Parameters

    • name: string

      The name of the task to execute.

    Returns Task<T>

    A Task ready to be invoked.

disconnect

  • disconnect(): Promise<void>
  • Forcefully disconnects from message brokers and the result backend.

    Returns Promise<void>

end

  • end(): Promise<void>
  • Gently disconnect from message brokers and the result backend.

    Returns Promise<void>

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc