Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Adapter

Adapter base class, extended for different types of adapters. Mock base adapter for testing return instance types.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • Create an adapter instance. Adapter modules should export a use method that accepts the bot, to provide to their adapter class constructor, returning the instance. Create an adapter instance. Adapter modules should export a use method that accepts the bot, to provide to their adapter class constructor, returning the instance.

    Parameters

    Returns Adapter

Properties

bot

bot: Bot

name

name: string = "mock-adapter"

Name of adapter, used for logs

Methods

Abstract shutdown

  • shutdown(): Promise<void>
  • shutdown(): Promise<void>
  • shutdown(): Promise<void>

  • Returns Promise<void>

  • Returns Promise<void>

  • Extend to add any bot shutdown requirements in adapter environment

    Returns Promise<void>

Abstract start

  • start(): Promise<void>
  • start(): Promise<void>
  • start(): Promise<void>

  • Returns Promise<void>

  • Returns Promise<void>

  • Extend to add any bot startup requirements in adapter environment

    Returns Promise<void>

Generated using TypeDoc