trailpack-waterline

3.0.1 • Public • Published

trailpack-waterline

Gitter NPM version Build status Dependency Status Code Climate

Loads Application Models (in api/models) into the Waterline ORM; Integrates with trailpack-router to generate Footprints for routes.

Usage

Configure

// config/main.js
module.exports = {
  // ...
  packs: [
    require('trailpack-waterline')
  ]
}

Query

// api/services/BirthdayService.js
module.exports = {
  /**
   * Finds people with the given birthday.
   * @return Promise
   * @example {
   *    name: 'Ludwig Beethoven',
   *    birthday: Sun Dec 16 1770 00:00:00 GMT-0500 (EST),
   *    favoriteColors: [
   *      { name: 'yellow', hex: 'ffff00' },
   *      { name: 'black', hex: '000000' }
   *     ]
   * }
   */
  findPeopleWithBirthday (birthday) {
    return this.orm.Person.find({ birthday: birthday })
      .populate('favoriteColors')
  }
}

Contributing

We love contributions! Please check out our Contributor's Guide for more information on how our projects are organized and how to get started.

License

MIT

Dependents (0)

Package Sidebar

Install

npm i trailpack-waterline

Weekly Downloads

28

Version

3.0.1

License

MIT

Last publish

Collaborators

  • trails