Skip to content

Commit

Permalink
Add default values to ts declaration (#21)
Browse files Browse the repository at this point in the history
This adds default values to the documentation to match the `libhoney-js` source code here: https://github.com/honeycombio/libhoney-js/blob/daf8ce02599fc1199d8db40adae5d35fc99cf159/src/libhoney.js#L21
  • Loading branch information
styfle authored Apr 8, 2019
1 parent 0b446cd commit fdfe91d
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions types/libhoney.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,35 +14,35 @@ declare module 'libhoney' {
*/
dataset: string;
/**
* Sample rate of data. If set, causes us to send 1/sampleRate of events and drop the rest.
* (Default 1) Sample rate of data. If set, causes us to send 1/sampleRate of events and drop the rest.
*/
sampleRate?: number;
/**
* We send a batch to the API when this many outstanding events exist in our event queue.
* (Default 50) We send a batch to the API when this many outstanding events exist in our event queue.
*/
batchSizeTrigger?: number;
/**
* We send a batch to the API after this many milliseconds have passed.
* (Default 100) We send a batch to the API after this many milliseconds have passed.
*/
batchTimeTrigger?: number;
/**
* We process batches concurrently to increase parallelism while sending.
* (Default 10) We process batches concurrently to increase parallelism while sending.
*/
maxConcurrentBatches?: number;
/**
* The maximum number of pending events we allow to accumulate in our sending queue before dropping them.
* (Default 10000) The maximum number of pending events we allow to accumulate in our sending queue before dropping them.
*/
pendingWorkCapacity?: number;
/**
* The maximum number of responses we enqueue before dropping them.
* (Default 1000) The maximum number of responses we enqueue before dropping them.
*/
maxResponseQueueSize?: number;
/**
* Disable transmission of events to the specified `apiHost`, particularly useful for testing or development.
*/
disabled?: boolean;
/**
* Server host to receive Honeycomb events (Defaults to https://api.honeycomb.io).
* (Default "https://api.honeycomb.io/") Server host to receive Honeycomb events (Defaults to https://api.honeycomb.io).
*/
apiHost?: string;
}
Expand Down

0 comments on commit fdfe91d

Please sign in to comment.