# mscp-user

> Requirements: - A running mscp-metadata service

Latest version **1.0.2** (published 2018-10-17) · 0 weekly downloads

## Install

```sh
npm install mscp-user
pnpm add mscp-user
yarn add mscp-user
bun add mscp-user
```

## 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 | 1.0.2 |
| Published | 2018-10-17 |
| First published | 2017-02-28 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 14.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | palantus |

## Links

- npm: https://www.npmjs.com/package/mscp-user
- npm.io page: https://npm.io/package/mscp-user

## Dependencies (2)

- [mscp](https://npm.io/package/mscp.md) *
- [node-uuid](https://npm.io/package/node-uuid.md) *

## Recent versions

- 1.0.2 (latest) — 2018-10-17
- 1.0.1 — 2017-08-14
- 1.0.0 — 2017-02-28

## README

# User handler for MSCP services

Requirements:
- A running mscp-metadata service

Include it as a handler:
```
let mscp = new MSCP({"": require("./handler.js"), "user": require("mscp-user")})
```

In handlers needing to check for username:

```
const User = require("mscp-user")
async init(){
  ....
  this.username = User.getUsernameFromHandlerRequest(this)
  ...
}
async validateAccess(functionName){
  return this.username ? true : false
}
```

Don't forget to add the function login (and optionally createUser and isLoggedIn) to your service in the namespace "user".

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