diff --git a/api.md b/api.md new file mode 100644 index 0000000..434f801 --- /dev/null +++ b/api.md @@ -0,0 +1,13 @@ + +## ElasticsearchBulkIndexWritable(client, options) +A simple wrapper around Elasticsearch for bulk writing items + +**Kind**: global function + +| Param | Type | Default | Description | +| --- | --- | --- | --- | +| client | Elasticsearch.Client | | Elasticsearch client | +| options | Object | | Options | +| [options.highWaterMark] | Number | 16 | Number of items to buffer before writing. Also the size of the underlying stream buffer. | +| [options.logger] | Object | | Instance of a logger like bunyan or winston | +