/
index.d.ts
218 lines (164 loc) · 4.38 KB
/
index.d.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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
/* eslint-disable camelcase */
interface CookieSetOptions {
/**
* Default: 'Infinity'
* */
maxAgeMs?: 'Infinity' | number
domain?: string
/**
* 'secure' or ''
*
* Default: ''
* */
secure?: string
/**
* Default: '/'
* */
path?: string
}
declare type ForEachCb<T> = (val: any, key: string, ctx: T) => void
interface StorageEv {
key: string | null
oldValue: any
newValue: any
event: StorageEvent
}
declare type StorageEvHandler = (ev: StorageEv) => void
declare type ExceededCb<T> = (
err: Error &
{
[k in any]: any
},
currKeyValue: [string, any],
ctx: T,
) => void
declare class Cookie {
static get size(): number
static keys(): string[]
static values(): (string | null)[]
static entries(): (string | null)[][]
static forEach(callback: ForEachCb<Cookie>): void
/**
* @param { String } key
* @param { StorageValue } val
* @param { String|Number } [maxAgeMs]
* @param { String } [domain]
* @param { String } [secure]
* @param { String } [path]
* */
static set(
key: string,
val: any,
{ maxAgeMs, domain, secure, path }?: CookieSetOptions,
): void
static get(key: string): string | null
static has(key: string): boolean
static delete(key: string): boolean
static clear(): void
}
declare class LocalStorage {
static get size(): number
static keys(): string[]
static values(): any[]
static entries(): any[][]
static forEach(callback: ForEachCb<LocalStorage>): void
static set(key: string, val: any): void
static get(key: string): any
static has(key: string): boolean
static delete(key: string): boolean
static clear(): void
static addHandler(
storageHandler: StorageEvHandler,
): ((e: StorageEvent) => void) | null
static removeHandler(
handlers: EventHandlerNonNull | EventHandlerNonNull[],
): void
}
/**
* @typedef { undefined|null|String|Number|Boolean|Object|Array } StorageValue
* */
/**
* @desc JSON stringify
* @param { StorageValue } val
* */
declare function stringifyJSON(val: any): string
/**
* @desc JSON parse
* @param { String } val
* */
declare function parseJSON(val: string): any
declare function isStorageExceeded(err: any): boolean
declare function storageAvailable(): boolean
declare function cookieAvailable(): string | boolean
declare const utils_stringifyJSON: typeof stringifyJSON
declare const utils_parseJSON: typeof parseJSON
declare const utils_isStorageExceeded: typeof isStorageExceeded
declare const utils_storageAvailable: typeof storageAvailable
declare const utils_cookieAvailable: typeof cookieAvailable
declare namespace utils {
export {
utils_stringifyJSON as stringifyJSON,
utils_parseJSON as parseJSON,
utils_isStorageExceeded as isStorageExceeded,
utils_storageAvailable as storageAvailable,
utils_cookieAvailable as cookieAvailable,
}
}
/**
* @class Storage
* */
declare class Storage {
storage: any
exceededCallback?: ExceededCb<Storage>
/**
* @typedef { Function } ExceededCallback
* @param { Error } error
* @param { Array } params params[0] => key; params[1] => value
* @param { Storage } storage
* */
/**
* @param { Boolean } useCookie Use cookie or not
* @param { ExceededCallback } [exceededCallback] Callback of QUOTA_EXCEEDED_ERROR,
* */
constructor(useCookie?: boolean, exceededCallback?: ExceededCb<Storage>)
get size(): any
keys(): any
values(): any
entries(): any
forEach(callback: ForEachCb<any>): void
set(key: string, val: any): void
get(key: string): any
has(key: string): any
delete(key: string): any
clear(): void
addHandler(storageHandler: StorageEvHandler): any
removeHandler(handlers: EventHandlerNonNull | EventHandlerNonNull[]): void
}
declare class StorageItem<Value = string> {
static StorageOptions: {
useCookie?: boolean
exceededCallback?: (
error: Error,
[key, value]: [string, any],
instance: Storage,
) => void
}
private readonly key
private readonly storage
constructor(key: string, isCookie?: boolean)
set(val: Value): void
get(): Value | null
del(): any
}
export {
Cookie,
CookieSetOptions,
ExceededCb,
ForEachCb,
LocalStorage,
Storage,
StorageEv,
StorageEvHandler,
StorageItem,
utils as StorageUtils,
}