moxystudio / node-proper-lockfile

An inter-process and inter-machine lockfile utility that works on a local or network file system.
MIT License
239 stars 38 forks source link

docs: add reject promise / throws on error message #83

Closed pimlie closed 5 years ago

pimlie commented 5 years ago

Resolves #80

Improve readme by adding clear messages for all functions which can be rejected / throws on error.

codecov[bot] commented 5 years ago

Codecov Report

Merging #83 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #83   +/-   ##
=======================================
  Coverage   98.29%   98.29%           
=======================================
  Files           4        4           
  Lines         176      176           
  Branches       45       45           
=======================================
  Hits          173      173           
  Misses          3        3

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 3f905fd...2528d60. Read the comment docs.