Skip to content

Commit

Permalink
alphabetize properly
Browse files Browse the repository at this point in the history
  • Loading branch information
Chen Doron committed Nov 6, 2019
1 parent e8b9bfe commit 765b015
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,8 @@ Initializes a new instance of the Kinesis client.
| [options.shouldParseJson] | <code>string</code> \| <code>boolean</code> | <code>&quot;auto&quot;</code> | Whether if retrieved records' data should be parsed as JSON or not. Set to "auto" to only attempt parsing if data looks like JSON. Set to true to force data parse. |
| [options.statsInterval] | <code>number</code> | <code>30000</code> | The interval in milliseconds for how often to emit the "stats" event. The event is only available while the consumer is running. |
| options.streamName | <code>string</code> | | The name of the stream to consume data from (required) |
| [options.tags] | <code>object</code> | | If provided, the client will ensure that the stream is tagged with these tags upon connection. If the stream is already tagged, the existing tags will be merged with the provided ones before updating them. |
| [options.supressThroughputWarnings] | <code>boolean</code> | <code>false</code> | Set to `true` to make the client log ProvisionedThroughputExceededException as debug rather than warning. |
| [options.tags] | <code>object</code> | | If provided, the client will ensure that the stream is tagged with these tags upon connection. If the stream is already tagged, the existing tags will be merged with the provided ones before updating them. |
| [options.useAutoCheckpoints] | <code>boolean</code> | <code>true</code> | Set to `true` to make the client automatically store shard checkpoints using the sequence number of the most-recently received record. If set to `false` consumers can use the `setCheckpoint()` function to store any sequence number as the checkpoint for the shard. |
| [options.useAutoShardAssignment] | <code>boolean</code> | <code>true</code> | Set to `true` to automatically assign the stream shards to the active consumers in the same group (so only one client reads from one shard at the same time). Set to `false` to make the client read from all shards. |
| [options.useEnhancedFanOut] | <code>boolean</code> | <code>false</code> | Set to `true` to make the client use enhanced fan-out consumers to read from shards. |
Expand Down
6 changes: 3 additions & 3 deletions lib/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -235,11 +235,11 @@ class Kinesis extends PassThrough {
* @param {number} [options.statsInterval=30000] - The interval in milliseconds for how often to
* emit the "stats" event. The event is only available while the consumer is running.
* @param {string} options.streamName - The name of the stream to consume data from (required)
* @param {boolean} [options.supressThroughputWarnings=false] - Set to `true` to make the client
* log ProvisionedThroughputExceededException as debug rather than warning.
* @param {object} [options.tags] - If provided, the client will ensure that the stream is tagged
* with these tags upon connection. If the stream is already tagged, the existing tags
* will be merged with the provided ones before updating them.
* @param {boolean} [options.supressThroughputWarnings=false] - Set to `true` to make the client
* log ProvisionedThroughputExceededException as debug rather than warning.
* @param {boolean} [options.useAutoCheckpoints=true] - Set to `true` to make the client
* automatically store shard checkpoints using the sequence number of the most-recently
* received record. If set to `false` consumers can use the `setCheckpoint()` function to
Expand Down Expand Up @@ -274,8 +274,8 @@ class Kinesis extends PassThrough {
shouldParseJson = 'auto',
statsInterval = 30000,
streamName,
tags,
supressThroughputWarnings = false,
tags,
useAutoCheckpoints = true,
useAutoShardAssignment = true,
useEnhancedFanOut = false,
Expand Down

0 comments on commit 765b015

Please sign in to comment.