@blackglory/cache-js 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 BlackGlory <woshenmedoubuzhidao@blackglory.me>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,52 @@
+# cache-js
+## Install
+```sh
+npm install --save @blackglory/cache-js
+# or
+yarn add @blackglory/cache-js
+```
+
+## API
+### CacheClient
+```ts
+interface IMetadata {
+  updatedAt: number
+  timeToLive: number
+  timeBeforeDeletion: number
+}
+
+interface ICacheClientOptions {
+  server: string
+  timeout?: number
+}
+
+class CacheClient {
+  static create(options: ICacheClientOptions): Promise<CacheClient>
+
+    close(): void
+    has(namespace: string, key: string, timeout?: number): Promise<boolean>
+    get(namespace: string, key: string, timeout?: number): Promise<string | null>
+    bulkGet(
+      namespace: string
+    , keys: string[]
+    , timeout?: number
+    ): Promise<Array<string | null>>
+    getWithMetadata(namespace: string, key: string, timeout?: number): Promise<{
+        value: string
+        metadata: IMetadata
+    } | null>
+    set(
+      namespace: string
+    , key: string
+    , value: string
+    , timeToLive: number
+    , timeBeforeDeletion: number
+    , timeout?: number
+    ): Promise<void>
+    del(namespace: string, key: string, timeout?: number): Promise<void>
+    clear(namespace: string, timeout?: number): Promise<void>
+    getAllItemKeys(namespace: string, timeout?: number): Promise<string[]>
+    getAllNamespaces(timeout?: number): Promise<string[]>
+    stats(namespace: string, timeout?: number): Promise<IStats>
+}
+```