Skip to content
This repository was archived by the owner on Jul 3, 2019. It is now read-only.

Commit afcd456

Browse files
committed
fix(docs): fix header name conflict in readme
1 parent 99769f6 commit afcd456

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -329,25 +329,25 @@ request.get(
329329

330330
`cacache.put` functions have a number of options in common.
331331

332-
##### `metadata`
332+
##### `opts.metadata`
333333

334334
Arbitrary metadata to be attached to the inserted key.
335335

336-
##### `size`
336+
##### `opts.size`
337337

338338
If provided, the data stream will be verified to check that enough data was
339339
passed through. If there's more or less data than expected, insertion will fail
340340
with an `EBADSIZE` error.
341341

342-
##### `integrity`
342+
##### `opts.integrity`
343343

344344
If present, the pre-calculated digest for the inserted content. If this option
345345
if provided and does not match the post-insertion digest, insertion will fail
346346
with an `EBADCHECKSUM` error.
347347

348348
`hashAlgorithm` has no effect if this option is present.
349349

350-
##### `hashAlgorithm`
350+
##### `opts.hashAlgorithm`
351351

352352
Default: 'sha512'
353353

@@ -357,14 +357,14 @@ for inserted data. Can use any algorithm listed in `crypto.getHashes()` or
357357
`'omakase'`/`'お任せします'` to pick a random hash algorithm on each insertion. You
358358
may also use any anagram of `'modnar'` to use this feature.
359359

360-
##### `uid`/`gid`
360+
##### `opts.uid`/`opts.gid`
361361

362362
If provided, cacache will do its best to make sure any new files added to the
363363
cache use this particular `uid`/`gid` combination. This can be used,
364364
for example, to drop permissions when someone uses `sudo`, but cacache makes
365365
no assumptions about your needs here.
366366

367-
##### `memoize`
367+
##### `opts.memoize`
368368

369369
Default: null
370370

0 commit comments

Comments
 (0)