irccd  3.0.3
Public Types | Public Member Functions | Static Public Member Functions | List of all members
irccd::js::api Class Referenceabstract

Javascript API module. More...

#include <api.hpp>

Inheritance diagram for irccd::js::api:
irccd::js::chrono_api irccd::js::directory_api irccd::js::file_api irccd::js::irccd_api irccd::js::logger_api irccd::js::plugin_api irccd::js::server_api irccd::js::system_api irccd::js::timer_api irccd::js::unicode_api irccd::js::util_api

Public Types

using constructor = std::function< std::unique_ptr< api >()>
 Command constructor factory. More...
 

Public Member Functions

 api () noexcept=default
 
virtual ~api () noexcept=default
 
virtual auto get_name () const noexcept -> std::string_view=0
 
virtual void load (daemon::bot &bot, js::plugin &plugin)=0
 

Static Public Member Functions

static auto registry () noexcept -> const std::vector< constructor > &
 Registry of all commands. More...
 

Detailed Description

Javascript API module.

Member Typedef Documentation

◆ constructor

using irccd::js::api::constructor = std::function<std::unique_ptr<api> ()>

Command constructor factory.

Constructor & Destructor Documentation

◆ api()

irccd::js::api::api ( )
defaultnoexcept

Default constructor.

◆ ~api()

virtual irccd::js::api::~api ( )
virtualdefaultnoexcept

Virtual destructor defaulted.

Member Function Documentation

◆ get_name()

virtual auto irccd::js::api::get_name ( ) const -> std::string_view
pure virtualnoexcept

◆ load()

virtual void irccd::js::api::load ( daemon::bot bot,
js::plugin plugin 
)
pure virtual

◆ registry()

static auto irccd::js::api::registry ( ) -> const std::vector< constructor > &
staticnoexcept

Registry of all commands.


The documentation for this class was generated from the following file: