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

simple-adonis-cache

v0.4.1

Published

A simple cache mechanism for AdonisJs

Downloads

4

Readme

Simple Adonis Cache

npm (scoped)

A simple cache mechanism for AdonisJs.

Installation

adonis install simple-adonis-cache

After installation, you need to register the providers inside start/app.js file.

// start/app.js
const providers = [
  ...,
  'adonis-cache/providers/CacheProvider'
]

Configuration

The cache configuration is located at config/cache.js.

// config/cache.js
module.exports = {
  // Indicates cache must be enabled or not
  enabled: true,

  // Indicates where objects should reside on
  driver: 'memory',

  // Indicates prefix for keys
  prefix: 'cache:'
}

API Reference

Cache.remember(key, expire, value)

This function store value in key for expire seconds and return value.

  • key: must be String indicating the key
  • expire: must be Number indicating expiration time
  • value: can be anything such as Function, String, Number, etc.

Example code:

const Cache = use('Cache')
const User = use('App/Models/User')
class UserController {
  async index(request, response) {
    // retrieve users from database and cache them for 60 seconds.
    const users = await Cache.rememebr('users', 60, () => {
      return User.all()
    })

    // retrieve tags and cache them for 1 hour.
    const tags = await Cache.rememebr('users', 60 * 60, () => {
      return ['goods', 'services']
    })

    // retrieve url and cache it for 1 day.
    const url = await Cache.rememebr('users', 24 * 60 * 60, () => {
      return 'http://api.example.com'
    })
  }
}

Cache.forever(key, value)

This function store value in key forever and return value.

  • key: must be String indicating the key
  • value: can be anything such as Function, String, Number, etc.

Example code:

const Cache = use('Cache')
const User = use('App/Models/User')
class UserController {
  async index(request, response) {
    // retrieve users from database and cache them forever.
    const users = await Cache.forever('users', () => {
      return User.all()
    })

    // retrieve tags and cache them forever.
    const tags = await Cache.forever('users', () => {
      return ['goods', 'services']
    })

    // retrieve url and cache it forever.
    const url = await Cache.forever('users', () => {
      return 'http://api.example.com'
    })
  }
}

Cache.forget(key)

This function remove specified key.

  • key: must be String indicating the key

Example code:

const Cache = use('Cache')
const User = use('App/Models/User')
class UserController {
  async index(request, response) {
    // forget a specific key
    await Cache.forget('users')
  }
}

To Do

  • [x] Add basic functionality
  • [x] Add memory driver
  • [x] Add redis driver
  • [ ] Add a method to flush all cached values
  • [ ] Add a command to flush all cached values
  • [ ] Support for different environments

Release History

  • 0.1.0 - First draft.
  • 0.3.0 - Initial release and basic functionality and supports for memory storage.
  • 0.4.0 - Add support for Redis driver

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT