@blackglory/geyser-js 0.3.1 → 0.5.2

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.
Files changed (42) hide show
  1. package/README.md +13 -31
  2. package/dist/es2015/index.min.mjs +1 -1
  3. package/dist/es2015/index.min.mjs.map +1 -1
  4. package/dist/es2015/index.mjs +487 -223
  5. package/dist/es2015/index.mjs.map +1 -1
  6. package/dist/es2015/index.umd.js +487 -223
  7. package/dist/es2015/index.umd.js.map +1 -1
  8. package/dist/es2015/index.umd.min.js +2 -2
  9. package/dist/es2015/index.umd.min.js.map +1 -1
  10. package/dist/es2018/index.min.mjs +1 -1
  11. package/dist/es2018/index.min.mjs.map +1 -1
  12. package/dist/es2018/index.mjs +484 -222
  13. package/dist/es2018/index.mjs.map +1 -1
  14. package/dist/es2018/index.umd.js +484 -222
  15. package/dist/es2018/index.umd.js.map +1 -1
  16. package/dist/es2018/index.umd.min.js +2 -2
  17. package/dist/es2018/index.umd.min.js.map +1 -1
  18. package/lib/es2015/cycle-client.d.ts +4 -0
  19. package/lib/es2015/cycle-client.js +27 -0
  20. package/lib/es2015/cycle-client.js.map +1 -0
  21. package/lib/es2015/geyser-client.d.ts +4 -0
  22. package/lib/es2015/geyser-client.js +4 -2
  23. package/lib/es2015/geyser-client.js.map +1 -1
  24. package/lib/es2015/geyser-manager.d.ts +2 -0
  25. package/lib/es2015/geyser-manager.js +2 -0
  26. package/lib/es2015/geyser-manager.js.map +1 -1
  27. package/lib/es2015/utils.d.ts +1 -0
  28. package/lib/es2015/utils.js +4 -2
  29. package/lib/es2015/utils.js.map +1 -1
  30. package/lib/es2018/cycle-client.d.ts +4 -0
  31. package/lib/es2018/cycle-client.js +16 -0
  32. package/lib/es2018/cycle-client.js.map +1 -0
  33. package/lib/es2018/geyser-client.d.ts +4 -0
  34. package/lib/es2018/geyser-client.js +4 -2
  35. package/lib/es2018/geyser-client.js.map +1 -1
  36. package/lib/es2018/geyser-manager.d.ts +2 -0
  37. package/lib/es2018/geyser-manager.js +2 -0
  38. package/lib/es2018/geyser-manager.js.map +1 -1
  39. package/lib/es2018/utils.d.ts +1 -0
  40. package/lib/es2018/utils.js +4 -2
  41. package/lib/es2018/utils.js.map +1 -1
  42. package/package.json +17 -17
package/README.md CHANGED
@@ -1,7 +1,5 @@
1
1
  # geyser-js
2
-
3
2
  ## Install
4
-
5
3
  ```sh
6
4
  npm install --save @blackglory/geyser-js
7
5
  # or
@@ -9,13 +7,15 @@ yarn add @blackglory/geyser-js
9
7
  ```
10
8
 
11
9
  ## API
12
-
13
10
  ### GeyserClient
14
-
15
11
  ```ts
16
12
  new GeyserClient({
17
13
  server: string
18
14
  , token?: string
15
+ , basicAuth?: {
16
+ username: string
17
+ , password: string
18
+ }
19
19
  , keepalive?: boolean
20
20
  , timeout?: number
21
21
  })
@@ -31,7 +31,6 @@ interface IGeyserClientRequestOptions {
31
31
  ```
32
32
 
33
33
  #### acquire
34
-
35
34
  ```ts
36
35
  GeyserClient#acquire(
37
36
  namespace: string
@@ -40,7 +39,6 @@ GeyserClient#acquire(
40
39
  ```
41
40
 
42
41
  ### GeyserManager
43
-
44
42
  ```ts
45
43
  new GeyserManager({
46
44
  server: string
@@ -58,10 +56,17 @@ interface IGeyserManagerRequestOptions {
58
56
  }
59
57
  ```
60
58
 
61
- #### Configuration
59
+ #### Cycle
60
+ ##### resetCycle
61
+ ```ts
62
+ GeyserManager#Cycle.resetCycle(
63
+ namespace: string
64
+ , options?: IGeyserManagerRequestOptions
65
+ ): Promise<void>
66
+ ```
62
67
 
68
+ #### Configuration
63
69
  ##### getNamespaces
64
-
65
70
  ```ts
66
71
  GeyserManager#Configuration.getNamespaces(
67
72
  options?: IGeyserManagerRequestOptions
@@ -69,7 +74,6 @@ GeyserManager#Configuration.getNamespaces(
69
74
  ```
70
75
 
71
76
  ##### get
72
-
73
77
  ```ts
74
78
  GeyserManager#Configuration.get(
75
79
  namespace: string
@@ -81,7 +85,6 @@ GeyserManager#Configuration.get(
81
85
  ```
82
86
 
83
87
  ##### setDuration
