Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/logisticinfotech/sails1-actions2-examples
Sails JS Actions2 examples with CRUD and helper function
https://github.com/logisticinfotech/sails1-actions2-examples
action crud sails sails-action2 sails-helper sails-js-actions2 sails1-action2-demo sails1-action2-example sailsjs sailsjs-action2
Last synced: 3 months ago
JSON representation
Sails JS Actions2 examples with CRUD and helper function
- Host: GitHub
- URL: https://github.com/logisticinfotech/sails1-actions2-examples
- Owner: logisticinfotech
- Created: 2018-12-15T12:56:14.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-01-22T18:06:10.000Z (about 6 years ago)
- Last Synced: 2024-04-09T22:32:16.738Z (10 months ago)
- Topics: action, crud, sails, sails-action2, sails-helper, sails-js-actions2, sails1-action2-demo, sails1-action2-example, sailsjs, sailsjs-action2
- Language: JavaScript
- Homepage: https://www.logisticinfotech.com/blog/sails-js-actions2-example-with-crud/
- Size: 232 KB
- Stars: 8
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Introduction
This blog is for Sails JS actions2 examples with crud and helper function, this includes how to use GET POST PUT DELETE with actions2. Example of exits and intercept is included.
you can check [this blog](https://www.logisticinfotech.com/blog/sails-js-actions2-example-with-crud/) for step by step explaination.
# Steps
### Install sails js globally
[npm install sails -g](https://sailsjs.com/get-started)
### Create your app
##### sails new sails-1-actions-2-examples
and select type of project (i've choose to empty project)
after that just fire '`sails lift`' and browse localhost:1337
you can use [nodemon](https://nodemon.io/) for automatic restarting of application.
### lets create simple crud example with action2
we will use [sails generate](https://sailsjs.com/documentation/reference/command-line-interface/sails-generate) (sails cli) commands to generate actions,models etc.
##### we should add model default attribute
open: /config/models.js file and inside attributes object just add this fields
```
attributes: {
createdAt: { type: 'number', autoCreatedAt: true, },
updatedAt: { type: 'number', autoUpdatedAt: true, },
id: { type: 'number', autoIncrement: true, },
},
```
now this fields will add automatically in every model
we will also uncomment this (development use only)
=> `migrate: 'alter',` (this will alter our database if needed)
##### Create our first model with
=> `sails generate model user`
now we will add attributes to our model (/api/models/User.js)
```
module.exports = {
attributes: {
firstName: {
type: 'string',
required: true,
},
lastName: {
type: 'string',
required: true,
},
email: {
type: 'string',
required: true,
unique: true,
isEmail: true,
},
password: {
type: 'string',
required: true,
protect: true
},
}
}
```
##### now we will generate our first action for create user
=> `sails generate action api/user/create`
this will generate file inside user folder: api/controllers/api/user/create.js
##### we also need declare route inside router.js (config/routes.js)
=> `'POST /api/v1/user/create': { action: 'api/user/create' },`
##### adding validation with action2
instead of using regular res and req in sails v1 we will use inputs and exits
inside inputs object just add following
(this validation will return error itself if invalid data received).
```
inputs: {
firstName: {
type: 'string',
required: true,
},
lastName: {
type: 'string',
required: true,
},
email: {
required: true,
unique: true,
type: 'string',
isEmail: true,
},
password: {
required: true,
type: 'string',
maxLength: 15,
minLength: 6,
},
},
```
you can also set custom exits (for ex. return invalid with status code 409)
```
exits: {
invalid: {
statusCode: 409,
description: 'firstname, lastname, email and password is required.'
},
},
```
# Create
we will use waterline's create with our model name
we can get parameters value with inputs (for ex.inputs.firstName);
```
fn: async function (inputs, exits) {
var userRecord = await User.create({
firstName: inputs.firstName,
lastName: inputs.lastName,
email: inputs.email,
password: inputs.password,
});
if (!userRecord) {
return exits.invalid({
message: 'invalid'
});
}
return exits.success({
message: 'User has been created successfully.',
data: userRecord
});
}
};
```
if userRecord created successfully we will return success message with user data.
##### tip: you can intercept response
if email id is not unique our model driver will return error with code 'E_UNIQUE'
you can intercept and send your own message like this
```
.intercept('E_UNIQUE', (err) => {
return exits.invalid({
message: 'invalid',
err: err
});
})
.fetch();
```
--------------
#### I have created a [POSTMAN](https://www.getpostman.com/collections/8ca6ae07e1ceaf68b4aa) for all api calls.
# Here is our detailed [blog](https://www.logisticinfotech.com/blog/sails-js-actions2-example-with-crud/) regarding Update, View, Delete functions