File tree Expand file tree Collapse file tree 1 file changed +11
-3
lines changed
Expand file tree Collapse file tree 1 file changed +11
-3
lines changed Original file line number Diff line number Diff line change @@ -1241,7 +1241,7 @@ export interface ListenOptions {
12411241
12421242 /**
12431243 * Array of event names to include in the observable. By default, only mutation events are included.
1244- *
1244+ * Note: `welcomeback` and `reset` events requires `enableResume: true`
12451245 * @defaultValue `['mutation']`
12461246 */
12471247 events ?: ListenEventName [ ]
@@ -1265,21 +1265,29 @@ export interface ListenOptions {
12651265 tag ?: string
12661266
12671267 /**
1268- * Resumes events upon reconnect
1268+ * If this is enabled, the client will normally resume events upon reconnect
1269+ * When if enabling this, you should also add the `reset` to the events array and handle the case where the backend is unable to resume.
12691270 * @beta
12701271 * @defaultValue `false`
12711272 */
12721273 enableResume ?: boolean
12731274}
12741275
1276+ /** @public */
12751277export interface ResumableListenOptions extends Omit < ListenOptions , 'events' | 'enableResume' > {
12761278 /**
1277- * Resumes events upon reconnect
1279+ * If this is enabled, the client will normally resume events upon reconnect
1280+ * Note that you should also subscribe to `reset`-events and handle the case where the backend is unable to resume
12781281 * @beta
12791282 * @defaultValue `false`
12801283 */
12811284 enableResume : true
12821285
1286+ /**
1287+ * Array of event names to include in the observable. By default, only mutation events are included.
1288+ *
1289+ * @defaultValue `['mutation']`
1290+ */
12831291 events ?: ResumableListenEventNames [ ]
12841292}
12851293
You can’t perform that action at this time.
0 commit comments