{"_id":"@bcgov/probot-scheduler","_rev":"45-0a112e40bb61bd8b6a1fcc433b994f3f","name":"@bcgov/probot-scheduler","dist-tags":{"latest":"1.2.1"},"versions":{"1.2.1":{"name":"@bcgov/probot-scheduler","version":"1.2.1","keywords":["probot"],"author":{"name":"Brandon Keepers"},"license":"ISC","_id":"@bcgov/probot-scheduler@1.2.1","maintainers":[{"name":"jleach","email":"jason.leach@fullboar.ca"},{"name":"kelpisland","email":"todd.wilson@gov.bc.ca"},{"name":"patricksimonian","email":"Patrick.Simonian@gov.bc.ca"}],"contributors":[{"name":"Anton Kosyakov"}],"homepage":"https://github.com/probot/scheduler#readme","bugs":{"url":"https://github.com/probot/scheduler/issues"},"dist":{"shasum":"af88f70dfc5afdce116eb14c9f2feba073d57012","tarball":"https://registry.npmjs.org/@bcgov/probot-scheduler/-/probot-scheduler-1.2.1.tgz","fileCount":5,"integrity":"sha512-xsE3BnS5Ddqyep7iJU6mK9lbUmJZWlC5M8eKdCFriDZu+6dMgBUE9QNin7pCRCOUF/SfkgPIOAep0ZPZ+KbtHQ==","signatures":[{"sig":"MEQCIBK50NgIXsDApFrOH7EbNwIc6yTtXyFte1dC0GYm5++/AiBczB3MnOzGZcyqw8GBKm2995vge/oxKNO9/H7Xs9quNw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":6747,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbyLjICRA9TVsSAnZWagAAHDwP/3FVZ11zfXTmlLk5Oeed\n8rPwxoWidJSI6xpdaKOsZ80Azv6brQA6sUULdpBPqhxchtqKXa5KUYcx2zg8\nJ2pl++0sJn4ttlRhc2fgKzPBEa+BS7kBPfZCjbqbXTl8ZCMT9UK19whSxSaF\nNU/2iP0OxPyjOCMQ8YOoHbdfBRsFqTKGJ8xBwi94czH+YOL81tmO2RROoNij\n1DsR6bqyW6hXbA+vm+oNsKRHj8Uby+lsGl2Yx57i2+AxjvaMtX2765QEeM9o\n+Do24WB3S7gF555N6OXqtd0l2HUOsPTe0Icuwhl0vuazHlkWw9vKRj7SQ670\n29gutSUd7Vb//oyrYrJwEi3kUp74dPxBRg3tBQ9bKho/TGNTYcVGaLmTLR3T\ng47nvte6RzXY8qHlDXDDQum1jSib2KApmuW9gMyrHW+ppKbYDQMCjT9WQ+EF\nu3lGAc01Y07FMTHUZO0H1dmfI3r2nzjy0C6HEYCOEL4x4+bYqLBWpj3RFGNX\nDloxSWL5X+sjtmbCUKlHQ+54tFM+LkzXcsy/XRgoo+73AcQUE3oLJYStOJIY\nw9Ls+xjRsJJSaqbn/x0HBr117MBPfmjqJf1YQ4UPGN71dgibPPI6KqWHrG6f\ntyj5pIZ0Y9vEeyn4kkJo8fdD2DRXTSH4BwerewJtBBvGH4Ak0bu3gpjTuqfQ\naFuz\r\n=r8JW\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index.js","gitHead":"96aee9343a626ab65583e72d0382a97983ea054c","scripts":{"test":"standard"},"_npmUser":{"name":"jleach","email":"jason.leach@fullboar.ca"},"standard":{"env":["mocha"]},"repository":{"url":"git+https://github.com/bcgov/scheduler.git","type":"git"},"_npmVersion":"6.4.1","description":"Probot extension to trigger events on a periodic schedule","directories":{},"_nodeVersion":"10.11.0","dependencies":{"bottleneck":"^2.0.1"},"_hasShrinkwrap":false,"devDependencies":{"standard":"^10.0.3"},"peerDependencies":{"probot":">=0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/probot-scheduler_1.2.1_1539881160419_0.8796747235892932","host":"s3://npm-registry-packages"}}},"time":{"created":"2018-10-18T16:46:00.341Z","modified":"2026-07-21T21:32:01.259Z","1.2.1":"2018-10-18T16:46:00.524Z"},"bugs":{"url":"https://github.com/probot/scheduler/issues"},"author":{"name":"Brandon Keepers"},"license":"ISC","homepage":"https://github.com/probot/scheduler#readme","keywords":["probot"],"repository":{"url":"git+https://github.com/bcgov/scheduler.git","type":"git"},"description":"Probot extension to trigger events on a periodic schedule","contributors":[{"name":"Anton Kosyakov"}],"maintainers":[{"email":"jason.leach@fullboar.ca","name":"jleach"},{"email":"shelly.han@gov.bc.ca","name":"shellyxuehan"},{"email":"jsherman@parcsystems.ca","name":"parcjason"},{"email":"adamkroon47@gmail.com","name":"akroon3r"},{"email":"NR.CommonServiceShowcase@gov.bc.ca","name":"bc-gov-common-services"},{"email":"Nicole.degreef@gov.bc.ca","name":"nicoledegreef"},{"email":"benjubb+npm@gmail.com","name":"qqnluaq"},{"email":"jujaga@gmail.com","name":"jujaga"},{"email":"darren.boss@gov.bc.ca","name":"dgboss"},{"email":"tylerkrys@gmail.com","name":"ty2k"},{"email":"michael.nelson@gov.bc.ca","name":"michael.nelson.gov.bc.ca"},{"email":"mgranbois@outlook.com","name":"mgranbois"},{"email":"shea.phillips@gmail.com","name":"sheaphillips"},{"email":"citz.codemvp@gov.bc.ca","name":"citzcodemvp"},{"email":"sidmclaughlin@gmail.com","name":"sidmclaughlin"},{"email":"taylor.friesen@gov.bc.ca","name":"taylorfries"},{"email":"braden.mitchell@gov.bc.ca","name":"bradenmitchell"},{"email":"irfan.charania@gmail.com","name":"irfan.charania"},{"email":"scott.toews@gov.bc.ca","name":"stoews"},{"email":"marcus.kernohan@gov.bc.ca","name":"mkernohanbc"},{"email":"paul.howells@gov.bc.ca","name":"paul.howells"},{"email":"jmc.supriya@gmail.com","name":"supriya-arora"},{"email":"dan.ebenal@gov.bc.ca","name":"danebenal"},{"email":"sahej.mundi@gov.bc.ca","name":"sahejmundi"},{"email":"zhanna.kolesnyk@gov.bc.ca","name":"kolezhannochka"},{"email":"danilo.meireles@gmail.com","name":"danilomeireles"},{"email":"omprakashmishra3978@gmail.com","name":"omprakashmishra"},{"email":"galen.gray@gov.bc.ca","name":"galen.gray"},{"email":"fbarreta@gmail.com","name":"fbarreta"},{"email":"jimmypalelil@gmail.com","name":"jimmypalelil"}],"readme":"## Probot: Scheduler\n\n[![npm](https://img.shields.io/npm/v/probot-scheduler.svg)](https://www.npmjs.com/package/probot-scheduler)\n\nA [Probot](https://github.com/probot/probot) extension to trigger events on an hourly schedule.\n\n## Usage\n\n```shell\n$ npm install probot-scheduler\n```\n\n```js\nconst createScheduler = require('probot-scheduler')\n\nmodule.exports = (robot) => {\n  createScheduler(robot)\n  robot.on('schedule.repository', context => {\n    // this event is triggered on an interval, which is 1 hr by default\n  })\n}\n```\n\n## Configuration\n\nThere are a few environment variables that can change the behavior of the scheduler:\n\n- `DISABLE_DELAY=true` - Perform the schedule immediately on startup, instead of waiting for the random delay between 0 and 59:59 for each repository, which exists to avoid all schedules being performed at the same time.\n\n- `IGNORED_ACCOUNTS=comma,separated,list` - GitHub usernames to ignore when scheduling. These are typically spammy or abusive accounts.\n\n\n## Options\n\nThere are a few runtime options you can pass that can change the behavior of the scheduler:\n\n* `delay` - when `false`, the schedule will be performed immediately on startup. When `true`, there will be a random delay between 0 and `interval` for each repository to avoid all schedules being performed at the same time. Default: `true` unless the `DISABLE_DELAY` environment variable is set.\n\n* `interval` - the number of milliseconds to schedule each repository. Default: 1 hour (`60 * 60 * 1000`)\n\nFor example, if you want your app to be triggered *once every day* with *delay enabled on first run*:\n\n```js\nconst createScheduler = require('probot-scheduler')\n\nmodule.exports = (robot) => {\n  createScheduler(robot, {\n    delay: !!process.env.DISABLE_DELAY, // delay is enabled on first run\n    interval: 24 * 60 * 60 * 1000 // 1 day\n  })\n  \n  robot.on('schedule.repository', context => {\n    // this event is triggered once every day, with a random delay\n  })\n}\n```\n","readmeFilename":"README.md"}