1.1.1 • Published 9 years ago

mnkycode-user v1.1.1

Weekly downloads
3
License
MIT
Repository
github
Last release
9 years ago

MNKYCODE - User Module

Build Status Dependencies Code Climate Test Coverage

NPM

Install

  npm install -S mnkycode-user

Requirements

You need a running mongoose instance like:

var mongoose = require('mongoose');
mongoose.connect('mongodb://localhost/testing', {}, function (err) {
  if(err) throw err;
});

Usage

Create User

	var User = require('mnkycode-user')
    var data = {
      displayname: TestUser,
      password: 12351235,
      email: test@test.com
    }
    var user = new User(data)
    user.create(function(code, data){
      // on success 
      //   code = 201
      //   data = json object 
      // on exist
      //    code = 200
      //    data = null
    })

Read User

	var User = require('mnkycode-user')
	var data = {
      token: UserToken
    }
    var user = new User(data)
    user.read(function(code, data){
      // on success 
      //   code = 200
      //   data = json object 
      // on error
      //    code = 400
      //    data = null
    })

Update User

	var User = require('mnkycode-user')
	var data = {
      token: UserToken,
      email: 'new@email.com',
      password: 'newMasterPassword'
    }
    var user = new User(data)
    user.update(function(code, data){
      // on success 
      //   code = 200
      //   data = json object 
      // on error
      //    code = 400
      //    data = null
    })

Delete User

	var User = require('mnkycode-user')
	var data = {
      token: UserToken
    }
    var user = new User(data)
    user.update(function(code, data){
      // on success 
      //   code = 200
      //   data = json object 
      // on exist
      //    code = 400
      //    data = null
    })

Login User

	var User = require('mnkycode-user')
	var data = {
      displayname: UserDisplayname,
      password: UserPassword
    };
    var user = new User(data);
    user.login(function(code, data){
      // on success 
      //   code = 200
      //   data = json object 
      // on exist
      //    code = 400
      //    data = null
    })

Logout User

	var User = require('mnkycode-user')
	var data = {
      displayname: UserDisplayname,
      password: UserPassword
    };
    var user = new User(data);
    user.logout(function(code, data){
      // on success 
      //   code = 200
      //   data = true 
      // on exist
      //    code = 400
      //    data = null
    })

Schema

NameTypeDescription
displaynameString-
usernameStringdisplayname.toLowerCase()
emailString-
passwordStringpbkdf2
tokenStringJWT
signupDateDate.now()

Test

npm test
1.1.1

9 years ago

1.1.0

9 years ago

1.0.2

9 years ago

1.0.1

9 years ago

1.0.0

9 years ago