@webex/storage-adapter-spec 3.8.1 → 3.9.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/README.md +21 -16
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -1,14 +1,6 @@
|
|
|
1
1
|
# @webex/storage-adapter-spec
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
> Blackbox test suite for storage adapters
|
|
6
|
-
|
|
7
|
-
- [Install](#install)
|
|
8
|
-
- [Usage](#usage)
|
|
9
|
-
- [Contribute](#contribute)
|
|
10
|
-
- [Maintainers](#maintainers)
|
|
11
|
-
- [License](#license)
|
|
3
|
+
Test suite for storage adapter implementations in the Webex SDK.
|
|
12
4
|
|
|
13
5
|
## Install
|
|
14
6
|
|
|
@@ -18,6 +10,8 @@ npm install --save-dev @webex/storage-adapter-spec
|
|
|
18
10
|
|
|
19
11
|
## Usage
|
|
20
12
|
|
|
13
|
+
This package provides a standard test suite to verify storage adapter implementations.
|
|
14
|
+
|
|
21
15
|
```js
|
|
22
16
|
import runAbstractStorageAdapterSpec from '@webex/storage-adapter-spec';
|
|
23
17
|
import MyStorageAdapter from './my-storage-adapter';
|
|
@@ -25,16 +19,27 @@ import MyStorageAdapter from './my-storage-adapter';
|
|
|
25
19
|
describe('MyStorageAdapter', () => {
|
|
26
20
|
runAbstractStorageAdapterSpec(new MyStorageAdapter('test'));
|
|
27
21
|
});
|
|
22
|
+
```
|
|
28
23
|
|
|
29
|
-
##
|
|
24
|
+
## What it Tests
|
|
30
25
|
|
|
31
|
-
|
|
26
|
+
The test suite verifies that your storage adapter correctly implements:
|
|
32
27
|
|
|
33
|
-
|
|
28
|
+
- Data storage and retrieval
|
|
29
|
+
- Key-value operations (put, get, del)
|
|
30
|
+
- Namespace isolation
|
|
31
|
+
- Error handling for missing keys
|
|
32
|
+
- Clear functionality
|
|
34
33
|
|
|
35
|
-
|
|
34
|
+
## Creating Custom Adapters
|
|
36
35
|
|
|
37
|
-
|
|
36
|
+
Your storage adapter should implement:
|
|
38
37
|
|
|
39
|
-
|
|
40
|
-
|
|
38
|
+
- `bind(namespace, options)` - Return a bound storage interface
|
|
39
|
+
- Bound interface methods: `put(key, value)`, `get(key)`, `del(key)`, `clear()`
|
|
40
|
+
|
|
41
|
+
The test suite will validate these operations work correctly and handle edge cases properly.
|
|
42
|
+
|
|
43
|
+
## Usage in Testing
|
|
44
|
+
|
|
45
|
+
Include this spec in your adapter's test suite to ensure compatibility with the Webex SDK storage system.
|
package/package.json
CHANGED
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
]
|
|
20
20
|
},
|
|
21
21
|
"dependencies": {
|
|
22
|
-
"@webex/test-helper-chai": "3.
|
|
22
|
+
"@webex/test-helper-chai": "3.9.0"
|
|
23
23
|
},
|
|
24
24
|
"scripts": {
|
|
25
25
|
"build": "yarn build:src",
|
|
@@ -35,12 +35,12 @@
|
|
|
35
35
|
"@webex/eslint-config-legacy": "0.0.0",
|
|
36
36
|
"@webex/jest-config-legacy": "0.0.0",
|
|
37
37
|
"@webex/legacy-tools": "0.0.0",
|
|
38
|
-
"@webex/test-helper-chai": "3.
|
|
39
|
-
"@webex/test-helper-mocha": "3.
|
|
40
|
-
"@webex/test-helper-mock-webex": "3.
|
|
41
|
-
"@webex/test-helper-test-users": "3.
|
|
38
|
+
"@webex/test-helper-chai": "3.9.0",
|
|
39
|
+
"@webex/test-helper-mocha": "3.9.0",
|
|
40
|
+
"@webex/test-helper-mock-webex": "3.9.0",
|
|
41
|
+
"@webex/test-helper-test-users": "3.9.0",
|
|
42
42
|
"eslint": "^8.24.0",
|
|
43
43
|
"prettier": "^2.7.1"
|
|
44
44
|
},
|
|
45
|
-
"version": "3.
|
|
45
|
+
"version": "3.9.0"
|
|
46
46
|
}
|