Skip to content

Commit 0b3c11d

Browse files
committed
Document chained batch encoding options (Level/levelup#633)
1 parent 52314bf commit 0b3c11d

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -282,15 +282,15 @@ db.batch()
282282
.write(function () { console.log('Done!') })
283283
```
284284

285-
**`batch.put(key, value)`**
285+
**`batch.put(key, value[, options])`**
286286

287-
Queue a _put_ operation on the current batch, not committed until a `write()` is called on the batch.
287+
Queue a _put_ operation on the current batch, not committed until a `write()` is called on the batch. The `options` argument is passed on to the underlying store; `options.keyEncoding` and `options.valueEncoding` are passed to [`encoding-down`][encoding-down], allowing you to override the key- and/or value encoding of this operation.
288288

289289
This method may `throw` a `WriteError` if there is a problem with your put (such as the `value` being `null` or `undefined`).
290290

291-
**`batch.del(key)`**
291+
**`batch.del(key[, options])`**
292292

293-
Queue a _del_ operation on the current batch, not committed until a `write()` is called on the batch.
293+
Queue a _del_ operation on the current batch, not committed until a `write()` is called on the batch. The `options` argument is passed on to the underlying store; `options.keyEncoding` is passed to [`encoding-down`][encoding-down], allowing you to override the key encoding of this operation.
294294

295295
This method may `throw` a `WriteError` if there is a problem with your delete.
296296

0 commit comments

Comments
 (0)