cacheable
a robust, scalable, and maintained set of caching packages
File Explorer
Download Latest Version (.zip)- bug_report.md
- feature_request.md
- codecov.yml
- deploy-website.yml
- release.yml
- tests.yml
- PULL_REQUEST_TEMPLATE.md
- index.ts
- object-generator.ts
- .DS_Store
- biome.json
- cache-get-set.ts
- LICENSE
- memory-lru.ts
- memory.ts
- node-cache.ts
- package.json
- README.md
- tsconfig.json
- index.ts
- keyv-adapter.ts
- cache-id.test.ts
- clear.test.ts
- del.test.ts
- disconnect.test.ts
- events.test.ts
- example.test.ts
- get.test.ts
- init.test.ts
- keyv-adapter.test.ts
- mdel.test.ts
- mget.test.ts
- mset.test.ts
- multiple-stores.test.ts
- set.test.ts
- sleep.ts
- stores.test.ts
- ttl.test.ts
- wrap.test.ts
- LICENSE
- package.json
- README.md
- READMEv4.md
- READMEv5.md
- tsconfig.json
- vitest.config.ts
- enums.ts
- index.ts
- sync.ts
- types.ts
- get-raw.test.ts
- index.test.ts
- per-store-ttl-hooks.test.ts
- secondary-primary.test.ts
- shared-secondary.test.ts
- stats.test.ts
- sync.test.ts
- tags.test.ts
- ttl.test.ts
- wrap.test.ts
- LICENSE
- package.json
- README.md
- tsconfig.json
- vitest.config.ts
- index.ts
- types.ts
- index.mjs
- 304-header-preservation.test.ts
- cache.test.ts
- cacheable-request-class.test.ts
- cacheable-request-instance.test.ts
- dependencies.test.ts
- LICENSE
- package.json
- README.md
- tsconfig.build.json
- tsconfig.json
- vitest.config.ts
- index.ts
- cwd.test.ts
- eslint.test.ts
- file-rename.test.ts
- index.test.ts
- path-sanitization.test.ts
- relative-eslint.test.ts
- LICENSE
- package.json
- README.md
- tsconfig.json
- vitest.config.ts
- index.ts
- .cache_77v6ix
- cache1
- cache4
- legacy1
- index.test.ts
- legacy.test.ts
- LICENSE
- package.json
- README.md
- tsconfig.json
- vitest.config.ts
- index.ts
- keyv-memory.ts
- memory-lru.ts
- index.test.ts
- keyv-memory.test.ts
- memory-lru.test.ts
- LICENSE
- package.json
- README.md
- tsconfig.json
- vitest.config.ts
- fetch.ts
- index.ts
- rdap.ts
- whois.ts
- fetch.test.ts
- index.test.ts
- rdap.test.ts
- whois.test.ts
- LICENSE
- package.json
- README.md
- tsconfig.json
- vitest.config.ts
- index.ts
- store.ts
- export.test.ts
- index.test.ts
- store.test.ts
- LICENSE
- package.json
- README.md
- tsconfig.json
- vitest.config.ts
- cache-tags.ts
- cacheable-item-types.ts
- coalesce-async.ts
- hash.ts
- index.ts
- is-keyv-instance.ts
- is-object.ts
- less-than.ts
- memoize.ts
- run-if-fn.ts
- shorthand-time.ts
- sleep.ts
- stats.ts
- ttl.ts
- cache-tags.test.ts
- coalesc-async.test.ts
- get-or-set-sync.test.ts
- get-or-set.test.ts
- hash.test.ts
- index.test.ts
- is-keyv-instance.test.ts
- is-object.test.ts
- less-than.test.ts
- mock-cacheable.ts
- run-if-fn.test.ts
- shorthand-time.test.ts
- stats.test.ts
- ttl.test.ts
- wrap.test.ts
- LICENSE
- package.json
- README.md
- tsconfig.json
- vitest.config.ts
- symbol.svg
- .gitignore
- docula.config.ts
- favicon.ico
- logo.svg
- docs.ts
- package.json
- tsconfig.json
- release.mjs
- test-build.mjs
- .gitignore
- .nvmrc
- AGENTS.md
- biome.json
- CLAUDE.md
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- docker-compose.yml
- LICENSE
- package.json
- pnpm-lock.yaml
- pnpm-workspace.yaml
- README.md
- SECURITY.md
# Installation Guide
1. Get the code
git clone https://github.com/jaredwray/cacheable
Downloads the entire project code from GitHub to your computer.
cd cacheable
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- 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
EasyPrerequisites
npm install
Downloads and installs the libraries listed in package.json.
npm start
Starts the development/run server.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
// repository documentation
Was this content helpful?
(0 ratings)