ttomasini/sails-types
0
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

updated readme because of fork

Browse source
This commit is contained in:
Timo Tomasini 2016-12-08 12:36:26 +01:00 committed by GitHub
parent 3c73b7c11c
commit cb497a41f1
1 changed files with 8 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -1,36 +1,22 @@
(WIP) Typescript definitions for the [sails.js](https://github.com/balderdashy/sails) web framework.
**Overview:**
# (WIP) Typescript definitions for the [sails.js](https://github.com/balderdashy/sails) web framework.
_forked from [Alex Clavelle's github repository](https://github.com/aclave1/sails-types)_
## Overview
sails.js is a node.js mvc web framework. The two main pieces of a sails app are the Models, and Controllers. The views can be interchanged between multiple view engines. They aren't sails specific so don't require any type mappings.
**Requirements:**
## Requirements
Requires the express,bluebird, and socket.io type mappings. Eventually, we'll merge this with definitely typed and use tsd, but for now, just install everything manually.
**Controllers:**
## Controllers
Each controller action is passed two parameters,an express request object, and an express response object. The request and response objects have been extended by the sails framework to add custom functionality. The main controller type definitions are for the extensions to the request and response objects.
**Models:**
## Models
A sails Model is a static class with methods like create, update, and find which correspond to operations on the database. These operations return Records.
Records: A record corresponds to a single row in the database.
**Usage:**
## Usage
todo
**Mappings:**
## Mappings
todo, check the code