Skip to main content

#Metle

Build Status codecov node npm version devDependencies Status PRs Welcome GitHub

Metle is a memory storage for NodeJS that supports caching with TTL and maximum number of requests to keep the cache up to date.

Install

npm install metle

Usage

Load the default Metle instance

import metle from 'metle'

metle.setItem('foo', 'bar')

const foo = metle.getItem('foo')

Create a new Metle instance

import { Metle } from 'metle'

const metleInstance = new Metle({TTL: 2, maxRequest: 50})
metle.setItem('foo', 'bar')

const foo = metle.getItem('foo')

API

  • getItem(key: string): any
  • setItem(key: string, value: any, timers?:ITimers): boolean
  • hasItem(key: string): boolean
  • resetItemCounter(key: string, timers?: ITimers): boolean
  • removeItem(key: string): boolean

Metle constructor

  const metle = new Metle(timers?: ITimers)

Interface ITimers

interface ITimers {
  TTL?: number, // default: 10 (min), maximum time to live of an item, 0 for infinite
  maxRequest?: number, // default: 10, maximum number of gets until the item is removed, 0 for infinite
}