0.1.2 - version synchronized

Synchronize the document contents to the newest version.
cainmagi · Oct 13, 2024 · 79a59fc · 79a59fc
1 parent 88f6663
commit 79a59fc
Show file tree

Hide file tree

Showing 23 changed files with 45 additions and 110 deletions.
diff --git a/Changelog.md b/Changelog.md
@@ -4,6 +4,12 @@
 
 ## CHANGELOG
 
+### 0.1.2 @ 10/13/2024
+
+#### :mega: New
+
+1. Synchronize the document contents to the newest version.
+
 ### 0.1.0 @ 10/13/2024
 
 #### :mega: New

diff --git a/docs/apis/caches/abstract/CacheAbstract.mdx b/docs/apis/caches/abstract/CacheAbstract.mdx
@@ -11,7 +11,7 @@ import vsiCheckIcon from "@iconify-icons/codicon/check";
 import InlineIcon from "@site/src/components/InlineIcon";
 import APITopBar, { IconObjType } from "@site/src/components/APITopBar";
 
-<APITopBar type="class" isAbstract={true} source="caches/abstract.py#L42" />
+<APITopBar type="class" isAbstract={true} source="caches/abstract.py#L44" />
 
 ```python
 cache = CacheAbstract[Info, Data]()

diff --git a/docs/apis/caches/memory/CachePlain.mdx b/docs/apis/caches/memory/CachePlain.mdx
@@ -15,7 +15,7 @@ import DarkButton from "@site/src/components/DarkButton";
 import InlineIcon from "@site/src/components/InlineIcon";
 import APITopBar, { IconObjType } from "@site/src/components/APITopBar";
 
-<APITopBar type="class" source="caches/memory.py#L65" />
+<APITopBar type="class" source="caches/memory.py#L66" />
 
 ```python
 cache = CachePlain[Info, Data](cache_size: int)

diff --git a/docs/apis/caches/memory/CacheQueue.mdx b/docs/apis/caches/memory/CacheQueue.mdx
@@ -16,7 +16,7 @@ import DarkButton from "@site/src/components/DarkButton";
 import InlineIcon from "@site/src/components/InlineIcon";
 import APITopBar, { IconObjType } from "@site/src/components/APITopBar";
 
-<APITopBar type="class" source="caches/memory.py#L167" />
+<APITopBar type="class" source="caches/memory.py#L168" />
 
 ```python
 cache = CacheQueue[Info, Data](

diff --git a/docs/apis/caches/memory/CacheQueueMirror.mdx b/docs/apis/caches/memory/CacheQueueMirror.mdx
@@ -11,7 +11,7 @@ import vsiCheckIcon from "@iconify-icons/codicon/check";
 import InlineIcon from "@site/src/components/InlineIcon";
 import APITopBar, { IconObjType } from "@site/src/components/APITopBar";
 
-<APITopBar type="class" source="caches/memory.py#L206" />
+<APITopBar type="class" source="caches/memory.py#L207" />
 
 ```python
 cache: CacheQueue[Info, Data]

diff --git a/docs/apis/caches/typehints/CachedBytesIO.mdx b/docs/apis/caches/typehints/CachedBytesIO.mdx
@@ -8,7 +8,7 @@ description: The data of one cached BytesIO data.
 
 import APITopBar, { IconObjType } from "@site/src/components/APITopBar";
 
-<APITopBar type="type" source="caches/typehints.py#L105" />
+<APITopBar type="type" source="caches/typehints.py#L104" />
 
 ```python
 CachedBytesIO(

diff --git a/docs/apis/caches/typehints/CachedData.mdx b/docs/apis/caches/typehints/CachedData.mdx
@@ -8,7 +8,7 @@ description: The typehint of the cached data.
 
 import APITopBar, { IconObjType } from "@site/src/components/APITopBar";
 
-<APITopBar type="type" source="caches/typehints.py#L116" />
+<APITopBar type="type" source="caches/typehints.py#L115" />
 
 ```python
 CachedData = CachedPath | CachedStringIO | CachedBytesIO

diff --git a/docs/apis/caches/typehints/CachedFileInfo.mdx b/docs/apis/caches/typehints/CachedFileInfo.mdx
@@ -8,7 +8,7 @@ description: The metadata of the cached file.
 
 import APITopBar, { IconObjType } from "@site/src/components/APITopBar";
 
