UNPKG

@harelpls/use-pusher

Version:

A wrapper around pusher-js for easy-as hooks in React.

mayteio/use-pusher

325 lines (181 loc) • 15.7 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
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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
### Changelog All notable changes to this project will be documented in this file. Dates are displayed in UTC. Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog). #### [v7.1.0](https://github.com/mayteio/use-pusher/compare/v7.0.0...v7.1.0) > 18 September 2020 - 🏷 add metadata type to useEvent (test missing, pending pusher-js-mock update) [`7cc8563`](https://github.com/mayteio/use-pusher/commit/7cc856310548453bdc8f32ac264aa237456fcb87) - 📦 7.0.0 [`7ad36fb`](https://github.com/mayteio/use-pusher/commit/7ad36fbc920cdff7db724c36b0bb02bd503df687) - 😬 fix a regression where __PusherContext was no longer exposed by the package. [`1fb5f43`](https://github.com/mayteio/use-pusher/commit/1fb5f43a02c02b38d4af40e620010af852205b65) ### [v7.0.0](https://github.com/mayteio/use-pusher/compare/v6.0.3...v7.0.0) > 19 August 2020 - ♻️ giant restructure, added working native example [`1fb455b`](https://github.com/mayteio/use-pusher/commit/1fb455b416566c589cf13251fb08ce74fe7ce6e8) - ✨ added example-rn [`330a1ef`](https://github.com/mayteio/use-pusher/commit/330a1efef39b7a34da36c77f5ef21d0041eede73) - 🚧 WIP getting example-rn working [`ef30ce5`](https://github.com/mayteio/use-pusher/commit/ef30ce5a48afa750bf74165efbeb3bcfe22c5611) #### [v6.0.3](https://github.com/mayteio/use-pusher/compare/v6.0.2...v6.0.3) > 19 August 2020 - 📦Updated changelog [`358c976`](https://github.com/mayteio/use-pusher/commit/358c976a6fb589a6d1185fce41f1defb147d1331) #### [v6.0.2](https://github.com/mayteio/use-pusher/compare/v6.0.1...v6.0.2) > 23 July 2020 - ✨ allow channel to be undefined across hooks that take a channel argument [`1162edf`](https://github.com/mayteio/use-pusher/commit/1162edfd9b1688f3213d7789c59497c0d96a72e4) #### [v6.0.1](https://github.com/mayteio/use-pusher/compare/v6.0.0...v6.0.1) > 22 July 2020 - 📦 Update changelog [`41daf31`](https://github.com/mayteio/use-pusher/commit/41daf3110396e7854d96b3ebf1be2cd705303dd4) - 📦 include netlify deployment in docs script [`eba9ccd`](https://github.com/mayteio/use-pusher/commit/eba9ccdd147035c7ab3f1c82e72378d3ed397922) ### [v6.0.0](https://github.com/mayteio/use-pusher/compare/v5.1.0...v6.0.0) > 22 July 2020 - ✨ react native support [`#7`](https://github.com/mayteio/use-pusher/pull/7) - Bump websocket-extensions from 0.1.3 to 0.1.4 in /example [`#12`](https://github.com/mayteio/use-pusher/pull/12) - Bump acorn from 5.7.3 to 5.7.4 in /example [`#9`](https://github.com/mayteio/use-pusher/pull/9) - ♻️ Loosen channelName requirement in use(presence)Channel to allow channelName to be undefined (plus tests) [`ca6e1af`](https://github.com/mayteio/use-pusher/commit/ca6e1af6b3c2253a1f915a88f44747529d46611d) - ✍️ Document new changes [`573f7e3`](https://github.com/mayteio/use-pusher/commit/573f7e3c60345b738ab97c6affe91e7351ba136f) #### [v5.1.0](https://github.com/mayteio/use-pusher/compare/v5.0.0...v5.1.0) > 11 July 2020 - Bump acorn from 5.7.3 to 5.7.4 [`#8`](https://github.com/mayteio/use-pusher/pull/8) - 📦 upgrade dependencies [`e029fe7`](https://github.com/mayteio/use-pusher/commit/e029fe71c06c062c464edcfc1af7d86ad2b86325) - ✨ unsubscribe from channel on effect cleanup [`2680446`](https://github.com/mayteio/use-pusher/commit/268044619e47101579c87fedcccd59a69a0980fa) - ✨ add 'me' and 'count' to presenceChannel return [`80c017b`](https://github.com/mayteio/use-pusher/commit/80c017b337d5b62f107e662c43902483a0c2485e) ### [v5.0.0](https://github.com/mayteio/use-pusher/compare/v4.1.5...v5.0.0) > 23 June 2020 - 🗑 remove react-scripts dependency, introduce jest directly [`0460115`](https://github.com/mayteio/use-pusher/commit/0460115f6d079c4f5fe2382d9e82c5459a3cd856) - ✨ Add react-native support! [`bd96f9f`](https://github.com/mayteio/use-pusher/commit/bd96f9fe7cb65c3c1b61c3672be90cbeb21df541) - ⬆️ upgrade deps [`fcf3c92`](https://github.com/mayteio/use-pusher/commit/fcf3c921fa58d7a406632cceff43d05a5493e569) #### [v4.1.5](https://github.com/mayteio/use-pusher/compare/v4.1.4...v4.1.5) > 4 June 2020 - ✨ unsubscribe from channel on effect cleanup [`2680446`](https://github.com/mayteio/use-pusher/commit/268044619e47101579c87fedcccd59a69a0980fa) #### [v4.1.4](https://github.com/mayteio/use-pusher/compare/v4.1.3...v4.1.4) > 25 March 2020 - ✅ added testUtils file [`0798afc`](https://github.com/mayteio/use-pusher/commit/0798afca4dc54810db04c92cd52b43a257f04b8c) #### [v4.1.3](https://github.com/mayteio/use-pusher/compare/v4.1.2...v4.1.3) > 3 March 2020 - ⬆️ upgrade deps [`fcf3c92`](https://github.com/mayteio/use-pusher/commit/fcf3c921fa58d7a406632cceff43d05a5493e569) #### [v4.1.2](https://github.com/mayteio/use-pusher/compare/v4.1.1...v4.1.2) > 3 March 2020 - ✅ 100% code coverage yeehaa [`a301670`](https://github.com/mayteio/use-pusher/commit/a3016704ecb29fca84c3a753dae095b12747fdb0) #### [v4.1.1](https://github.com/mayteio/use-pusher/compare/v4.1.0...v4.1.1) > 3 March 2020 - ♻️ complete rewrite of tests to use new pusher-js-mock [`4323bc2`](https://github.com/mayteio/use-pusher/commit/4323bc234b32bdfc2ab0b69bf7bd821f3775b77e) #### [v4.1.0](https://github.com/mayteio/use-pusher/compare/v4.0.1...v4.1.0) > 27 February 2020 - ✨ removed local mocks, migrate to pusher-js-mock. Not happy with the tests. [`8d09648`](https://github.com/mayteio/use-pusher/commit/8d09648b5ca4a12ce709704dca0a4dba574eba0d) #### [v4.0.1](https://github.com/mayteio/use-pusher/compare/v4.0.0...v4.0.1) > 21 February 2020 - 🧹 added changelog [`90a6737`](https://github.com/mayteio/use-pusher/commit/90a6737020216772b1f40427a09465bf73755986) - 🧹 move to @harelpls/use-pusher [`43dac8a`](https://github.com/mayteio/use-pusher/commit/43dac8ab0b26b15dd95f50efc2b979cd6fbc3a57) - ✍️ update docs and changelog to reflect breaking change. [`a561c14`](https://github.com/mayteio/use-pusher/commit/a561c14fe818542781a1ec4daf1fa6debb768db4) ### [v4.0.0](https://github.com/mayteio/use-pusher/compare/v3.2.3...v4.0.0) > 21 February 2020 - 🚨 breaking change - switch storage of pusher from useRef to useState. This allows apps to react to when the client gets instantiated each time. [`4af67de`](https://github.com/mayteio/use-pusher/commit/4af67de40eed766df66fa19341a562d9642e71cf) #### [v3.2.3](https://github.com/mayteio/use-pusher/compare/v3.2.2...v3.2.3) > 21 February 2020 #### [v3.2.2](https://github.com/mayteio/use-pusher/compare/v3.2.1...v3.2.2) > 21 February 2020 - ♻️ Add example cra, remove pusher.disconnect as it's not needed and was causing problems. [`68af24a`](https://github.com/mayteio/use-pusher/commit/68af24a06af61290a6459a7f92f17e7f14ab025d) #### [v3.2.1](https://github.com/mayteio/use-pusher/compare/v3.2.0...v3.2.1) > 19 February 2020 - 📦 make build ACTUALLY CommonJS (ES6 without import/export statements). Fix use-pusher test. [`89c259d`](https://github.com/mayteio/use-pusher/commit/89c259dfd34fc0adeebeedb53ebca06ff8ce4583) - 🍾 added changelog [`d42a39b`](https://github.com/mayteio/use-pusher/commit/d42a39bf39ba2eb3fefe7e91734549e42687e87d) - Minor refactor for performance and code cohesion. [`72da50b`](https://github.com/mayteio/use-pusher/commit/72da50b1c3fff4dd1b0a4030e5170a2bcda9538c) #### [v3.2.0](https://github.com/mayteio/use-pusher/compare/v3.1.3...v3.2.0) > 18 February 2020 - 🏷♻️ improved types, refactored hooks for simplicity [`0d77035`](https://github.com/mayteio/use-pusher/commit/0d7703584d6cd6a498c135fe00acb5ea43928654) #### [v3.1.3](https://github.com/mayteio/use-pusher/compare/v3.1.2...v3.1.3) > 14 February 2020 - udpate docs [`ac90b4d`](https://github.com/mayteio/use-pusher/commit/ac90b4d9cfe4513eaf998c8898f5ba7f1c95c620) - 🚑 add useClientTrigger to docs [`7325511`](https://github.com/mayteio/use-pusher/commit/732551127de0686661163e6050b09349054a8b34) #### [v3.1.2](https://github.com/mayteio/use-pusher/compare/v3.1.1...v3.1.2) > 13 February 2020 #### [v3.1.1](https://github.com/mayteio/use-pusher/compare/v3.1.0...v3.1.1) > 12 February 2020 - 🚑 bump pusher-js dep [`d88ede7`](https://github.com/mayteio/use-pusher/commit/d88ede727c6f8aeb64757d451540851aec252ea5) #### [v3.1.0](https://github.com/mayteio/use-pusher/compare/v3.0.8...v3.1.0) > 12 February 2020 - 🏷 use official typescript typings [`d3b5d4f`](https://github.com/mayteio/use-pusher/commit/d3b5d4f7acc5d8d0a593ebf752d7d23fe94a58c5) - ✨warn, instead of throw error, when context isn't available [`ac5bb8e`](https://github.com/mayteio/use-pusher/commit/ac5bb8e75520f55e749aa1ddf0981a1acf3ea4d8) #### [v3.0.8](https://github.com/mayteio/use-pusher/compare/v3.0.7...v3.0.8) > 21 January 2020 #### [v3.0.7](https://github.com/mayteio/use-pusher/compare/v3.0.6...v3.0.7) > 21 January 2020 #### [v3.0.6](https://github.com/mayteio/use-pusher/compare/v3.0.5...v3.0.6) > 21 January 2020 #### [v3.0.5](https://github.com/mayteio/use-pusher/compare/v3.0.4...v3.0.5) > 14 February 2020 - 🏷 use official typescript typings [`d3b5d4f`](https://github.com/mayteio/use-pusher/commit/d3b5d4f7acc5d8d0a593ebf752d7d23fe94a58c5) - udpate docs [`ac90b4d`](https://github.com/mayteio/use-pusher/commit/ac90b4d9cfe4513eaf998c8898f5ba7f1c95c620) - 🧹 added changelog [`90a6737`](https://github.com/mayteio/use-pusher/commit/90a6737020216772b1f40427a09465bf73755986) #### [v3.0.4](https://github.com/mayteio/use-pusher/compare/v3.0.3...v3.0.4) > 21 January 2020 - 🧹 clean up dependencies [`4753090`](https://github.com/mayteio/use-pusher/commit/47530903e5f31fbc46cb714f6896a217776d4048) #### [v3.0.3](https://github.com/mayteio/use-pusher/compare/v3.0.2...v3.0.3) > 30 October 2019 #### [v3.0.2](https://github.com/mayteio/use-pusher/compare/v3.0.1...v3.0.2) > 29 October 2019 #### [v3.0.1](https://github.com/mayteio/use-pusher/compare/v3.0.0...v3.0.1) > 29 October 2019 - ✨remove memoised callback, pass empty data object [`f13d3d6`](https://github.com/mayteio/use-pusher/commit/f13d3d6f4bb9fd429d9b6555a56fb66d47281ad4) ### [v3.0.0](https://github.com/mayteio/use-pusher/compare/v2.0.0...v3.0.0) > 29 October 2019 - ♻️ improve DX: `useEvent<T>(data?: T)` [`42bb95a`](https://github.com/mayteio/use-pusher/commit/42bb95a48bb8b42c038166b5b557fea446d84607) ### [v2.0.0](https://github.com/mayteio/use-pusher/compare/v1.1.5...v2.0.0) > 18 October 2019 - stable release [`9db276d`](https://github.com/mayteio/use-pusher/commit/9db276d02627ec8386e69f42ea64b13dbc679477) - 📝 Testing presence channels [`f4e9929`](https://github.com/mayteio/use-pusher/commit/f4e9929fabccc5a78c1adbba394204005e146c3a) - 📝 docs [`8b9b625`](https://github.com/mayteio/use-pusher/commit/8b9b625101355d1f4bbeeee6a6fff87f135df571) #### [v1.1.5](https://github.com/mayteio/use-pusher/compare/v1.1.4...v1.1.5) > 26 August 2019 - ✅ Added testing example to documentation [`#1`](https://github.com/mayteio/use-pusher/pull/1) - 📝 document onEvent dependency array [`704ccee`](https://github.com/mayteio/use-pusher/commit/704ccee522a71b1e87814671621a3afa5da97d7c) - ♻️ refactor, set default members [`e75666a`](https://github.com/mayteio/use-pusher/commit/e75666a88783637f865a812209fabb5527c4b15a) - ✅ update tests [`fa564ba`](https://github.com/mayteio/use-pusher/commit/fa564ba5417ceded98fd369e2cb01d26d4e3d0f0) #### [v1.1.4](https://github.com/mayteio/use-pusher/compare/v1.1.3...v1.1.4) > 23 August 2019 - 📦 update deps + types [`9d4a5fb`](https://github.com/mayteio/use-pusher/commit/9d4a5fb53c797386d4d9d2c66a89c46030fc5a65) #### [v1.1.3](https://github.com/mayteio/use-pusher/compare/v1.1.2...v1.1.3) > 21 August 2019 - 🧹 do a barrel roll! [`ae37457`](https://github.com/mayteio/use-pusher/commit/ae37457d17388cc9cdad4ee97be3c28c0aad9684) #### [v1.1.2](https://github.com/mayteio/use-pusher/compare/v1.1.1...v1.1.2) > 21 August 2019 - 📝 docs & readme [`beac1ff`](https://github.com/mayteio/use-pusher/commit/beac1ff63121450ad3dbc18df3a1719b59e3d518) - ✨ expose PusherMocks & co, types [`b98082c`](https://github.com/mayteio/use-pusher/commit/b98082c0b9d2adc5785d28b097dad462692a0acd) #### [v1.1.1](https://github.com/mayteio/use-pusher/compare/v1.1.0...v1.1.1) > 21 August 2019 - ✅ no errors when pusherClientRef is undefined [`f58b4e4`](https://github.com/mayteio/use-pusher/commit/f58b4e43e75300f34a92e83a663256f22ffdd81c) #### [v1.1.0](https://github.com/mayteio/use-pusher/compare/v1.0.10...v1.1.0) > 21 August 2019 - ♻️ API Cleanup & docs [`05c2b2e`](https://github.com/mayteio/use-pusher/commit/05c2b2e6ff4252a0d05824588f3aa7e8a9ea2aab) - ✨♻️ simplify useChannel, add useEvent + tests [`d440d3b`](https://github.com/mayteio/use-pusher/commit/d440d3b1ebd36742ac094a67716d9dc4409352f0) #### [v1.0.10](https://github.com/mayteio/use-pusher/compare/v1.0.9...v1.0.10) > 20 August 2019 #### [v1.0.9](https://github.com/mayteio/use-pusher/compare/v1.0.8...v1.0.9) > 20 August 2019 - 📝 docs update [`277b6d6`](https://github.com/mayteio/use-pusher/commit/277b6d6c19b337b79381aebbdd3aab9f236b5f5b) - ✨ usePresenceChannel with members [`5299be5`](https://github.com/mayteio/use-pusher/commit/5299be5281e55299dbdada441182cd5effbe03e5) - ✅ code coverage + more robust channels [`161be56`](https://github.com/mayteio/use-pusher/commit/161be560d1790f1454206185a81e8ff0512f61a6) #### [v1.0.8](https://github.com/mayteio/use-pusher/compare/v1.0.7...v1.0.8) > 17 August 2019 - add additional warn guard. update dependencies. [`2cc5a22`](https://github.com/mayteio/use-pusher/commit/2cc5a22fc03fb9cc4557d8c39913d9bed90bee64) - cleanup release script with types [`82e90c8`](https://github.com/mayteio/use-pusher/commit/82e90c859ef1e67334cb3a6350ef694169bdb2c8) #### [v1.0.7](https://github.com/mayteio/use-pusher/compare/v1.0.6...v1.0.7) > 17 August 2019 #### [v1.0.6](https://github.com/mayteio/use-pusher/compare/v1.0.5...v1.0.6) > 17 August 2019 - publish cleanup [`e3b80aa`](https://github.com/mayteio/use-pusher/commit/e3b80aa69a66c5b5ea39a1d5199ad9d9e8ca2151) - switch useChannel arguments to prioritise dependencies over options [`a832045`](https://github.com/mayteio/use-pusher/commit/a832045aedf3d9b7334f9500d8b5b29deb28976f) #### [v1.0.5](https://github.com/mayteio/use-pusher/compare/v1.0.4...v1.0.5) > 17 August 2019 - remove __tests__ from dist [`3bf4195`](https://github.com/mayteio/use-pusher/commit/3bf4195df85b7f4903fdd0b264e95e2199fdcc51) #### [v1.0.4](https://github.com/mayteio/use-pusher/compare/v1.0.3...v1.0.4) > 17 August 2019 - add files entry to package.json [`da2e191`](https://github.com/mayteio/use-pusher/commit/da2e191a60d5e831042a24c5eb3c2590cc30169f) #### [v1.0.3](https://github.com/mayteio/use-pusher/compare/v1.0.2...v1.0.3) > 17 August 2019 - added types entry to package.json [`7c90efb`](https://github.com/mayteio/use-pusher/commit/7c90efb170bc419a9fc9b63607fbd01bec920621) #### [v1.0.2](https://github.com/mayteio/use-pusher/compare/v1.0.1...v1.0.2) > 17 August 2019 - added docs [`daced79`](https://github.com/mayteio/use-pusher/commit/daced79c2bbaf4618ff16f36e8bb268a68e653db) - Updated docs [`81e8698`](https://github.com/mayteio/use-pusher/commit/81e86982daa8a68d8e2ce588b6941f8561524588) - ignore test coverage [`2ccf3c4`](https://github.com/mayteio/use-pusher/commit/2ccf3c45fc72f2b851d2ca61bd16843cbb1e84b2) #### v1.0.1 > 17 August 2019 - init create-react-hook@2.6.18 [`f23b65c`](https://github.com/mayteio/use-pusher/commit/f23b65c9e01606e436f409bcebea0b3851ce531e) - 🎉 initial commit [`4641ff1`](https://github.com/mayteio/use-pusher/commit/4641ff1fd6acd0e36cadd399dc088e2c5c6fbfa1) - trying to get types working. [`45a0d2b`](https://github.com/mayteio/use-pusher/commit/45a0d2bf975e8e40cf09b76c79ea7f85e82e3b62)