README
fake-users
This is a simple package to manage an array of Users.
Installation
$ npm install fake-users
API
var fakeUsers = require('fake-users')
The fakeUsers object exposes various methods to manage a JSON array of Users.
The starter array is like this:
[
{
"name": "Damiano",
"surname": "Calia",
"dateOfBirth": "23/05/1997",
"email": "damiano@gmail.com",
"id": 1
},
{
"name": "Pippo",
"surname": "Baudo",
"dateOfBirth": "24/08/1931",
"email": "pippo.baudo@gmail.com",
"id": 2
},
{
"name": "Mario",
"surname": "Balotelli",
"dateOfBirth": "23/05/1981",
"email": "mariobalotelli@email.com",
"id": 3
},
{
"name": "Damiano",
"surname": "Balotelli",
"dateOfBirth": "24/08/1931",
"email": "damianobalotelli@email.com",
"id": 4
}
]
You can use these methods to manage the array:
fakeUsers.getAll();
/*
Returns all the Users.
*/
fakeUsers.getUserById(id);
/*
Returns the User with the specified id or null if not found.
*/
fakeUsers.getUsersByPropertyValue(propertyName, value);
/*
Returns a filtered array with the Users matching the
specified value in the specified propertyName.
The propertyName parameter must be a String ('name',
'surname', 'dateOfBirth', or 'email').
It returns an empty array if the search does not match
any User.
*/
fakeUsers.addUser(newUser);
/*
Push a new User at the end of the array, newUser must
be an object with 4 properties: name, surname,
dateOfBirth and email.
This method returns the new user added, or null if the
newUser object does not contain the correct properties.
*/
fakeUsers.deleteUser(id);
/*
Delete the User with the specified id and returns it.
This method return null if the user to delete is not
found.
*/
fakeUsers.modifyUser(id, obj);
/*
Modify the User with the specified id and returns it.
The obj parameter is an User object and must
contains only the properties (name, surname,
dateOfBirth or email) to modify.
This method return null if the user to modify is
not found.
*/
fakeUsers.reset();
/*
This method restores the User array at the initial state
and returns it.
*/
Known issues
..* At the moment the package does not check the correct format of email, dateOfBirth, ecc.