# @appveen/utils

> appveen utils library

Latest version **6.13.10-2.3** (published 2026-11-19) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install @appveen/utils
pnpm add @appveen/utils
yarn add @appveen/utils
bun add @appveen/utils
```

## Health

**Score 55/100 (C)** — status: active.

Positive: no vulnerabilities; recently updated; high maintenance score.

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

## Facts

| | |
|---|---|
| Version | 6.13.10-2.3 |
| Published | 2026-11-19 |
| First published | 2018-11-15 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 28.7 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jerry M. |
| Maintainers | appveen |

## Links

- npm: https://www.npmjs.com/package/@appveen/utils
- Repository: https://github.com/appveen/utils
- Homepage: https://github.com/appveen/utils.git#readme
- Issues: https://github.com/appveen/utils/issues
- npm.io page: https://npm.io/package/@appveen/utils

## Dependencies (7)

- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [log4js](https://npm.io/package/log4js.md) ^6.5.2
- [ioredis](https://npm.io/package/ioredis.md) ^6.0.0
- [bluebird](https://npm.io/package/bluebird.md) ^3.5.3
- [file-type](https://npm.io/package/file-type.md) ^16.5.3
- [read-chunk](https://npm.io/package/read-chunk.md) ^3.2.0
- [@datanimbus/mongoose](https://npm.io/package/@datanimbus/mongoose.md) ^6.13.10

## Recent versions

- 6.13.10-2.3 (latest) — 2026-11-19
- 6.13.10-2.2 — 2025-10-14
- 6.13.10 — 2025-10-10
- 2.2.1 — 2023-10-23
- 2.2.0 — 2023-10-16
- 2.1.13 — 2023-01-09
- 2.1.12 — 2022-09-21
- 2.1.11 — 2022-09-21
- 2.1.10 — 2022-09-20
- 3.0.2 — 2022-09-20
- 2.1.9 — 2022-08-09
- 2.1.8 — 2022-07-25
- 3.0.1 — 2022-07-25
- 3.0.0 — 2022-07-25
- 2.1.7 — 2022-06-22
- … 30 more at https://npm.io/package/@appveen/utils/versions

## README

# # utils
This library contains various utility modules to ease development work.

1. __counter__: Module to generate unique ID.
    1. __transactionIdGenerator:__ returns a function which can be used in a mongoose schema pre save hook to generate a unique universalTransactionId.
    2. __transactionIdGeneratorParallel:__ returns a function which can be used in a mongoose schema pre save hook to generate a unique universalTransactionId. This function should be used when hook is used in parallel middleware.
    3. __getIdGenerator:__ returns a function which can be used in a mongoose schema pre save hook to generate a unique id for each document in a specific collection. It takes two arguments: 1. prefix 2. collectionName  
    4. __setDefaults:__ function to set default startValue of Id generated by getIdGenerator. It takes two arguments: 1. collectionName 2. defaultValue
    5. __getCount:__ increments the count of Id and triggers a callback specified in the argument. It takes three arguments 1. collectionName 2. expiry of Id(can be null) 3. callback function
2. __cache__: Helper functions to use [Redis](https://redis.io) as a cache for user sessions
    1. uuid() : Generates a UUID without “-“
    2. addToken(_token, _default, _uuidOfUI, _expiry) : Add a new user token with the UUID for UI session with expiry
    3. addUISessions(_uuidOfUI, _token, _uiHeartbeatTimeOut): Start tracing a UI session
    4. handleHeartBeat(_uuidOfUI, _token, _uiHeartbeatTimeOut): handle heartbeats from UI 
    5. showUISessions(_token): Get the list of active UI sessions
    6. isValidToken(_k): Check if the given key _k is a valid token
    7. isBlacklistedToken(_k): Check if the given key _k is a blacklisted token
    8. blacklist(_token, _expiry): Blacklist a token with the given expiry
    9. refreshToken(_tokenOld, _tokenNew, _expiry): Used when a new token is issued.
3. __date:__ returns a date, months before specified month. Takes one argument: month
4. __IDGenerator:__
    1. __getUniqueID:__ generates a uniqueID which can be a candidate _id of a model.
5. __moveToES:__ move data to elastic search
    1. __init:__ initialize object. Takes four args crud, mastername, logger, fields.
    2. __moveToES:__ move a document to elastic search server. Takes one arg: doc
    3. __moveAll:__ move all deleted document to elastic search. Takes two args: req, res
6. __rand:__ returns a random integer. Takes one arg: length of integer.
7. __logger:__ returns a log4j object compatible with aou crud library.

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