# va-common

> va sciences common utility package

Latest version **1.1.0** (published 2021-06-04) · ISC license · 0 weekly downloads

## Install

```sh
npm install va-common
pnpm add va-common
yarn add va-common
bun add va-common
```

## 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.1.0 |
| Published | 2021-06-04 |
| First published | 2021-02-23 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 106.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | v.liu |
| Maintainers | v.liu |

## Links

- npm: https://www.npmjs.com/package/va-common
- Repository: https://github.com/VA-Sciences/va-common
- Homepage: https://github.com/VA-Sciences/va-common#readme
- Issues: https://github.com/VA-Sciences/va-common/issues
- npm.io page: https://npm.io/package/va-common

## Recent versions

- 1.1.0 (latest) — 2021-06-04
- 1.0.9 — 2021-06-04
- 1.0.8 — 2021-04-01
- 1.0.7 — 2021-03-12
- 1.0.6 — 2021-03-12
- 1.0.5 — 2021-03-12
- 1.0.4 — 2021-03-12
- 1.0.3 — 2021-03-03
- 1.0.2 — 2021-03-03
- 1.0.1 — 2021-02-23
- 1.0.0 — 2021-02-23

## README

# VA SCIENCES Common utility for JavaScript



### Add dependeny in ```package.json```
```json
"dependencies": {
    "va-common": "^1.0.1"
}
```
### Import
```javascript

const VA = require('va-common');
const SLSRoleChecker = VA.SLSRoleChecker;
const statusCode = VA.statusCode;
const SLSResponse = VA.SLSResponse;
const SLSQueries = VA.SLSQueries;
const SLSValidator = VA.SLSValidator;
```

### Examples
```SLSRoleChecker```  

```javascript
// @params: String role (USER, ADMIN, MASTER, LAB_USER)
// @return: boolean
  SLSRoleChecker.isAdminRole(role);
  SLSRoleChecker.isLabUserRole(role);
  SLSRoleChecker.isMasterRole(role);
  SLSRoleChecker.isUserRole(role);
```
```statusCode```
```javascript

  statusCode.SUCCESSFUL_CODE
  statusCode.CLIENT_ERROR_CODE
  statusCode.SERVER_ERROR_CODE

```
```SLSResponse```
```javascript
// return an object  
 SLSResponse(statusCode.SUCCESSFUL_CODE, "message", {})

```
```SLSQueries```
```javascript
// return a query string
 SLSQueries.findRoleCodeByUserId


 //example
 let result = await client.query(SLSQueries.findRoleCodeByUserId, [userId]);

```

```SLSValidator```
```javascript
// @params String email
// @return boolean
SLSValidator.isEmailAddress(email)

```

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