Getting Started

Installation 🚀

npm

Installation through Node Package Manager, NPM can be done as follows.

  # install through npm
  $ npm i suya

yarn

Installation through Yarn can be done as follows.

  # install through yarn
  $ yarn add suya

manual

The manual installation involves cloning the project github repository and building the source code(s) written in TypeScript into vanilla JavaScript using tsc, TypeScript Compiler.

  # clone the repo
  $ git clone https://github.com/0xridwanobafunso/suya.git

  # install dependencies
  $ npm i

  # build .ts source code(s) into .js source code(s)
  $ tsc

  # the compiled .js code(s) and it types definitions lives in /lib directory.
  # require the index.js file
  # const Cache = require('./lib/index.js')

Why Suya?

Short answer, Performance. If you want your Express.js API responses to be super-fast you should give suya a trial. There are various popular libraries that cache API responses but they are limited to Redis as their cache engine. What about developers’ who loves Memcached? Suya works out of box with Node.js Cache, Redis, and Memcached.

⏮️ Introduction | API ⏭️