parroit/auth-token

View on GitHub
docs/auth-storage.md

Summary

Maintainability
Test Coverage


<!-- Start lib/auth-storage.js -->

auth
https://github.com/parroit/auth

Copyright (c) 2014 Andrea Parodi
Licensed under the MIT license.

## AuthStorage(options)

This object allows to manage users
within storage.

### Params: 

* **Object** *options* configuration options for object

## saveUser(user)

Save a user into storage.

### Params: 

* **Object** *user* the user object to save

### Return:

* **Object** a promise fullfilled with {status: &quot;ok&quot;}

## getUser(username)

Retrieve a user from storage by name.

### Params: 

* **String** *username* the username of the user to retrieve

### Return:

* **Object** a promise fullfilled with user object

## removeUser(username)

Remove a user from storage.

### Params: 

* **String** *username* username of user to remove

### Return:

* **Object** a promise fullfilled with {status: &quot;ok&quot;}

<!-- End lib/auth-storage.js -->