# periodicjs.ext.user_access_control

> A user access control extension for Periodicjs that uses user roles and user privleges to controll access

Latest version **10.0.3** (published 2019-04-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install periodicjs.ext.user_access_control
pnpm add periodicjs.ext.user_access_control
yarn add periodicjs.ext.user_access_control
bun add periodicjs.ext.user_access_control
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 10.0.3 |
| Published | 2019-04-30 |
| First published | 2014-08-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | ^6.x |
| Dependencies | 0 |
| Unpacked size | 239.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 0 |
| Author | Yaw Joseph Etse |
| Maintainers | janbialostok, yawetse |
| Keywords | periodicjs, user access control, uac |

## Links

- npm: https://www.npmjs.com/package/periodicjs.ext.user_access_control
- Repository: https://github.com/typesettin/periodicjs.ext.user_access_control
- Homepage: https://github.com/typesettin/periodicjs.ext.user_access_control#readme
- npm.io page: https://npm.io/package/periodicjs.ext.user_access_control

## Recent versions

- 10.0.3 (latest) — 2019-04-30
- 10.0.2 — 2017-10-24
- 10.0.1 — 2017-10-21
- 10.0.0 — 2017-10-21
- 9.0.3 — 2017-08-13
- 9.0.2 — 2017-07-27
- 9.0.1 — 2017-07-22
- 9.0.0 — 2017-07-22
- 7.1.0 — 2017-01-31
- 7.0.1 — 2016-05-13
- 7.0.0 — 2016-02-03
- 5.9.3 — 2015-08-04
- 5.9.21 — 2015-08-03
- 5.9.2 — 2015-08-03
- 5.9.1 — 2015-08-02
- … 20 more at https://npm.io/package/periodicjs.ext.user_access_control/versions

## README

# periodicjs.ext.user_access_control [![Coverage Status](https://coveralls.io/repos/github/githubUserOrgName/periodicjs.ext.user_access_control/badge.svg?branch=master)](https://coveralls.io/github/githubUserOrgName/periodicjs.ext.user_access_control?branch=master) [![Build Status](https://travis-ci.org/githubUserOrgName/periodicjs.ext.user_access_control.svg?branch=master)](https://travis-ci.org/githubUserOrgName/periodicjs.ext.user_access_control)

A simple extension.

[API Documentation](https://github.com/githubUserOrgName/periodicjs.ext.user_access_control/blob/master/doc/api.md)

## Usage

### CLI TASK

You can preform a task via CLI
```
$ cd path/to/application/root
### Using the CLI
$ periodicjs ext periodicjs.ext.user_access_control hello  
### Calling Manually
$ node index.js --cli --command --ext --name=periodicjs.ext.user_access_control --task=hello 
```

## Configuration

You can configure periodicjs.ext.user_access_control

### Default Configuration
```javascript
{
  settings: {
    defaults: true,
  },
  databases: {
  },
};
```


## Installation

### Installing the Extension

Install like any other extension, run `npm run install periodicjs.ext.user_access_control` from your periodic application root directory and then normally you would run `periodicjs addExtension periodicjs.ext.user_access_control`, but this extension does this in the post install npm script.
```
$ cd path/to/application/root
$ npm run install periodicjs.ext.user_access_control
$ periodicjs addExtension periodicjs.ext.user_access_control //this extension does this in the post install script
```
### Uninstalling the Extension

Run `npm run uninstall periodicjs.ext.user_access_control` from your periodic application root directory and then normally you would run `periodicjs removeExtension periodicjs.ext.user_access_control` but this extension handles this in the npm post uninstall script.
```
$ cd path/to/application/root
$ npm run uninstall periodicjs.ext.user_access_control
$ periodicjs removeExtension periodicjs.ext.user_access_control // this is handled in the npm postinstall script
```


## Testing
*Make sure you have grunt installed*
```
$ npm install -g grunt-cli
```

Then run grunt test or npm test
```
$ grunt test && grunt coveralls #or locally $ npm test
```
For generating documentation
```
$ grunt doc
$ jsdoc2md commands/**/*.js config/**/*.js controllers/**/*.js  transforms/**/*.js utilities/**/*.js index.js > doc/api.md
```
## Notes
* Check out https://github.com/typesettin/periodicjs for the full Periodic Documentation

---
_Source: https://npm.io/package/periodicjs.ext.user_access_control · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._