{"_id":"tryer","_rev":"2-5e9f8954b4186038d978e2db6ad0f150","name":"tryer","description":"Because everyone loves a tryer! Conditional and repeated task invocation for node and browser.","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"tryer","version":"1.0.0","description":"Because everyone loves a tryer! Conditional and repeated task invocation for node and browser.","homepage":"https://github.com/philbooth/tryer","bugs":{"url":"https://github.com/philbooth/tryer/issues"},"license":"MIT","author":{"name":"Phil Booth","email":"pmbooth@gmail.com","url":"https://philbooth.me/"},"main":"./src/tryer","repository":{"type":"git","url":"https://github.com/philbooth/tryer.git"},"keywords":["repeat","retry","predicate","conditional","invocation","execution","loop","condition","termination","exponential","backoff"],"devDependencies":{"chai":"4.1.x","jshint":"2.9.x","mocha":"3.5.x","please-release-me":"1.0.x","spooks":"2.0.x","uglify-js":"3.0.x"},"scripts":{"lint":"jshint src/tryer.js test/unit.js","test":"mocha --ui tdd --reporter spec --colors test/unit.js","minify":"uglifyjs ./src/tryer.js --compress --mangle --output ./lib/tryer.min.js"},"contributors":[{"name":"Phil Booth","email":"pmbooth@gmail.com","url":"https://github.com/philbooth"},{"name":"Andrew Lawson","url":"https://github.com/adlawson"},{"name":"Tim O'Sulg","url":"https://github.com/timgluz"}],"gitHead":"7a0a34b1669e2cc565939c12904178475d39317f","_id":"tryer@1.0.0","_shasum":"027b69fa823225e551cace3ef03b11f6ab37c1d7","_from":".","_npmVersion":"3.10.10","_nodeVersion":"6.11.2","_npmUser":{"name":"philbooth","email":"pmbooth@gmail.com"},"dist":{"shasum":"027b69fa823225e551cace3ef03b11f6ab37c1d7","tarball":"https://registry.npmjs.org/tryer/-/tryer-1.0.0.tgz"},"maintainers":[{"name":"philbooth","email":"pmbooth@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/tryer-1.0.0.tgz_1504966246616_0.6375626302324235"},"directories":{}},"1.0.1":{"name":"tryer","version":"1.0.1","description":"Because everyone loves a tryer! Conditional and repeated task invocation for node and browser.","homepage":"https://gitlab.com/philbooth/tryer","bugs":{"url":"https://gitlab.com/philbooth/tryer/issues"},"license":"MIT","author":{"name":"Phil Booth","email":"pmbooth@gmail.com","url":"https://philbooth.me/"},"main":"./src/tryer","repository":{"type":"git","url":"git+https://gitlab.com/philbooth/tryer.git"},"keywords":["repeat","retry","predicate","conditional","invocation","execution","loop","condition","termination","exponential","backoff"],"devDependencies":{"chai":"4.1.x","jshint":"2.9.x","mocha":"5.2.x","please-release-me":"2.0.x","spooks":"2.0.x","uglify-js":"3.4.x"},"scripts":{"lint":"jshint src/tryer.js test/unit.js","test":"mocha --ui tdd --reporter spec --colors test/unit.js","minify":"uglifyjs ./src/tryer.js --compress --mangle --output ./lib/tryer.min.js"},"contributors":[{"name":"Phil Booth","email":"pmbooth@gmail.com","url":"https://philbooth.me/"},{"name":"Andrew Lawson","url":"https://github.com/adlawson"},{"name":"Tim O'Sulg","url":"https://github.com/timgluz"}],"gitHead":"0ded48c506a02646126f65673953c5e93a89798c","_id":"tryer@1.0.1","_npmVersion":"6.1.0","_nodeVersion":"8.11.1","_npmUser":{"name":"philbooth","email":"pmbooth@gmail.com"},"dist":{"integrity":"sha512-c3zayb8/kWWpycWYg87P71E1S1ZL6b6IJxfb5fvsUgsf0S2MVGaDhDXXjDMpdCpfWXqptc+4mXwmiy1ypXqRAA==","shasum":"f2c85406800b9b0f74c9f7465b81eaad241252f8","tarball":"https://registry.npmjs.org/tryer/-/tryer-1.0.1.tgz","fileCount":14,"unpackedSize":36263,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbL00NCRA9TVsSAnZWagAAWJwQAItRH370LVO96Xj8GwYI\n/MkhdvB+gw4YGMTnNwfsdSAhJDkfY+8btGu8EmnS6DPt3rElXNwkE+5Kb06+\nijWbWMi7Lpycm5CcNB+RGmJOO+yzCuQugequ/r/pIZfYFr9TbchWhTdaUVB1\nHx5UqwC1gBsUYml/y1DbgXAu4ZWo8tMu7tGHrbL5UvAbte2pZkC+3uXo5YzZ\nWZiIX+IJRXuA17Fz16W13i3z5wE9w/a3x3JVa303e/yUZdeUyw/+oD8BnllR\n4n88I5nFNp+i7RPOMc02jmKAgjDRv7v7CExls0t1AlpZYmItYPE6K2N+HQAA\nVBSjIdtbR15hFWZz/Q61DUkCbKSl03BfFLflu0TrTQMcvxesAatrWv85HCmn\nH3GSeDg4hHKfgx5cW+hes9y6edyurPB1qgx58ReKOPSxBI9SU+2TBqxeCjjk\nfuU1xmgg+JC1pgSd/aFwoeg8ePc+Na2D4JyfX4uTV5//10oatm/AqIG0CmQU\n8dpB7tZRZxLrJ1MfI7MHKAd5+wXLiBpEsl4Md1b3f+j2RQTFXY2zzPRAgcT/\nlXzTIMZG48Z+c7RJlz7Popnt6Kc4vCNBHVkSXR6LIi2ywGi9QLVootf5o8Il\nuXV98/5NE27qB0bn3VQsAzfrJJXWan+qZt5Fa5fKHWPB9yYBJ7j0rLzDyFRI\nJpBs\r\n=NEnh\r\n-----END PGP SIGNATURE-----\r\n"},"maintainers":[{"name":"philbooth","email":"pmbooth@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/tryer_1.0.1_1529826573933_0.5249023684379379"}}},"readme":"# tryer\n\n[![Build status](https://gitlab.com/philbooth/tryer/badges/master/pipeline.svg)](https://gitlab.com/philbooth/tryer/pipelines)\n[![Package status](https://img.shields.io/npm/v/tryer.svg)](https://www.npmjs.com/package/tryer)\n[![Downloads](https://img.shields.io/npm/dm/tryer.svg)](https://www.npmjs.com/package/tryer)\n[![License](https://img.shields.io/npm/l/tryer.svg)](https://opensource.org/licenses/MIT)\n\n\nBecause everyone loves a tryer!\nConditional\nand repeated\nfunction invocation\nfor node\nand browser.\n\n* [Say what?](#say-what)\n* [What size is it?](#what-size-is-it)\n* [How do I install it?](#how-do-i-install-it)\n* [How do I use it?](#how-do-i-use-it)\n  * [Loading the library](#loading-the-library)\n  * [Calling the exported function](#calling-the-exported-function)\n  * [Examples](#examples)\n* [How do I set up the dev environment?](#how-do-i-set-up-the-dev-environment)\n* [What license is it released under?](#what-license-is-it-released-under)\n\n## Say what?\n\nSometimes,\nyou want to defer\ncalling a function\nuntil a certain\npre-requisite condition is met.\nOther times,\nyou want to\ncall a function\nrepeatedly\nuntil some post-requisite condition\nis satisfied.\nOccasionally,\nyou might even want\nto do both\nfor the same function.\n\nTo save you writing\nexplicit conditions\nand loops\non each of those occasions,\n`tryer` implements\na predicate-based approach\nthat hides the cruft\nbehind a simple,\nfunctional interface.\n\nAdditionally,\nit allows you to easily specify\nretry intervals\nand limits,\nso that your code\ndoesn't hog the CPU.\nIt also supports\nexponential backoff\nof retry intervals,\nwhich can be useful\nwhen handling\nindefinite error states\nsuch as network failure.\n\n## What size is it?\n\n5.6 kb unminified with comments, 1.1 kb minified, 0.5 kb minified + gzipped.\n\n## How do I install it?\n\nVia npm:\n\n```\nnpm i tryer --save\n```\n\nOr if you just want the git repo:\n\n```\ngit clone git@gitlab.com:philbooth/tryer.git\n```\n\n## How do I use it?\n\n### Loading the library\n\nIf you are running in\nNode.js\nor another CommonJS-style\nenvironment,\nyou can `require`\ntryer like so:\n\n```javascript\nconst tryer = require('tryer');\n```\n\nIt also the supports\nthe AMD-style format\npreferred by Require.js.\n\nIf you are\nincluding `tryer`\nwith an HTML `<script>` tag,\nor neither of the above environments\nare detected,\nit will be exported globally as `tryer`.\n\n### Calling the exported function\n\n`tryer` is a function\nthat can be invoked to\ncall other functions\nconditionally and repeatedly,\nwithout the need for\nexplicit `if` statements\nor loops in your own code.\n\n`tryer` takes one argument,\nan options object\nthat supports\nthe following properties:\n\n* `action`:\n  The function that you want to invoke.\n  If `action` returns a promise,\n  iterations will not end\n  until the promise is resolved or rejected.\n  Alternatively,\n  `action` may take a callback argument, `done`,\n  to signal that it is asynchronous.\n  In that case,\n  you are responsible\n  for calling `done`\n  when the action is finished.\n  If `action` is not set,\n  it defaults to an empty function.\n\n* `when`:\n  A predicate\n  that tests the pre-condition\n  for invoking `action`.\n  Until `when` returns true\n  (or a truthy value),\n  `action` will not be called.\n  Defaults to\n  a function that immediately returns `true`.\n\n* `until`:\n  A predicate\n  that tests the post-condition\n  for invoking `action`.\n  After `until` returns true\n  (or a truthy value),\n  `action` will no longer be called.\n  Defaults to\n  a function that immediately returns `true`.\n\n* `fail`:\n  The error handler.\n  A function\n  that will be called\n  if `limit` falsey values\n  are returned by `when` or `until`.\n  Defaults to an empty function.\n\n* `pass`:\n  Success handler.\n  A function\n  that will be called\n  after `until` has returned truthily.\n  Defaults to an empty function.\n\n* `limit`:\n  Failure limit,\n  representing the maximum number\n  of falsey returns from `when` or `until`\n  that will be permitted\n  before invocation is deemed to have failed.\n  A negative number\n  indicates that the attempt\n  should never fail,\n  instead continuing \n  for as long as `when` and `until`\n  have returned truthy values.\n  Defaults to `-1`.\n\n* `interval`:\n  The retry interval,\n  in milliseconds.\n  A negative number indicates\n  that each subsequent retry\n  should wait for twice the interval\n  from the preceding iteration\n  (i.e. exponential backoff).\n  The default value is `-1000`,\n  signifying that\n  the initial retry interval\n  should be one second\n  and that each subsequent attempt\n  should wait for double the length\n  of the previous interval.\n\n### Examples\n\n```javascript\n// Attempt to insert a database record, waiting until `db.isConnected`\n// before doing so. The retry interval is 1 second on each iteration\n// and the call will fail after 10 attempts.\ntryer({\n  action: () => db.insert(record),\n  when: () => db.isConnected,\n  interval: 1000,\n  limit: 10,\n  fail () {\n    log.error('No database connection, terminating.');\n    process.exit(1);\n  }\n});\n```\n\n```javascript\n// Attempt to send an email message, optionally retrying with\n// exponential backoff starting at 1 second. Continue to make\n// attempts indefinitely until the call succeeds.\nlet sent = false;\ntryer({\n  action (done) {\n    smtp.send(email, error => {\n      if (! error) {\n        sent = true;\n      }\n      done();\n    });\n  },\n  until: () => sent,\n  interval: -1000,\n  limit: -1\n});\n```\n\n```javascript\n// Poll a device at 30-second intervals, continuing indefinitely.\ntryer({\n  action: () => device.poll().then(response => handle(response)),\n  interval: 30000,\n  limit: -1\n});\n```\n\n## How do I set up the dev environment?\n\nThe dev environment relies on\n[Chai],\n[JSHint],\n[Mocha],\n[please-release-me],\n[spooks.js] and\n[UglifyJS].\nThe source code is in\n`src/tryer.js`\nand the unit tests are in\n`test/unit.js`.\n\nTo install the dependencies:\n\n```\nnpm i\n```\n\nTo run the tests:\n\n```\nnpm t\n```\n\nTo lint the code:\n\n```\nnpm run lint\n```\n\nTo regenerate the minified lib:\n\n```\nnpm run minify\n```\n\n## What license is it released under?\n\n[MIT](COPYING)\n\n[chai]: http://chaijs.com/\n[jshint]: http://jshint.com/\n[mocha]: http://mochajs.org/\n[please-release-me]: https://gitlab.com/philbooth/please-release-me\n[spooks.js]: https://gitlab.com/philbooth/spooks.js\n[uglifyjs]: http://lisperator.net/uglifyjs/\n[license]: COPYING\n\n","maintainers":[{"name":"philbooth","email":"pmbooth@gmail.com"}],"time":{"modified":"2018-06-24T07:49:36.312Z","created":"2017-09-09T14:10:47.594Z","1.0.0":"2017-09-09T14:10:47.594Z","1.0.1":"2018-06-24T07:49:33.998Z"},"homepage":"https://gitlab.com/philbooth/tryer","keywords":["repeat","retry","predicate","conditional","invocation","execution","loop","condition","termination","exponential","backoff"],"repository":{"type":"git","url":"git+https://gitlab.com/philbooth/tryer.git"},"contributors":[{"name":"Phil Booth","email":"pmbooth@gmail.com","url":"https://philbooth.me/"},{"name":"Andrew Lawson","url":"https://github.com/adlawson"},{"name":"Tim O'Sulg","url":"https://github.com/timgluz"}],"author":{"name":"Phil Booth","email":"pmbooth@gmail.com","url":"https://philbooth.me/"},"bugs":{"url":"https://gitlab.com/philbooth/tryer/issues"},"license":"MIT","readmeFilename":"README.md","_attachments":{},"_etag":"W/\"a2681925de6e4b235c1596b7facd557f\"","_lastModified":"Sun, 24 Jun 2018 07:49:37 GMT","_cached":true}