@icanbwell/types 0.44.3 → 0.45.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@icanbwell/types",
3
- "version": "0.44.3",
3
+ "version": "0.45.0",
4
4
  "typedoc": {
5
5
  "entryPoint": "./src/index.ts",
6
6
  "tsconfig": "./tsconfig.lib.json"
@@ -36,8 +36,8 @@
36
36
  "import": "./index.js"
37
37
  }
38
38
  },
39
- "repoVersion": "1.37.1",
40
- "description": "@icanbwell/types. repo version: 1.37.1",
39
+ "repoVersion": "1.42.0",
40
+ "description": "@icanbwell/types. repo version: 1.42.0",
41
41
  "module": "./index.js",
42
42
  "main": "./index.js",
43
43
  "type": "module",
@@ -31,8 +31,24 @@ export interface IBiometrics {
31
31
  }
32
32
  export type IEvents = Pick<NativeEventEmitter, 'emit'>;
33
33
  export interface IStorage {
34
+ /**
35
+ * Set a key value pair in storage.
36
+ * @param {string} key - Key to be used for storage persistance.
37
+ * @param {string} value - Value to be persisted.
38
+ * @return {void}
39
+ */
34
40
  setItem(key: string, value: string): Promise<void>;
41
+ /**
42
+ * Extract data from storage based on supplied key.
43
+ * @param {string} key - Key to determine data to be extracted from storage.
44
+ * @return {string} Keyed data from storage.
45
+ */
35
46
  getItem(key: string): Promise<string | null>;
47
+ /**
48
+ * Remove data from storage based on supplied key.
49
+ * @param {string} key - Key to determine what key/value to remove from storage.
50
+ * @return {void}
51
+ */
36
52
  removeItem(key: string): Promise<void>;
37
53
  }
38
54
  export interface ICamera {