https://github.com/coderaiser/node-userito
manage users from database or json
https://github.com/coderaiser/node-userito
Last synced: 9 months ago
JSON representation
manage users from database or json
- Host: GitHub
- URL: https://github.com/coderaiser/node-userito
- Owner: coderaiser
- License: mit
- Created: 2015-06-19T16:55:53.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2022-08-01T12:38:05.000Z (over 3 years ago)
- Last Synced: 2025-05-19T16:11:40.515Z (11 months ago)
- Language: JavaScript
- Homepage:
- Size: 77.1 KB
- Stars: 3
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog
- License: LICENSE
Awesome Lists containing this project
README
# Userito [![License][LicenseIMGURL]][LicenseURL] [![NPM version][NPMIMGURL]][NPMURL] [![Build Status][BuildStatusIMGURL]][BuildStatusURL]
[NPMIMGURL]: https://img.shields.io/npm/v/userito.svg?style=flat
[BuildStatusURL]: https://github.com/coderaiser/node-userito/actions?query=workflow%3A%22Node+CI%22 "Build Status"
[BuildStatusIMGURL]: https://github.com/coderaiser/node-userito/workflows/Node%20CI/badge.svg
[LicenseIMGURL]: https://img.shields.io/badge/license-MIT-317BF9.svg?style=flat
[NPMURL]: https://npmjs.org/package/node-userito "npm"
[LicenseURL]: https://tldrlegal.com/license/mit-license "MIT License"
Manage users from database or json.
Userito could work with users in:
- `json` file
- `mongodb` database
## Install
`npm i userito -g`
## API
### Initialization
`userito` takes `options` object with properties:
- `type` (`db` or `file`) and
- `path` path of storage file (`~/.userito.json` default)
- `db` with database url
- `schema`
```js
const useritoFile = require('userito')({
type: 'file',
});
const useritoDB = require('userito')({
type: 'db',
db: 'mongodb://login:password@dsxxxx.mongolab.com:43942/userito',
schema: {
port: Number,
username: String,
password: String,
},
});
```
### userito.all(callback)
Get all existing users.
```js
userito.all((error, users, info) => {
console.log(error || info || users);
});
```
### userito.get(username, callback)
Get user by `username`.
```js
userito.get('coderaiser', (error, user, info) => {
console.log(error || info || users);
});
```
### userito.create(data, callback)
Create user.
```js
userito.create({
username: 'coderaiser',
password: 'hello',
}, (error, msg) => {
console.log(error || msg);
});
```
### userito.update(username, data, callback)
Modify user named with `username`.
```js
userito.update('coderaiser', {
password: 'world',
}, (error, msg) => {
console.log(error || msg);
});
```
### userito.remove(username, callback)
Remove user.
```js
userito.remove('coderaiser', (error, info) => {
console.log(error || info || msg);
});
```
## License
MIT