Class KitsasAddon

Kitsas Addon Class

First create an instance of this class, add all the routers and then call the start method.

Index

Constructors

Methods

baseUrl createRouter getApp getConnection start

Constructors

constructor

new KitsasAddon(options?): KitsasAddon
Constructor for KitsasAddon
Parameters
- options: AddonOptions = {}
  Options for the addon. Most of the options are configurable via environment variables too.
Returns KitsasAddon
See
AddonOptions
- Defined in src/kitsasAddon.ts:51

Methods

baseUrl

baseUrl(): string
Returns string
- Defined in src/kitsasAddon.ts:207

createRouter

createRouter(path?, useMiddleWare?): Router
Create a new router

Remember to include the routers in the start method
Parameters
- path: string = '/addon'
  Path to route, default is /addon
- useMiddleWare: boolean = true
  Use middleware, default is true. Set to false with webhooks etc.
Returns Router
Router
- Defined in src/kitsasAddon.ts:297

getApp

getApp(): Express
Get the express app

Returns Express
The express app
- Defined in src/kitsasAddon.ts:203

getConnection

getConnection(): KitsasConnectionInterface
Returns KitsasConnectionInterface
- Defined in src/kitsasAddon.ts:215

start

start(routers): void
Start the addon server
Parameters
- routers: Router[]
  Routers to use
Returns void
- Defined in src/kitsasAddon.ts:119