Commit 3c73b7c1 authored by Alex Clavelle's avatar Alex Clavelle
Browse files

Update README.md

parent 3adc8625
(WIP)_ Typescript definitions for the [sails.js](https://github.com/balderdashy/sails) web framework. (WIP) Typescript definitions for the [sails.js](https://github.com/balderdashy/sails) web framework.
Overview: **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. 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(for now_) 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. 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. 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.
...@@ -26,11 +26,11 @@ Records: A record corresponds to a single row in the database. ...@@ -26,11 +26,11 @@ Records: A record corresponds to a single row in the database.
Usage: **Usage:**
todo, check the tests todo
Mappings: **Mappings:**
todo, check the code todo, check the code
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment