2.2.1 • Published 7 months ago

@appveen/utils v2.2.1

Weekly downloads
457
License
BSD-3-Clause
Repository
github
Last release
7 months ago

# 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 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.
2.2.1

7 months ago

2.2.0

7 months ago

2.1.13

1 year ago

3.0.2

2 years ago

2.1.12

2 years ago

2.1.10

2 years ago

2.1.11

2 years ago

2.1.8

2 years ago

2.1.7

2 years ago

3.0.1

2 years ago

2.1.9

2 years ago

3.0.0

2 years ago

2.1.6

2 years ago

2.1.5

2 years ago

2.1.4

3 years ago

1.2.10

3 years ago

2.1.2

3 years ago

2.1.3

3 years ago

2.1.1

3 years ago

2.1.0

3 years ago

2.0.2

3 years ago

2.0.1

3 years ago

2.0.0

3 years ago

1.2.9

3 years ago

1.2.8

3 years ago

1.1.7

3 years ago

1.2.6

4 years ago

1.2.5

4 years ago

1.2.4

4 years ago

1.2.3

4 years ago

1.2.2

4 years ago

1.2.1

4 years ago

1.2.0

4 years ago

1.1.6

4 years ago

1.1.5

4 years ago

1.1.4

4 years ago

1.1.3

5 years ago

1.1.2

5 years ago

1.1.1

5 years ago

1.1.0

5 years ago

1.0.3

5 years ago

1.0.2

5 years ago

1.0.1

5 years ago

1.0.0

5 years ago