Backend Package

Classes

MeetznowService

The Class is the base structure of every Service in our Backend. All Service Names are defined in src\Service.ts. A Service provides you with the Server and a Logger.

• new Service(serviceName : Service)
  Constructor returns a Service but does not start it. The Service Name are defined in src/Services

• start(service : Service) : Promise
  Static function to start the Service.

• Service.getLogger(namespace? : string)
  Returns a new Logger with given Namespace

• Service.addHandler <RequestPayload extends BaseRequestPayload, ResponsePayload extends BaseResponsePayload, RequestHandler extends Handler<RequestPayload, ResponsePayload>>(handler : RequestHandler)
  Adds a new Handler

Handler

Abstract Class to define the base Structure of our Handlers. The Handlers a used to define routes and what happens if they are accessed.

• handle(data: Request, logger : Logger) : Promise<Response>
  given Function for all Handlers to handle the logging of request and surround the code where the request is processed to catch errors.

• getHandlerName() : String
  Defines the Handler Name

• getResult(data: Request) : Promise
  Abstract class to process the request.

Logger

Class that handles the Logging. The logs will be shown in the console of the service and send to Discord.

• Logger.apiRequest(request : Request, response : Response,handlerName:String)
  Logs a complete Request with Response to the apiRequest channel.
• Logger.request(request : Request, response : Response,handlerName:String)
  Logs a complete Request with Response to the Request channel.

The Following Calls are all logging the data you insert in the category and Channel that correspond with their name

• Logger.info(id : ApiCallID, msg : string, ...optionalParams: any[])
• Logger.debug(id : ApiCallID, msg : string, ...optionalParams: any[])
• Logger.warn(id : ApiCallID, msg : string, ...optionalParams: any[])
• Logger.error(id : ApiCallID, msg : string, ...optionalParams: any[])
• Logger.fatal(id : ApiCallID, msg : string, ...optionalParams: any[])

Build New Service

To build a new Service you first have to add a new Service in the Service.ts file. Then you can start a new Node.js Project and add this Package. Then you include the Service and start it as described above.