UNPKG

caccl-api

Version:

A class that defines a set of smart Canvas endpoints that actually behave how you'd expect them to.

github.com/harvard-edtech/caccl-canvas-api

harvard-edtech/caccl-canvas-api

60 lines (37 loc) • 1.95 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# Cache Class definition for a custom cache. This cache must implement a two-level key system. When getting/setting values, both `path` and `params` (level 1 and level 2 keys, respectively) will be included. However, when deleting values, only a list of `paths` will be included. Thus, it is advantageous to create a cache that can quickly and easily delete all (`path`, `params`) key pairs that match a specific `path`. ## Summary Pass an instance of this class into CACCL functions to replace the built-in memory or session-based cache functionality. ## Properties All instances of cache must have a `storePromises` property (boolean). If the cache can store `Promise` objects, `storePromises` must equal `true`. ## Methods ### get(path, params) Argument | Type | Description :--- | :--- | :--- path | string | the url path that is to be cached params | object | the get parameters for the cached object Returns: `Promise.<object>` Promise that resolves with the cached value. ### set(path, params, value) Argument | Type | Description :--- | :--- | :--- path | string | the url path that is to be cached params | object | the get parameters for the cached object value | object | the value to save in the cache Returns: `Promise` Promise that resolves when the set is complete, rejects if failed. ### deletePaths(paths) Deletes all entries with keys: (`path`, `params`), where `path` is in the list of `paths`. This is independent of `params`. Argument | Type | Description :--- | :--- | :--- paths | string[] | a list of paths to remove from the cache (independent of params) Returns: `Promise` Promise that resolves when the paths are deleted, rejects if failed. ### getAllPaths() Returns: `Promise.<string[]>` Promise that resolves with the list of all paths, rejects if failed. ### deleteAllPaths() Clears the entire cache. Returns: `Promise` Promise that resolves when delete is complete, rejects if failed.