stream-chat 4.4.3 → 4.5.0-beta.0
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.
- package/README.md +4 -13
- package/dist/browser.es.js +1571 -1071
- package/dist/browser.es.js.map +1 -1
- package/dist/browser.full-bundle.min.js +1 -1
- package/dist/browser.full-bundle.min.js.map +1 -1
- package/dist/browser.js +1571 -1071
- package/dist/browser.js.map +1 -1
- package/dist/index.es.js +1571 -1071
- package/dist/index.es.js.map +1 -1
- package/dist/index.js +1571 -1071
- package/dist/index.js.map +1 -1
- package/dist/types/base64.d.ts.map +1 -1
- package/dist/types/channel.d.ts +19 -15
- package/dist/types/channel.d.ts.map +1 -1
- package/dist/types/channel_state.d.ts +2 -2
- package/dist/types/channel_state.d.ts.map +1 -1
- package/dist/types/client.d.ts +18 -39
- package/dist/types/client.d.ts.map +1 -1
- package/dist/types/client_state.d.ts +2 -2
- package/dist/types/client_state.d.ts.map +1 -1
- package/dist/types/connection.d.ts +14 -49
- package/dist/types/connection.d.ts.map +1 -1
- package/dist/types/connection_fallback.d.ts +42 -0
- package/dist/types/connection_fallback.d.ts.map +1 -0
- package/dist/types/errors.d.ts +14 -0
- package/dist/types/errors.d.ts.map +1 -0
- package/dist/types/insights.d.ts +6 -6
- package/dist/types/insights.d.ts.map +1 -1
- package/dist/types/permissions.d.ts.map +1 -1
- package/dist/types/signing.d.ts +3 -3
- package/dist/types/signing.d.ts.map +1 -1
- package/dist/types/token_manager.d.ts +2 -2
- package/dist/types/token_manager.d.ts.map +1 -1
- package/dist/types/types.d.ts +94 -80
- package/dist/types/types.d.ts.map +1 -1
- package/dist/types/utils.d.ts +12 -2
- package/dist/types/utils.d.ts.map +1 -1
- package/package.json +3 -3
- package/src/base64.ts +1 -4
- package/src/channel.ts +133 -461
- package/src/channel_state.ts +31 -158
- package/src/client.ts +277 -674
- package/src/client_state.ts +2 -2
- package/src/connection.ts +143 -394
- package/src/connection_fallback.ts +205 -0
- package/src/errors.ts +58 -0
- package/src/insights.ts +15 -23
- package/src/permissions.ts +3 -24
- package/src/signing.ts +6 -17
- package/src/token_manager.ts +6 -18
- package/src/types.ts +268 -504
- package/src/utils.ts +39 -19
- package/CHANGELOG.md +0 -844
package/README.md
CHANGED
|
@@ -75,15 +75,9 @@ const client = StreamChat.getInstance<
|
|
|
75
75
|
* Unused generics default to Record<string, unknown>
|
|
76
76
|
* with the exception of Command which defaults to string & {}
|
|
77
77
|
*/
|
|
78
|
-
const client = StreamChat.getInstance<
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
{},
|
|
82
|
-
{},
|
|
83
|
-
UserMessage | AdminMessage,
|
|
84
|
-
{},
|
|
85
|
-
ChatUser1 | ChatUser2
|
|
86
|
-
>('YOUR_API_KEY');
|
|
78
|
+
const client = StreamChat.getInstance<{}, ChatChannel, {}, {}, UserMessage | AdminMessage, {}, ChatUser1 | ChatUser2>(
|
|
79
|
+
'YOUR_API_KEY',
|
|
80
|
+
);
|
|
87
81
|
```
|
|
88
82
|
|
|
89
83
|
Query operations will return results that utilize the custom types added via generics. In addition the query filters are type checked and provide intellisense using both the key and type of the parameter to ensure accurate use.
|
|
@@ -139,10 +133,7 @@ Custom types are carried into all creation functions as well.
|
|
|
139
133
|
```typescript
|
|
140
134
|
// Valid
|
|
141
135
|
client.connectUser({ id: 'testId', nickname: 'testUser', age: 3 }, 'TestToken');
|
|
142
|
-
client.connectUser(
|
|
143
|
-
{ id: 'testId', nickname: 'testUser', avatar: 'testAvatar' },
|
|
144
|
-
'TestToken',
|
|
145
|
-
);
|
|
136
|
+
client.connectUser({ id: 'testId', nickname: 'testUser', avatar: 'testAvatar' }, 'TestToken');
|
|
146
137
|
|
|
147
138
|
// Invalid
|
|
148
139
|
client.connectUser({ id: 'testId' }, 'TestToken'); // Type ChatUser1 | ChatUser2 requires nickname for both types
|