{"id":24290522,"url":"https://github.com/dutu/taskworker","last_synced_at":"2026-04-21T07:31:03.922Z","repository":{"id":74504648,"uuid":"73800291","full_name":"dutu/taskWorker","owner":"dutu","description":"running tasks repetitively","archived":false,"fork":false,"pushed_at":"2017-06-19T09:47:13.000Z","size":58,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-06T02:32:31.612Z","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/dutu.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-11-15T09:56:28.000Z","updated_at":"2016-11-15T10:09:24.000Z","dependencies_parsed_at":null,"dependency_job_id":"e0236801-fa7b-4258-97db-ca89f0673706","html_url":"https://github.com/dutu/taskWorker","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/dutu/taskWorker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dutu%2FtaskWorker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dutu%2FtaskWorker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dutu%2FtaskWorker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dutu%2FtaskWorker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dutu","download_url":"https://codeload.github.com/dutu/taskWorker/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dutu%2FtaskWorker/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32082032,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-21T06:27:27.065Z","status":"ssl_error","status_checked_at":"2026-04-21T06:27:21.250Z","response_time":128,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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-01-16T11:53:05.158Z","updated_at":"2026-04-21T07:31:03.901Z","avatar_url":"https://github.com/dutu.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"taskWorker\n=======\n[![Build Status](https://travis-ci.org/dutu/taskWorker.svg?branch=master)](https://travis-ci.org/dutu/taskWorker/) ![Dependencies Status](https://david-dm.org/dutu/taskWorker.svg)\n\n\n\nProvides a class that can easyly be extended for funning tasks repetitively \n\nExample below defins a worker with a simple task `firstTask`, which logs to the console every second. \n\n```js\nclass Worker extends TaskWorker {\n  constructor(workerName) {\n    super(workerName);\n  }\n\n  firstTask(next) {\n\tconsole.log('log this text every 1000ms');\n    next(1000);\n  }\n}\n\nlet worker = new Worker('workersName');\nworker.registerTask('firstTask');\nworker.runTask('firstTask');\n```\n\n\nA set of configuration parameters can be defined for each task.\nExample:\n\n\n```js\nclass Worker extends TaskWorker {\n  constructor(workerName) {\n    super(workerName);\n  }\n\n  firstTask(next) {\n\tconsole.log('log this text every 1000ms');\n    next(1000);\n  }\n}\n\nlet worker = new Worker('workersName');\n\nworker.registerTask('firstTask');\nlet extendedSchema = {\n  newConfigParameter: {\n    type: String,\n    default: 'a default value',\n  },\n};\nworker.setExtendedTaskConfigSchema('firstTask', extendedSchema); \n\nworker.runTask('firstTask');\n```\n\n\n\n\n\n\n## Logger\n\n`TaskWorker` uses [winston](https://www.npmjs.com/package/winston) for logging. \nThe default logger has the Console transport defined as follwing:\n\n```js\nlet defaultLogger = new (winston.Logger)({\n  transports: [\n    new (winston.transports.Console)({\n      colorize: 'all',\n      json: 'true',\n    })\n  ],\n});\ndefaultLogger.setLevels(winston.config.syslog.levels);\n```\n\nYou can add or remove transports via the `addLoggerTransport()` and `removeLoggerTransport()` methods:\n```js\n  worker.addLoggerTransport(winston.transports.File, { filename: 'somefile.log' });\n  worker.removeLoggerTransport(winston.transports.Console);\n```\n\n## Methods\n\n### getStatus()\n\nExample:\n\n```js\nworker.getStatus();\n```\n\nExample result:\n\n```js\n{\n  \"worker\": {\n    \"restartedAt\": \"2016-11-08T10:12:42.739Z\"\n  },\n  \"tasks\": [\n    {\n      \"taskName\": \"firstTask\",\n      \"startedAt\": \"2016-11-08T10:12:42.684Z\",\n      \"shouldRun\": false,\n      \"state\": \"stopped\",\n      \"lastRunAt\": \"1970-01-01T00:00:00.000Z\",\n      \"delayedMS\": null\n    }\n  ],\n  \"dbConnection\": {\n    \"state\": null\n  }\n}\n```\n\n### setExtendedTaskConfigSchema()\n\nExtends the default task configuration schema. Schema is a JSON that follws moongoose schema types\n \nThe default task configuration schema is:\n\n```js\n{\n  taskName: {\n    type: String\n  },\n  startedAt: {\n    type: Date,\n    default: new Date(),\n  },\n  shouldRun: {\n    type: Boolean,\n    default: false,\n  },\n}\n```\n\n\n**Example:**\n\n```js\nlet extendedSchema = {\n  newConfigParameter: {\n    type: String,\n    default: 'defaultValue',\n  },\n};\n\nworker.setExtendedTaskConfigSchema(extendedSchema);\nworker.getStatus();\n```\n\nResult:\n\n```js\n{\n  \"worker\": {\n    \"restartedAt\": \"2016-11-08T10:23:21.297Z\"\n  },\n  \"tasks\": [\n    {\n      \"taskName\": \"firstTask\",\n      \"startedAt\": \"2016-11-08T10:12:42.684Z\",\n      \"shouldRun\": false,\n      \"state\": \"stopped\",\n      \"lastRunAt\": \"1970-01-01T00:00:00.000Z\",\n      \"delayedMS\": null,\n      \"newConfigParameter\": \"default value\",\n    }\n  ],\n  \"dbConnection\": {\n    \"state\": null\n  }\n}\n```\n\n# License #\n\n[MIT](LICENSE)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdutu%2Ftaskworker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdutu%2Ftaskworker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdutu%2Ftaskworker/lists"}