Skip to content

Commit

Permalink
doc: Bumped version
Browse files Browse the repository at this point in the history
  • Loading branch information
alkihis committed Nov 1, 2021
1 parent 746b6a6 commit 3692076
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 2 deletions.
4 changes: 4 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
1.6.5
-----
- Fix: Increase retry timeout on stream reconnection

1.6.4
-----
- Fix: Reject stream reconnection if a reconnect process is already started
Expand Down
2 changes: 1 addition & 1 deletion doc/streaming.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ const sampleFilterv2 = await client.v2.getStream('tweets/sample/stream');
### <a name='Methodsproperties'></a>Methods / properties

- `.autoReconnect: boolean` / defaults `false` / Set this to `true` to enable reconnect feature.
- `.autoReconnectRetries: number` / default `5` / If `autoReconnect` is `true`, maximum tries made until give up. Each try is spaced by `min((attempt ** 2) * 1000, 25000)` milliseconds.
- `.autoReconnectRetries: number` / default `5` / If `autoReconnect` is `true`, maximum tries made until give up. Each try is spaced by return of `.nextRetryTimeout()` call milliseconds.
- `.keepAliveTimeoutMs: number` / default `120000` (2 minutes) / Defined whenever connection should be automatically closed if nothing is received from Twitter during this time (it should not happend in any situation, because Twitter sends keep-alive packets). **Can be set to `Infinity` to disable this feature**.
- `.nextRetryTimeout: TStreamConnectRetryFn` / Override this function that takes a `tryOccurence` (starting from 1) and returns the number of milliseconds to wait before trying to reconnect to Twitter.
- `.close()`: Emits `ConnectionClosed` event and terminates connection.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "twitter-api-v2",
"version": "1.6.4",
"version": "1.6.5",
"description": "Strongly typed, full-featured, light, versatile yet powerful Twitter API v1.1 and v2 client for Node.js.",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down

0 comments on commit 3692076

Please sign in to comment.