From 85427f2ee9f0e8811627a01b631c10eaf2857cdd Mon Sep 17 00:00:00 2001 From: Young Hahn Date: Wed, 29 Oct 2014 17:29:53 -0400 Subject: [PATCH] Comment about 'batch' option. --- lib/zxystream.js | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/lib/zxystream.js b/lib/zxystream.js index b8da339..7be72cf 100644 --- a/lib/zxystream.js +++ b/lib/zxystream.js @@ -6,6 +6,11 @@ util.inherits(ZXYStream, stream.Readable); // Readable stream of line-delimited z/x/y coordinates // contained within the MBTiles `tiles` table/view. +// +// The `batch` option exists to allow tests to check that +// multiple calls to `_read` are handled properly. IRL the +// default offset of 10000 should be reasonably efficient +// and not worth messing with. function ZXYStream(source, options) { if (!source) throw new TypeError('MBTiles source required');