sails-hook-nested/README.md

Nested attributes for sails models.

<a href="http://stojadinovic.net">
  <img alt="Predrag Stojadinovic" src="https://en.stojadinovic.net/assets/images/logo-128x128-88.jpg" width="100">
</a>

## sails-hook-nested
[![build status](https://img.shields.io/travis/cope/sails-hook-nested.svg?branch=master)](https://travis-ci.org/cope/sails-hook-nested)
[![codacy](https://img.shields.io/codacy/grade/60322e02d8df469893dbb8c0a89e5cc8.svg)](https://www.codacy.com/project/cope/sails-hook-nested/dashboard)
[![coverage](https://img.shields.io/coveralls/github/cope/sails-hook-nested/master.svg)](https://coveralls.io/github/cope/sails-hook-nested?branch=master)
[![dependencies](https://david-dm.org/cope/sails-hook-nested.svg)](https://www.npmjs.com/package/sails-hook-nested)
[![npm](https://img.shields.io/npm/dt/sails-hook-nested.svg)](https://www.npmjs.com/package/sails-hook-nested)

Nested attributes for sails models.

---

### TODO
* Test deep nested attributes
* Change from [forgJs syntax](https://github.com/oussamahamdaoui/forgJs) to regular [sails attribute types](https://sailsjs.com/documentation/concepts/models-and-orm/attributes)

### Getting started

Add a nested object/array definitions to your model.

These attributes **must** conform to the [forgJs](https://github.com/oussamahamdaoui/forgJs) syntax, for now!

```js
module.exports = {
	attributes: {

		// nested attributes definitions
		arrayOfObjects: {
			type: 'nested_array',
			of: {
				wa: {type: 'int', optional: true},
				res: {type: 'string'},
				entry: {type: 'int'},
				correct: 'boolean',
				deep: {
					type: 'nested_object',
					of: {
						ten: {type: 'int', min: 0, max: 10, optional: true},
						shoo: {type: 'string', minLength: 6, maxLength: 22},
						maybe: 'boolean',
						deepArray: {
							type: 'nested_array',
							of: {
								wa: {type: 'int', optional: true},
								res: {type: 'string'},
								entry: {type: 'int'},
								correct: 'boolean',
								deeper: {
									type: 'nested_object',
									of: {
										ten: {type: 'int', min: 0, max: 10, optional: true},
										shoo: {type: 'string', minLength: 6, maxLength: 22},
										maybe: 'boolean',
										evenDeeper: {
											type: 'nested_object',
											of: {
												ten: {type: 'int', min: 0, max: 10, optional: true},
												shoo: {type: 'string', minLength: 6, maxLength: 22},
												maybe: 'boolean'
											}
										}
									}
								}
							},
							required: true
						}
					}
				}
			},
			required: true
		},
		nestedAttributes: {
			type: 'nested_object',
			of: {
				ten: {type: 'int', min: 0, max: 10, optional: true},
				shoo: {type: 'string', minLength: 6, maxLength: 22},
				maybe: 'boolean',
				deep: {
					type: 'nested_object',
					of: {
						ten: {type: 'int', min: 0, max: 10, optional: true},
						shoo: {type: 'string', minLength: 6, maxLength: 22},
						maybe: 'boolean',
						deeper: {
							type: 'nested_object',
							of: {
								ten: {type: 'int', min: 0, max: 10, optional: true},
								shoo: {type: 'string', minLength: 6, maxLength: 22},
								maybe: 'boolean',
								evenDeeper: {
									type: 'nested_object',
									of: {
										ten: {type: 'int', min: 0, max: 10, optional: true},
										shoo: {type: 'string', minLength: 6, maxLength: 22},
										maybe: 'boolean'
									}
								}
							}
						}
					}
				}
			}
		},

		// regular sails attributes
		num: {
			type: 'number'
		},
		word: {
			type: 'string'
		}
	}
};