type-cacheable

(β˜… 191)

TypeScript-based caching decorator (currently supports Redis, LRU-Cache and NodeCache)

  • .gitignore
  • .nvmrc
  • .yarnrc.yml
  • biome.json
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
  • docker-compose.yml
  • Dockerfile
  • jest.config.base.js
  • jest.config.js
  • lerna.json
  • LICENSE
  • package.json
  • README.md
  • tsconfig.json
  • yarn.lock

# Installation Guide

1. Get the code
git clone https://github.com/joshuaslate/type-cacheable

Downloads the entire project code from GitHub to your computer.

cd type-cacheable

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up -d --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install --save @type-cacheable/core

Downloads and installs the libraries listed in package.json.

yarn add @type-cacheable/core

Type this command into your terminal and run it.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation