xc-core v0.3.0

Install & setup

API Reference

Classes

BaseMiddlewareGql

Base class for middlewares

Kind: global class

• BaseMiddlewareGql
  • .default(req, res, next) ⇒ Promise.<void>
  • .isAllowed(roles, method, permissions, resolver) ⇒ boolean

baseMiddlewareGql.default(req, res, next) ⇒ Promise.<void>

Kind: instance method of BaseMiddlewareGql

baseMiddlewareGql.isAllowed(roles, method, permissions, resolver) ⇒ boolean

Kind: instance method of BaseMiddlewareGql

BaseResolver

Base class for graphql resolver

Kind: global class

baseResolver.mw([Function[]], cbk) ⇒ function

Kind: instance method of BaseResolver

BaseMiddleware

BaseMiddleware used for REST APIs module

Kind: global class

• BaseMiddleware
  • new BaseMiddleware(app)
  • .default(req, res, next) ⇒ Promise.<void>
  • .isAllowed(roles, method, permissions, url) ⇒ Promise.<boolean>

new BaseMiddleware(app)

baseMiddleware.default(req, res, next) ⇒ Promise.<void>

Default middleware function that gets invoked

Kind: instance method of BaseMiddleware

baseMiddleware.isAllowed(roles, method, permissions, url) ⇒ Promise.<boolean>

Determines if the method is allowed for a particular request,url and role

Kind: instance method of BaseMiddleware

BaseRouter

BaseClass for Router files in REST APIs

Kind: global class

new BaseRouter(app)

BaseService

BaseClass for service files in REST APIs module

Kind: global class

BaseComponent

Base class for a component in server

Kind: global class

baseComponent.init()

Initialisation method of component - mandatory to be implemented by the child class

Kind: instance method of BaseComponent

Components

Class to keep reference of all components in server

Kind: global class

• Components
  • new Components(components, baseDir)
  • .init() ⇒ Promise.<void>

new Components(components, baseDir)

components.init() ⇒ Promise.<void>

Initialise all component of server

Kind: instance method of Components

test