Merge pull request #3 from adamjosefus/development

Add documentation

Author: adamjosefus

README.md

@@ -1,6 +1,9 @@
-# Caching
+# **Allo Caching** for Deno 🦕
 
-## `Cache`
+Simple caching solution in Typescript.
+
+
+## `Cache<ValueType>`
 
 ```ts
 const cache = new Cache<string>();
@@ -38,4 +41,14 @@ cache.save(cacheKey, 'Lorem ipsum');
  */
 cache.has(cacheKey); // -> boolean
 
-```
+```
+
+
+
+## Documentation 📖
+
+Description of all classes and methods with **examples** will found in the [documentation](https://doc.deno.land/https://deno.land/x/[email protected]/mod.ts).
+
+---
+
+Check out other [ours packages 📦](https://deno.land/x?query=allo_)!

Cache/Cache.ts renamed to libs/Cache.ts

@@ -2,17 +2,18 @@
  * @copyright Copyright (c) 2022 Adam Josefus
  */
 
-type GeneratorType<T> = () => T;
 
-type LoadOnlyEntryType<T> = [key: string];
+export type GeneratorType<T> = () => T;
+type LoadOnlyEntryType = [key: string];
 type LoadAndGenerateEntryType<T> = [key: string, generator: GeneratorType<T>];
-type LoadEntryType<T> = LoadOnlyEntryType<T> | LoadAndGenerateEntryType<T>;
+type LoadEntryType<T> = LoadOnlyEntryType | LoadAndGenerateEntryType<T>;
 
 
 export class Cache<T> {
 
     readonly #storage: Map<string, T> = new Map();
 
+
     load<E extends LoadEntryType<T>>(...args: E): E extends LoadAndGenerateEntryType<T> ? T : T | undefined {
         const [key, generator] = args;
 

mod.ts

@@ -1 +1 @@
-export { Cache } from './Cache/Cache.ts';
+export * from './libs/Cache.ts';