84
-
85
88
  ```ts
86
89
  GeyserManager#Configuration.setDuration(
87
90
  namespace: string
@@ -91,7 +94,6 @@ GeyserManager#Configuration.setDuration(
91
94
  ```
92
95
 
93
96
  ##### removeDuration
94
-
95
97
  ```ts
96
98
  GeyserManager#Configuration.removeDuration(
97
99
  namespace: string
@@ -100,7 +102,6 @@ GeyserManager#Configuration.removeDuration(
100
102
  ```
101
103
 
102
104
  ##### setLimit
103
-
104
105
  ```ts
105
106
  GeyserManager#Configuration.setLimit(
106
107
  namespace: string
@@ -110,7 +111,6 @@ GeyserManager#Configuration.setLimit(
110
111
  ```
111
112
 
112
113
  ##### removeLimit
113
-
114
114
  ```ts
115
115
  GeyserManager#Configuration.removeLimit(
116
116
  namespace: string
@@ -119,9 +119,7 @@ GeyserManager#Configuration.removeLimit(
119
119
  ```
120
120
 
121
121
  #### Blacklist
122
-
123
122
  ##### getNamespaces
124
-
125
123
  ```ts
126
124
  GeyserManager#Blacklist.getNamespaces(
127
125
  options?: IGeyserManagerRequestOptions
@@ -129,7 +127,6 @@ GeyserManager#Blacklist.getNamespaces(
129
127
  ```
130
128
 
131
129
  ##### add
132
-
133
130
  ```ts
134
131
  GeyserManager#Blacklist.add(
135
132
  namespace: string
@@ -138,7 +135,6 @@ GeyserManager#Blacklist.add(
138
135
  ```
139
136
 
140
137
  ##### remove
141
-
142
138
  ```ts
143
139
  GeyserManager#Blacklist.remove(
144
140
  namespace: string
@@ -147,9 +143,7 @@ GeyserManager#Blacklist.remove(
147
143
  ```
148
144
 
149
145
  #### Whitelist
150
-
151
146
  ##### getNamespaces
152
-
153
147
  ```ts
154
148
  GeyserManager#Whitelist.getNamespaces(
155
149
  options?: IGeyserManagerRequestOptions
@@ -157,7 +151,6 @@ GeyserManager#Whitelist.getNamespaces(
157
151
  ```
158
152
 
159
153
  ##### add
160
-
161
154
  ```ts
162
155
  GeyserManager#Whitelist.add(
163
156
  namespace: string
@@ -166,7 +159,6 @@ GeyserManager#Whitelist.add(
166
159
  ```
167
160
 
168
161
  ##### remove
169
-
170
162
  ```ts
171
163
  GeyserManager#Whitelist.remove(
172
164
  namespace: string
@@ -175,9 +167,7 @@ GeyserManager#Whitelist.remove(
175
167
  ```
176
168
 
177
169
  #### TokenPolicy
178
-
179
170
  ##### getNamespaces
180
-
181
171
  ```ts
182
172
  GeyserManager#TokenPolicy.getNamespaces(
183
173
  options?: IGeyserManagerRequestOptions
@@ -185,7 +175,6 @@ GeyserManager#TokenPolicy.getNamespaces(
185
175
  ```
186
176
 
187
177
  ##### get
188
-
189
178
  ```ts
190
179
  GeyserManager#TokenPolicy.get(
191
180
  namespace: string
@@ -196,7 +185,6 @@ GeyserManager#TokenPolicy.get(
196
185
  ```
197
186
 
198
187
  ##### setAcquireTokenRequired
199
-
200
188
  ```ts
201
189
  GeyserManager#TokenPolicy.setAcquireTokenRequired(
202
190
  namespace: string
@@ -206,7 +194,6 @@ GeyserManager#TokenPolicy.setAcquireTokenRequired(
206
194
  ```
207
195
 
208
196
  ##### removeAcquireTokenRequired
209
-
210
197
  ```ts
211
198
  GeyserManager#TokenPolicy.removeAcquireTokenRequired(
212
199
  namespace: string
@@ -215,9 +202,7 @@ GeyserManager#TokenPolicy.removeAcquireTokenRequired(
215
202
  ```
216
203
 
217
204
  #### Token
218
-
219
205
  ##### getNamespaces
220
-
221
206
  ```ts
222
207
  GeyserManager#Token.getNamespaces(
223
208
  options?: IGeyserManagerRequestOptions
@@ -225,7 +210,6 @@ GeyserManager#Token.getNamespaces(
225
210
  ```
226
211
 
227
212
  ##### getTokens
228
-
229
213
  ```ts
230
214
  GeyserManager#Token.getTokens(
231
215
  namespace: string
@@ -236,7 +220,6 @@ GeyserManager#Token.getTokens(
236
220
  ```
237
221
 
238
222
  ##### addAcquireToken
239
-
240
223
  ```ts
241
224
  GeyserManager#Token.addAcquireToken(
242
225
  namespace: string
@@ -246,7 +229,6 @@ GeyserManager#Token.addAcquireToken(
246
229
  ```
247
230
 
248
231
  ##### removeAcquireToken
249
-
250
232
  ```ts
251
233
  GeyserManager#Token.removeAcquireToken(
252
234
  namespace: string