merge pull request #21 from azurydev/canary

push `v4` to production

.github/dependabot.yml

@@ -1,8 +1,9 @@
 version: 2
 updates:
-  - package-ecosystem: npm
+  - package-ecosystem: 'npm'
     directory: '/'
     schedule:
-      interval: daily
-    open-pull-requests-limit: 10
-    target-branch: "nightly"
+      interval: 'daily'
+    open-pull-requests-limit: 100
+    target-branch: 'canary'
+    versioning-strategy: 'increase'

.gitignore

@@ -1,3 +1,3 @@
-node_modules
-build
-types
+/node_modules
+/build
+/types

.npmignore

@@ -1,6 +1,9 @@
-src
-test
-.github
+/src
+/test
+/.github
 .gitignore
 changelog.md
-tsconfig.json
+tsconfig.json
+/changelog
+/guide
+jest.config.js

changelog.md

@@ -1,126 +1,28 @@
-# cachu's changelog
+# changelog
 
-Available Releases:
+### Available Releases:
 
-- [v2.6.0](#v260)
-- [v2.5.0](#v250)
-- [v2.4.2](#v242)
-- [v2.4.1](#v241)
-- [v2.4.0](#v240)
-- [v2.3.0](#v230)
-- [v2.2.0](#v220)
-- [v2.1.1](#v211)
-- [v2.1.0](#v210)
-- [v2.0.3](#v203)
-- [v2.0.2](#v202)
-- [v2.0.1](#v201)
-- [v2.0.0](#v200)
+- #### v4
+  - [v4.0.0](#v400)
 
-## v2.6.1
+[Outdated Releases](https://github.com/azurydev/cachu/tree/current/changelog)
 
-- patched `jest` ***(dev-only)***
-- fixed typo in changelog ***(dev-only)***
-- removed types from github (again) ***(dev-only)***
-- added automated releases (just testing) ***(dev-only)***
+## Releases
 
-## v2.6.0
+### v4.0.0
 
-- removed `glob` dependency ***(dev-only)***
-- removed types from github ***(dev-only)***
-- edited ignored files
+#### Breaking Changes
 
-## v2.5.0
+- renamed `set()` function to [`write()`](https://github.com/azurydev/cachu/blob/current/guide/features/write.md) and `view()` to [`grab()`](https://github.com/azurydev/cachu/blob/current/guide/features/grab.md)
+- made package esm-only
+- migrated from Arrays to Maps for storing records
 
-- added `steal` and `stealMany` functions
-- removed `build` folder from github ***(dev-only)***
+#### Other Changes
 
-## v2.4.2
+- updated year mentioned in license to `2022`
+- added `MiniCache` and `MemoryCache`
 
-### Changes
+#### New Features
 
-- patched TypeScript
-- fixed changelog
-- edited package description
-
-## v2.4.1
-
-### Changes
-
-- changed build standard to `es2021` ***(results in less code)***
-- added `minify` script ***(dev-only)***
-- edited types ***(dev-only)***
-- renamed publish scripts ***(dev-only)***
-
-## v2.4.0
-
-### Changes
-
-- edited jsdoc declarations
-- edited unit tests
-- enhanced conditional querying
-- patched terser
-
-## v2.3.0
-
-### New
-
-- added jsdoc declarations
-- added unit tests
-
-## v2.2.0
-
-### Changes
-
-- removed global instance
-- edited engine requirements
-
-### Bug Fixes
-
-- made config optional
-
-## v2.1.1
-
-### Bug Fixes
-
-- fixed a minor issue
-
-## v2.1.0
-
-### Changes
-
-- added support for TypeScript
-- added type definitions
-
-## v2.0.3
-
-### Bug Fixes
-
-- fixed a small issue regarding default config
-
-## v2.0.2
-
-### Bug Fixes
-
-- fixed examples
-
-## v2.0.1
-
-### Changes
-
-- removed `jest`
-
-## v2.0.0
-
-### Changes
-
-- renamed functions
-- added global instance
-- added `purgeMany`, `getMany`, `purgeManyByCondition`, `getManyByCondition`, `getKeysOfItems`, `getValuesOfItems`, `getAmountOfItems`, and `each` functions
-- added engine requirements
-- added funding
-- minified package
-- made testing easier 
-
-### Bug Fixes
-
-- fixed deletion of expired items
+- added [`writeMany()`](https://github.com/azurydev/cachu/blob/current/guide/features/writeMany.md), [`grabMany()`](https://github.com/azurydev/cachu/blob/current/guide/features/grabMany.md) features
+- released **Hooks** for an easier way to extend cachu's functionality

changelog/v2.md

@@ -0,0 +1,132 @@
+# changelog
+
+> ℹ️ You're reading the changelog for an outdated release. Please refer to [here](https://github.com/azurydev/cachu/blob/current/changelog.md) to read the changelog for the latest release.
+
+### Available Releases:
+
+- #### v2
+  - [v2.6.1](#v261)
+  - [v2.6.0](#v260)
+  - [v2.5.0](#v250)
+  - [v2.4.2](#v242)
+  - [v2.4.1](#v241)
+  - [v2.4.0](#v240)
+  - [v2.3.0](#v230)
+  - [v2.2.0](#v220)
+  - [v2.1.1](#v211)
+  - [v2.1.0](#v210)
+  - [v2.0.3](#v203)
+  - [v2.0.2](#v202)
+  - [v2.0.1](#v201)
+  - [v2.0.0](#v200)
+
+## Releases
+
+### v2.6.1
+
+- patched `jest` ***(dev-only)***
+- fixed typo in changelog ***(dev-only)***
+- removed types from github (again) ***(dev-only)***
+- added automated releases (just testing) ***(dev-only)***
+
+### v2.6.0
+
+- removed `glob` dependency ***(dev-only)***
+- removed types from github ***(dev-only)***
+- edited ignored files
+
+### v2.5.0
+
+- added `steal` and `stealMany` functions
+- removed `build` folder from github ***(dev-only)***
+
+### v2.4.2
+
+#### Changes
+
+- patched TypeScript
+- fixed changelog
+- edited package description
+
+### v2.4.1
+
+#### Changes
+
+- changed build standard to `es2021` ***(results in less code)***
+- added `minify` script ***(dev-only)***
+- edited types ***(dev-only)***
+- renamed publish scripts ***(dev-only)***
+
+### v2.4.0
+
+#### Changes
+
+- edited jsdoc declarations
+- edited unit tests
+- enhanced conditional querying
+- patched terser
+
+### v2.3.0
+
+#### New
+
+- added jsdoc declarations
+- added unit tests
+
+### v2.2.0
+
+#### Changes
+
+- removed global instance
+- edited engine requirements
+
+#### Bug Fixes
+
+- made config optional
+
+### v2.1.1
+
+#### Bug Fixes
+
+- fixed a minor issue
+
+### v2.1.0
+
+#### Changes
+
+- added support for TypeScript
+- added type definitions
+
+### v2.0.3
+
+#### Bug Fixes
+
+- fixed a small issue regarding default config
+
+### v2.0.2
+
+#### Bug Fixes
+
+- fixed examples
+
+### v2.0.1
+
+#### Changes
+
+- removed `jest`
+
+### v2.0.0
+
+#### Changes
+
+- renamed functions
+- added global instance
+- added `purgeMany`, `getMany`, `purgeManyByCondition`, `getManyByCondition`, `getKeysOfItems`, `getValuesOfItems`, `getAmountOfItems`, and `each` functions
+- added engine requirements
+- added funding
+- minified package
+- made testing easier
+
+#### Bug Fixes
+
+- fixed deletion of expired items

guide/caches/MemoryCache.md

@@ -0,0 +1,22 @@
+[**» Back to Overview**](https://github.com/azurydev/cachu#caches)
+
+## Memory Cache
+
+#### Usage:
+
+```js
+import { MemoryCache } from 'cachu'
+
+const cache = new MemoryCache()
+```
+
+#### Configuration:
+
+- [`hooks`](https://github.com/azurydev/cachu/blob/current/guide/configuration/hooks.md)
+- [`maxAge`](https://github.com/azurydev/cachu/blob/current/guide/configuration/maxAge.md)
+- [`maxAmount`](https://github.com/azurydev/cachu/blob/current/guide/configuration/maxAmount.md)
+- [`overriding`](https://github.com/azurydev/cachu/blob/current/guide/configuration/overriding.md)
+
+#### Exclusive Features:
+
+- [`getConsumedMemory`](https://github.com/azurydev/cachu/blob/current/guide/features/getConsumedMemory.md)

guide/caches/MiniCache.md

@@ -0,0 +1,17 @@
+[**» Back to Overview**](https://github.com/azurydev/cachu#caches)
+
+## Mini Cache
+
+#### Usage:
+
+```js
+import { MiniCache } from 'cachu'
+
+const cache = new MiniCache()
+```
+
+#### Configuration:
+
+- [`maxAge`](https://github.com/azurydev/cachu/blob/current/guide/configuration/maxAge.md)
+- [`maxAmount`](https://github.com/azurydev/cachu/blob/current/guide/configuration/maxAmount.md)
+- [`overriding`](https://github.com/azurydev/cachu/blob/current/guide/configuration/overriding.md)

guide/configuration/hooks.md

@@ -0,0 +1,21 @@
+[**» Back to Overview**](https://github.com/azurydev/cachu#configuration)
+
+## hooks
+
+Customize **cachu**'s functionality to your desire with the [hooks](https://github.com/azurydev/cachu#hooks) you need.
+
+By default, no hooks are set.
+
+#### Example:
+
+```js
+import { MemoryCache } from 'cachu'
+
+const cache = new MemoryCache({
+  hooks: {
+    preReading: async ({ keyOfTargetedEntry }) => {
+      return (typeof keyOfTargetedEntry === 'string')
+    }
+  }
+})
+```