-<APITopBar type="type" source="caches/typehints.py#L48" />
+<APITopBar type="type" source="caches/typehints.py#L49" />
 
 ```python
 CachedFileInfo(

diff --git a/docs/apis/caches/typehints/CachedPath.mdx b/docs/apis/caches/typehints/CachedPath.mdx
@@ -8,7 +8,7 @@ description: The string path or the path-like object specifying a file existing
 
 import APITopBar, { IconObjType } from "@site/src/components/APITopBar";
 
-<APITopBar type="type" source="caches/typehints.py#L80" />
+<APITopBar type="type" source="caches/typehints.py#L79" />
 
 ```python
 CachedPath(

diff --git a/docs/apis/caches/typehints/CachedStringIO.mdx b/docs/apis/caches/typehints/CachedStringIO.mdx
@@ -8,7 +8,7 @@ description: The data of one cached StringIO data.
 
 import APITopBar, { IconObjType } from "@site/src/components/APITopBar";
 
-<APITopBar type="type" source="caches/typehints.py#L94" />
+<APITopBar type="type" source="caches/typehints.py#L93" />
 
 ```python
 CachedStringIO(

diff --git a/docs/apis/caches/typehints/Deferred.mdx b/docs/apis/caches/typehints/Deferred.mdx
@@ -0,0 +1,20 @@
+---
+id: Deferred
+title: Deferred
+sidebar_label: Deferred
+slug: /apis/caches/typehints/Deferred
+description: The typehint of a deferred value.
+---
+
+import APITopBar, { IconObjType } from "@site/src/components/APITopBar";
+
+<APITopBar type="type" source="caches/typehints.py#L34" />
+
+```python
+Deferred = Callable[[], T]
+```
+
+`Deferred` is a shortcut of a type composition.
+
+`Deferred` is a deferred value. This value is lazy-loaded by a function. Only when
+this function gets called, the value will be produced.
diff --git a/docs/apis/caches/typehints/index.mdx b/docs/apis/caches/typehints/index.mdx
@@ -16,6 +16,7 @@ Extra typehints used by this project.
 
 |                                         Member                                          |    Type     | <center>Description</center>                                                    |
 | :-------------------------------------------------------------------------------------: | :---------: | :------------------------------------------------------------------------------ |
+|       [<IconObjType type="type" hasText={true} text="Deferred"/>](./Deferred.mdx)       | `Callable`  | The typehint of a deferred value.                                               |
 | [<IconObjType type="type" hasText={true} text="CachedFileInfo"/>](./CachedFileInfo.mdx) | `TypedDict` | The metadata of the cached file.                                                |
 |     [<IconObjType type="type" hasText={true} text="CachedPath"/>](./CachedPath.mdx)     | `TypedDict` | The string path or the path-like object specifying a file existing on the disk. |
 | [<IconObjType type="type" hasText={true} text="CachedStringIO"/>](./CachedStringIO.mdx) | `TypedDict` | The data of one cached `StringIO` data.                                         |

diff --git a/docs/apis/services/utilities/get_server.mdx b/docs/apis/services/utilities/get_server.mdx
@@ -14,7 +14,7 @@ import vsiCheckIcon from "@iconify-icons/codicon/check";
 import InlineIcon from "@site/src/components/InlineIcon";
 import APITopBar, { IconObjType } from "@site/src/components/APITopBar";
 
-<APITopBar type="func" isPrivate={true} source="services/utilities.py#L45" />
+<APITopBar type="func" isPrivate={true} source="services/utilities.py#L61" />
 
 ```python
 server: flask.Flask = get_server(app: dash.Dash | flask.Flask)

diff --git a/docs/apis/services/utilities/no_cache.mdx b/docs/apis/services/utilities/no_cache.mdx
@@ -15,7 +15,7 @@ import APITopBar, { IconObjType } from "@site/src/components/APITopBar";
   type="func"
   isPrivate={true}
   isDecorator={true}
-  source="services/utilities.py#L36"
+  source="services/utilities.py#L40"
 />
 
 ```python

diff --git a/docs/apis/utilities/StreamFinalizer.mdx b/docs/apis/utilities/StreamFinalizer.mdx
@@ -19,7 +19,7 @@ import APITopBar, { IconObjType } from "@site/src/components/APITopBar";
   type="class"
   isPrivate={true}
   isContext={true}
-  source="utilities.py#L133"
+  source="utilities.py#L120"
 />
 
 ```python

diff --git a/docs/apis/utilities/TempDir.mdx b/docs/apis/utilities/TempDir.mdx
@@ -13,7 +13,7 @@ import IconExternalLink from "@theme/Icon/ExternalLink";
 import IconLink from "@site/src/components/IconLink";
 import APITopBar, { IconObjType } from "@site/src/components/APITopBar";
 
-<APITopBar type="class" source="utilities.py#L89" />
+<APITopBar type="class" source="utilities.py#L76" />
 
 ```python
 tempdir = TempDir(path: str | os.PathLike | None = None)

diff --git a/docs/apis/utilities/index.mdx b/docs/apis/utilities/index.mdx
@@ -24,5 +24,4 @@ Shared utilities used for handling the files and requests.
 |                                             Member                                              | <center>Description</center>                                           |
 | :---------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------- |
 | [<IconObjType type="func" hasText={true} text="is_in_main_process"/>](./is_in_main_process.mdx) | A function used for checking whether the `str` ends with a line break. |
-|           [<IconObjType type="func" hasText={true} text="no_cache"/>](./no_cache.mdx)           | A deocrator adding `no_cache` property to the `flask` services.        |
 |    [<IconObjType type="func" hasText={true} text="remove_temp_dir"/>](./remove_temp_dir.mdx)    | Remove the temporary directory.                                        |
diff --git a/docs/apis/utilities/is_in_main_process.mdx b/docs/apis/utilities/is_in_main_process.mdx
@@ -12,7 +12,7 @@ import TabItem from "@theme/TabItem";
 import IconLink from "@site/src/components/IconLink";
 import APITopBar, { IconObjType } from "@site/src/components/APITopBar";
 
-<APITopBar type="func" isPrivate={true} source="utilities.py#L56" />
+<APITopBar type="func" isPrivate={true} source="utilities.py#L52" />
 
 ```python
 flag: bool = is_in_main_process()

diff --git a/docs/apis/utilities/no_cache.mdx b/docs/apis/utilities/no_cache.mdx
diff --git a/docs/apis/utilities/remove_temp_dir.mdx b/docs/apis/utilities/remove_temp_dir.mdx
@@ -15,7 +15,7 @@ import vsiCheckIcon from "@iconify-icons/codicon/check";
 import InlineIcon from "@site/src/components/InlineIcon";
 import APITopBar, { IconObjType } from "@site/src/components/APITopBar";
 
-<APITopBar type="func" isPrivate={true} source="utilities.py#L76" />
+<APITopBar type="func" isPrivate={true} source="utilities.py#L63" />
 
 ```python
 remove_temp_dir(path: str | os.PathLike)

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "docs",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",

diff --git a/sidebars.ts b/sidebars.ts
@@ -118,6 +118,7 @@ const sidebars: SidebarsConfig = {
             id: "apis/caches/typehints/index",
           },
           items: [
+            "apis/caches/typehints/Deferred",
             "apis/caches/typehints/CachedFileInfo",
             "apis/caches/typehints/CachedPath",
             "apis/caches/typehints/CachedStringIO",
@@ -192,7 +193,6 @@ const sidebars: SidebarsConfig = {
       },
       items: [
         "apis/utilities/is_in_main_process",
-        "apis/utilities/no_cache",
         "apis/utilities/remove_temp_dir",
         "apis/utilities/TempDir",
         "apis/utilities/StreamFinalizer",

diff --git a/src/envs/variables.tsx b/src/envs/variables.tsx
@@ -11,7 +11,7 @@ import mdiDot from "@iconify-icons/mdi/dot";
 
 const variables = {
   sourceURL:
-    "https://github.com/cainmagi/dash-file-cache/blob/f10e27c57458992283aeb1e24e16e1b3676f2dba",
+    "https://github.com/cainmagi/dash-file-cache/blob/90214d58c0610976d7af1c583a35f83784c0c80c",
 };
 
 export const demoURL = (url: string): string => {