-
Notifications
You must be signed in to change notification settings - Fork 10
/
Storage.ts
98 lines (91 loc) · 2.53 KB
/
Storage.ts
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
/**
* The {@link Storage} is an unordered collection of named values of any
* type. Values in the storage are named using `string` keys. The storage
* can be therefore thought of as a `Map<string, *>`.....
*/
export abstract class Storage<V> {
/**
* This method is used to finalize the initialization of the storage after
* the dependencies provided through the constructor have been prepared for
* use.
*
* This method must be invoked only once and it must be the first method
* invoked on this instance.
*
* @return This storage.
*/
init(): this {
return this;
}
/**
* Returns `true` if the entry identified by the specified key exists
* in this storage.
*
* @param key The key identifying the storage entry.
* @return `true` if the storage entry exists.
*/
has(key: string): boolean {
return false;
}
/**
* Retrieves the value of the entry identified by the specified . The
* method returns `undefined` if the entry does not exists.
*
* Entries set to the `undefined` value can be tested for existence
* using the `link has` method.
*
* @param key The key identifying the storage entry.
* @return The value of the storage entry.
*/
get(key: string): V | undefined {
return undefined;
}
/**
* Sets the storage entry identified by the specified key to the provided
* value. The method creates the entry if it does not exist already.
*
* @param key The key identifying the storage entry.
* @param value The storage entry value.
* @return This storage.
*/
set(key: string, value: V): this {
return this;
}
/**
* Deletes the entry identified by the specified key from this storage.
*
* @param key The key identifying the storage entry.
* @return This storage.
*/
delete(key: string): this {
return this;
}
/**
* Clears the storage of all entries.
*
* @return This storage.
*/
clear(): this {
return this;
}
/**
* Returns an iterator for traversing the keys in this storage. The order
* in which the keys are traversed is undefined.
*
* @return An iterator for traversing the keys in this
* storage. The iterator also implements the iterable protocol,
* returning itself as its own iterator, allowing it to be used in
* a `for..of` loop.
*/
keys(): Iterable<string> {
return [];
}
/**
* Returns the number of entries in this storage.
*
* @return The number of entries in this storage.
*/
size(): number {
return 0;
}
}