{"id":21611302,"url":"https://github.com/runnerty/executor-amqp","last_synced_at":"2025-03-18T16:04:40.797Z","repository":{"id":48402897,"uuid":"311053870","full_name":"runnerty/executor-amqp","owner":"runnerty","description":"Runnerty module: AMQP Publisher","archived":false,"fork":false,"pushed_at":"2022-02-05T18:49:55.000Z","size":123,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-03-22T20:52:35.672Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/runnerty.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":"2020-11-08T12:06:37.000Z","updated_at":"2022-02-05T18:49:58.000Z","dependencies_parsed_at":"2022-09-21T20:40:42.552Z","dependency_job_id":null,"html_url":"https://github.com/runnerty/executor-amqp","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runnerty%2Fexecutor-amqp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runnerty%2Fexecutor-amqp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runnerty%2Fexecutor-amqp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runnerty%2Fexecutor-amqp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/runnerty","download_url":"https://codeload.github.com/runnerty/executor-amqp/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244166707,"owners_count":20409178,"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","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":"2024-11-24T21:11:54.086Z","updated_at":"2025-03-18T16:04:40.747Z","avatar_url":"https://github.com/runnerty.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"http://runnerty.io\"\u003e\n    \u003cimg height=\"257\" src=\"https://runnerty.io/assets/header/logo-stroked.png\"\u003e\n  \u003c/a\u003e\n  \u003cp align=\"center\"\u003eSmart Processes Management\u003c/p\u003e\n\u003c/p\u003e\n\n[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Dependency Status][david-badge]][david-badge-url]\n\u003ca href=\"#badge\"\u003e\n\u003cimg alt=\"code style: prettier\" src=\"https://img.shields.io/badge/code_style-prettier-ff69b4.svg\"\u003e\n\u003c/a\u003e\n\n# Executor for [Runnerty]: AMQP\n\nModule AMQP (Advanced Message Queuing Protocol) 0-9-1 Publisher.\nThis is a wrapper from the [amqplib](https://github.com/squaremo/amqp.node)\n\n### Installation:\n\n```bash\nnpm i @runnerty/executor-amqp\n```\n\n### Configuration:\n\nAdd in [config.json]:\n\n##### Simple:\n\n```json\n{\n  \"id\": \"amqp_default\",\n  \"type\": \"@runnerty-executor-amqp\",\n  \"hostname\": \"localhost\"\n}\n```\n\n##### All parameters:\n\n```json\n{\n  \"id\": \"amqp_default\",\n  \"type\": \"@runnerty-executor-amqp\",\n  \"protocol\": \"amqp\",\n  \"hostname\": \"localhost\",\n  \"port\": 5672,\n  \"username\": \"guest\",\n  \"password\": \"guest\",\n  \"locale\": \"en_US\",\n  \"frameMax\": 1000,\n  \"heartbeat\": 0,\n  \"vhost\": \"/\",\n  \"options\": {\n    \"expiration\": 10000,\n    \"userId\": \"myUserId\",\n    \"CC\": \"myCC\",\n    \"BCC\": [\"bcc1,bcc2\"],\n    \"mandatory\": false,\n    \"persistent\": true,\n    \"deliveryMode\": true,\n    \"contentType\": \"myContentType\",\n    \"contentEncoding\": \"myContentEncoding\",\n    \"headers\": { \"header\": \"value\" },\n    \"priority\": 9,\n    \"correlationId\": \"myCorrelationId\",\n    \"replyTo\": \"myReplyTo\",\n    \"messageId\": \"myMessageId\",\n    \"timestamp\": 999999999,\n    \"type\": \"myType\",\n    \"appId\": \"myAppId\"\n  }\n}\n```\n\n### Plan sample:\n\nAdd in [plan.json]:\n\n##### Exange:\n\n```json\n{\n  \"id\": \"amqp_default\",\n  \"exange\": \"MY_EXANGE\",\n  \"exangeType\": \"direct\",\n  \"routingKey\": \"runnerty.test.#\",\n  \"message\": \"My message from Runnerty!\",\n  \"options\": {\n    \"persistent\": true\n  }\n}\n```\n\n##### Or direct to Queue:\n\n```json\n{\n  \"id\": \"amqp_default\",\n  \"queue\": \"MY_QUEUE\",\n  \"message\": \"My message from Runnerty!\",\n  \"options\": {\n    \"priority\": 10\n  }\n}\n```\n\n### Connection parameters\n\n| Option    | Type   | Description                                                           |\n| :-------- | :----- | :-------------------------------------------------------------------- |\n| protocol  | string | The to be used protocol: \"amqp\" or \"amqps\". Default value: 'amqp'.    |\n| hostname  | string | Hostname. Default value: 'localhost'                                  |\n| port      | string | Port. Default value: 5672                                             |\n| username  | string | Username. Default value: 'guest'                                      |\n| password  | string | Password. Default value: 'guest'                                      |\n| locale    | string | Password. Default value: 'en_US'                                      |\n| frameMax  | number | The size in bytes of the maximum frame allowed. Default value: 0x1000 |\n| heartbeat | number | The period of the connection heartbeat in seconds. Default value: 0   |\n| vhost     | string | What VHost shall be used. Default value: '/'                          |\n\n### Message options\n\n##### Can be set in `config` as default or in the process. The value indicated in the process overwrites the one indicated in `config`.\n\n| Option          | Type               |\n| :-------------- | :----------------- |\n| expiration      | string/number      |\n| userId          | string             |\n| CC              | string/string[]    |\n| BCC             | string/string[]    |\n| mandatory       | boolean            |\n| persistent      | boolean            |\n| deliveryMode    | boolean/number     |\n| contentType     | string             |\n| contentEncoding | string             |\n| headers         | object (key:value) |\n| priority        | number             |\n| correlationId   | string             |\n| replyTo         | string             |\n| messageId       | string             |\n| timestamp       | number             |\n| type            | string             |\n| appId           | string             |\n\nMore information in amqp-lib [api reference](http://squaremo.github.com/amqp.node/channel_api.html)\n\n### Output (Process values):\n\n- `PROCESS_EXEC_MSG_OUTPUT`: Log operations message.\n- `PROCESS_EXEC_ERR_OUTPUT`: Error output message.\n\n[runnerty]: http://www.runnerty.io\n[downloads-image]: https://img.shields.io/npm/dm/@runnerty/executor-amqp.svg\n[npm-url]: https://www.npmjs.com/package/@runnerty/executor-amqp\n[npm-image]: https://img.shields.io/npm/v/@runnerty/executor-amqp.svg\n[david-badge]: https://david-dm.org/runnerty/executor-amqp.svg\n[david-badge-url]: https://david-dm.org/runnerty/executor-amqp\n[config.json]: http://docs.runnerty.io/config/\n[plan.json]: http://docs.runnerty.io/plan/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frunnerty%2Fexecutor-amqp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frunnerty%2Fexecutor-amqp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frunnerty%2Fexecutor-amqp/lists"}