lockit-mongodb-adapter

save(name, email, pw, done)

Create new user.

name String - User name
email String - User email
pw String - Plain text user password
done function - Callback function function(err, user){}

Example

adapter.save('john', 'john@email.com', 'secret', function(err, user) {
  if (err) console.log(err);
  console.log(user);
  // {
  //  name: 'john',
  //  email: 'john@email.com',
  //  signupToken: 'ef32a95a-d6ee-405a-8e4b-515b235f7c54',
  //  signupTimestamp: Wed Jan 15 2014 19:08:27 GMT+0100 (CET),
  //  signupTokenExpires: Wed Jan 15 2014 19:08:27 GMT+0100 (CET),
  //  failedLoginAttempts: 0,
  //  salt: '48cf9da376703199c30ba5c274580c98',
  //  derived_key: '502967e5a6e55091f4c2c80e7989623f051070fd',
  //  _id: 52d6ce9b651b4d825351641f
  // }
});

find(match, query, done)

Find user. Match is either 'name', 'email' or 'signupToken'.

match String - Property to find user by. 'name', 'email' or 'signupToken'
query String - Corresponding value to match
done function - Callback function function(err, user){}

Example

adapter.find('name', 'john', function(err, user) {
  if (err) console.log(err);
  console.log(user);
  // {
  //   name: 'john',
  //   email: 'john@email.com',
  //   signupToken: '3a7f0f54-32f0-44f7-97c6-f1470b94c170',
  //   signupTimestamp: Fri Apr 11 2014 21:31:54 GMT+0200 (CEST),
  //   signupTokenExpires: Sat Apr 12 2014 21:31:54 GMT+0200 (CEST),
  //   failedLoginAttempts: 0,
  //   salt: '753981e8d8e30e8047cf5685d1f0a0d4',
  //   derived_key: '18ce03eddab6729aeaaf76729c90cb31f16a863c',
  //   _id: 5348432a98a8a6a4fef1f595
  // }
});

update(user, done)

Update existing user.

user Object - Existing user from db
done function - Callback function function(err, user){}

Example

// get user from db
adapter.find('name', 'john', function(err, user) {
  if (err) console.log(err);

  // add some new properties
  user.newKey = 'and some value';
  user.hasBeenUpdated = true;

  // save updated user to db
  adapter.update(user, function(err, user) {
    if (err) console.log(err);
    // ...
  });
});

remove(name, done)

Delete existing user.

name String - User name
done function - Callback function function(err, res){}

Example

adapter.remove('john', function(err, res) {
  if (err) console.log(err);
  console.log(res);
  // true
});