npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ac-keylock

v0.0.3

Published

This tool can be used to lock operations (e.g. make sure workers will fetch a job only once). You can use it with Redis as distributed lock systems or with the built-in memory cache.

Downloads

8

Readme

AC KeyLock

This tool can be used to lock operations (e.g. make sure workers will fetch a job only once). You can use it with Redis as distributed lock systems or with the built-in memory cache.

This package is a successor of ac-redisLock and can easily replace ac-redisLock. Please note, that callback-style is no longer available.

Usage

Init

Init function requires a valid redis instance.

  • redis - OPTIONAL INSTANCE ioredis instance
  • logger - OPTIONAL INSTANCE logger instance (e.g. Winston)
  • logLevel - OPTIONAL STRING logLevel for the Redis operation
await keylock.init()
// OR WITH REDIS
await keylock.init({ redis: REDISINSTANCE })

Lock key

LockKey has the following parameters

  • key - STRING required name for the key
  • expires - OPTIONAL INT seconds after the lock is released, defaults to 10 seconds
  • value - OPTIONAL STRING value for this redisKey. Use it to compare/secure lock values
await keylock.lockKey(params)
// return values
{ status: 423 } -> there is already a lock on this key
{ value: 'xxxx' } -> a lock has been put on this key

Release lock

ReleaseKey has the following parameters

  • key - STRING required name for the key
  • value - OPTIONAL STRING if set will be compared with the redisKey value before releasing. If not matching, the function will return an error message
await keylock.releaseLock(params, [callback])
// return values
{ status: 200 } -> lock has been released and deleted

Examples

Usage with Redis

const keyLock = require('ac-keylock')

// create a Redis instance (using io-redis)
const app.redisInstance = new Redis(options)

await keyLock.init({
  redis: app.redisInstance 
})

const params = {
  key: 'someMeaningfulKey',
}
let result = await keyLock.lockKey(params)
// { status: 423 } -> key is locked
// { value } -> value for this lock -> set as params.value for releaseLock

// redisKey is deleted and lock released
await keyLock.releaseKey(params)
// { status: 200 }

Usage with built-in memory cache

const keyLock = require('ac-keylock')

await keyLock.init()

const params = {
  key: 'someMeaningfulKey',
}
let result = await keyLock.lockKey(params)
// { status: 423 } -> key is locked
// { value } -> value for this lock -> set as params.value for releaseLock

// redisKey is deleted and lock released
await keyLock.releaseKey(params)
// { status: 200 }

Links

License

MIT License Copyright © 2009-present, AdmiralCloud AG, Mark Poepping