trails-api
TypeScript icon, indicating that this package has built-in type declarations

2.0.1 • Public • Published

trails-api

Trails classes with typings definitions for TS usage

Gitter NPM version NPM downloads Dependency Status Code Climate

Usage

Installation

npm i --save trails-api

Classes that are exported by this module and use in TS:

  • Controller from trails-controller
  • Service from trails-service
  • Model from trails-model
  • Policy from trails-policy
  • TrailsApp from trails

In JS

'use strict'

const Controller = require('trails-api').Controller

/**
 * @module DefaultController
 *
 * @description Default Controller included with a new Trails app
 * @see {@link http://trailsjs.io/doc/api/controllers}
 * @this TrailsApp
 */
module.exports = class DefaultController extends Controller {

  /**
   * Return some info about this application
   */
  info(req, res) {
    res.status(200).json(this.app.services.DefaultService.getApplicationInfo())
  }
}

In TS

import {Request, Response} from 'express';
import { Controller } from 'trails-api';

/**
 * @module DefaultController
 *
 * @description Default Controller included with a new Trails app
 * @see {@link http://trailsjs.io/doc/api/controllers}
 * @this TrailsApp
 */
export class DefaultController extends Controller {
  /**
   * Return some info about this application
   */
  info(req: Request, res: Response ) {
    res.status(200).json(this.app.services.DefaultService.getApplicationInfo())
  }
}

License

MIT

Readme

Keywords

none

Package Sidebar

Install

npm i trails-api

Weekly Downloads

0

Version

2.0.1

License

MIT

Last publish

Collaborators

  • mylisabox