HyphenJs

HyphenJs, an Angular module made to simplify data model creation for Angular app.

$3

`html
bower install hyphen-js --save
`

or download source code with minified version from git hub:
[source code] (https://github.com/blazejgrzelinski/hyphen-js)

Add HyphenJs script to your html file, usually it should looks like below (when installed with npm)

`html

`

$3

`javascript
var exampleApp = angular.module('example', ['jsHyphen']);
`

$3

`javascript
jsHyphen.factory('Users', [function () {
var User = function (data) {
};

User.prototype.getFullName = function () {
return this.user_first_name + " " + this.user_last_name;
};

return User;
}]);

jsHyphen.factory('Projects', [function () {
var Project = function () {

};

return Project;
}]);

jsHyphen.factory('Teams', [function () {
var Teams = function () {

};

return Teams;
}]);
`

$3

`javascript
var hyphenConfiguration = {
"Teams": {
model: "Teams",
key: "_id",
rest: [{name: "getAll", url: "/teams", method: "get"}],
},
"Users": {
model: "Users",
key: "_id",
embedObjects: {projects: "Projects", teams: "Teams"},
rest: [
{name: "signIn", url: "/users/login", method: "post"},
{name: "update", url: "/users/update", method: "put"},
{name: "create", url: "/users/create", method: "post"},
{name: "getAll", url: "/users", method: "get"},
{name: "delete", url: "/users/:id", method: "delete"},
{name: "getOne", url: "/users/:id", method: "get"},
{name: "getUserWithParams", url: "/users/:userId/project/:projectId?age=:age", method: "get"},
{name: "getUserTwoParams", url: "/users/:id/project/:projectId", method: "get"},
{name: "removeAll", url: "/users/remove_all", method: "post"},
{name: "getUserProjects", url: "/users/user_projects", method: "get"},
{name: "getUserProjectsTeams", url: "/users/user_projects_teams", method: "get"},
{name: "getUserComplexParams", url: "/users/1/project/3?name=blazej&age=100", method: "get"},
],
},
"Projects": {
model: "Projects",
key: "_id",
embedObjects: {teams: "Teams"},
rest: [
{name: "create", url: "/projects/create", method: "post"},
{name: "getAll", url: "/projects", method: "get"},
{name: "removeAll", url: "/projects/remove_all", method: "post"},
],
}
};

`

* model - point the model for the entity
* key - key field
* embedObjects - hyphen js will traverse the data and automatically populate the models

For example for following json which is User entity, it will create one user, two projects and one team


`javascript
{
"_id": 1,
user_email: "test1@email.com",
user_first_name: "Blazej",
user_last_name: "Grzelinski",
projects: [{_id: 100, name: "Hyphen project tests"}, {
_id: 200,
name: "Hyphen projects",
teams: [{_id: 10, name: "testTeam"}]
}]
}

`

$3

`javascript
Hyphen.initialize({
model: hyphenConfiguration,
baseUrl: "",
});
`
* baseUrl is prefix added to all api calls

$3

#### Getting all users
`javascript
Hyphen.Users.api.getAll().save();
//save method saves the result in data model
`

#### Binding to model data
`html



For more examples please check test folder.

To start tests please run:
* karma start

You can bind to Hyphen "findOne" and "where" as the data are indexed and will not slow down your app.