{"id":31768100,"url":"https://github.com/pthm/redular","last_synced_at":"2025-10-10T01:54:48.957Z","repository":{"id":30582175,"uuid":"34137236","full_name":"pthm/redular","owner":"pthm","description":"Node.js event scheduling system powered by Redis keyspace notifications","archived":false,"fork":false,"pushed_at":"2015-06-20T01:39:38.000Z","size":248,"stargazers_count":9,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-12T07:59:11.963Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pthm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-04-17T19:58:04.000Z","updated_at":"2018-03-23T06:03:44.000Z","dependencies_parsed_at":"2022-09-16T02:12:06.934Z","dependency_job_id":null,"html_url":"https://github.com/pthm/redular","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/pthm/redular","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pthm%2Fredular","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pthm%2Fredular/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pthm%2Fredular/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pthm%2Fredular/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pthm","download_url":"https://codeload.github.com/pthm/redular/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pthm%2Fredular/sbom","scorecard":{"id":748770,"data":{"date":"2025-08-11","repo":{"name":"github.com/pthm/redular","commit":"571d0430065a521c5b0d5da81fc5ae288fd587ec"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-22T19:38:50.348Z","repository_id":30582175,"created_at":"2025-08-22T19:38:50.348Z","updated_at":"2025-08-22T19:38:50.348Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279002396,"owners_count":26083375,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-09T02:00:07.460Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-10-10T01:54:46.079Z","updated_at":"2025-10-10T01:54:48.947Z","avatar_url":"https://github.com/pthm.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# redular [![Build Status](https://travis-ci.org/pthm/redular.svg?branch=master)](https://travis-ci.org/pthm/redular)\nNode.js event scheduling system powered by Redis keyspace notifications.\n\n**This is a work in progress**\n\n[![NPM](https://nodei.co/npm/redular.png)](https://nodei.co/npm/redular/)\n\n# How it works\nThis sets keys in redis with expiry times, then using the keyspace notifications triggers handlers defined in your code.\n\nThis is useful because it means you can define handlers and trigger them from anywhere in your infrastructure.\n\n# Installation\n````\n$ npm install redular\n````\n\nThis module requires at least version 2.8.0 of Redis\nYou must enable Keyspace Notifications (Specifically expiry)\n\nYou can use the following command inside `redis-cli` to enable expiry keyspace notificaitons.\n````\n127.0.0.1:6379\u003e config set notify-keyspace-events Ex\n````\n\nAlternatively you can set `autoConfig` to true in the Redular options to attempt to automatically\nconfigure Redis.\n\n# Options\n| Key        | Value   | Default                                              | Description                                                                                      |\n|------------|---------|------------------------------------------------------|--------------------------------------------------------------------------------------------------|\n| id         | String  | Random string                                        | The name of the Redular client, this enables events to only be handled by specific Redis clients |\n| autoConfig | Boolean | false                                                | When true Redular will attempt to automatically configure Redis                                  |\n| dataExpiry | Number  | 30                                                   | Number of seconds to keep data in Redis for after event has been handled                         |\n| redis      | Object  | port: 6379, host:'localhost'                         | See [here](https://github.com/mranney/node_redis#rediscreateclient) for more options             |\n\n# Basic Usage\n```javascript\nvar Redular = require('redular');\n\nvar options = {\n  redis : {\n    port: 6379,\n    host: 'localhost'\n  }\n}\n\n//Setup Redular\nvar myRedular = new Redular(options);\n\n//Define a handler for an event\nmyRedular.defineHandler('test-event', function(){\n    console.log('Test event!');\n})\n\n//Schedule the event to happen 5 seconds in the future\nvar date = new Date();\ndate.setSeconds(date.getSeconds() + 5);\nmyRedular.scheduleEvent('test', date);\n```\n# Global vs Non-Global Events\nWhen scheduling an event you can pass in a boolean to specify if an event should be handled globally or not\n\n```javascript\n//This is a global event\nmyRedular.scheduleEvent('my-event', date, true);\n\n//This is a non-global event\nmyRedular.scheduleEvent('my-event', date, false);\n```\n## Global\nGlobal events are handled by all available handlers that match the event name and are listening for keyspace notifications.\n\n## Non-global\nThis is the default event type, they are only processed by handlers defined by the same Redular instance that scheduled them.\n\n# Passing data to handlers\nIt is possible to pass data to your handlers like so\n```javascript\nmyRedular.defineHandler('greet', function(someData){\n    console.log('Hello ' + someData.name);\n})\n\nmyRedular.scheduleEvent('greet', date, false, {name: 'Joe'});\n```\n\nThere are a few caveats with this:  \nThe data is stored in Redis as a JSON string so you cannot send functions to handlers.  \nData is passed through a JSON.stringify() before being saved to Redis, bear this in mind.\n\n# Instant events\nYou can send an event to Redular for immediate handling by using the instantEvent function\n```javascript\nmyRedular.instantEvent('greet', false, {name: 'Joe'})\n```\n \nThe options are the same as the scheduleEvent function but without passing a date object\n\n# Testing\n````\n$ npm install\n$ npm test\n````\nTests are built with mocha\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpthm%2Fredular","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpthm%2Fredular","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpthm%2Fredular/lists"}