{"id":13781498,"url":"https://github.com/reg2005/adonis5-redis-rpc","last_synced_at":"2025-12-30T08:05:28.363Z","repository":{"id":57173639,"uuid":"377490917","full_name":"reg2005/adonis5-redis-rpc","owner":"reg2005","description":"Simple RPC Provider for Adonis 5, based on Redis pub/sub transport","archived":false,"fork":false,"pushed_at":"2024-02-15T06:42:54.000Z","size":129,"stargazers_count":6,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-04T16:02:09.557Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/reg2005.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","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":"2021-06-16T12:36:27.000Z","updated_at":"2022-10-24T20:24:39.000Z","dependencies_parsed_at":"2024-08-03T18:12:34.738Z","dependency_job_id":"50a76a4c-3507-4835-ae95-0149944dcdd7","html_url":"https://github.com/reg2005/adonis5-redis-rpc","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reg2005%2Fadonis5-redis-rpc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reg2005%2Fadonis5-redis-rpc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reg2005%2Fadonis5-redis-rpc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reg2005%2Fadonis5-redis-rpc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reg2005","download_url":"https://codeload.github.com/reg2005/adonis5-redis-rpc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253580399,"owners_count":21930937,"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-08-03T18:01:26.523Z","updated_at":"2025-12-30T08:05:28.326Z","avatar_url":"https://github.com/reg2005.png","language":"TypeScript","funding_links":[],"categories":["Packages"],"sub_categories":[],"readme":"# adonis5-redis-rpc\n\u003e Adonis, Adonis 5, Redis RPC\n\n[![npm-image]][npm-url] [![license-image]][license-url] [![typescript-image]][typescript-url]\n\nSimple RPC Provider for Adonis 5, based on Redis pub/sub transport\n\n## Installation\nSetup redis from [this manual](https://docs.adonisjs.com/guides/redis)\n\nand\n\n```bash\nnpm i adonis5-redis-rpc\nnode ace invoke adonis5-redis-rpc\n```\n\n\n## Usage\n\n### Server mode\nYou can create adonis command (node ace make:command RPCServer) like this:\n```ts\nimport { BaseCommand } from '@adonisjs/core/build/standalone'\nimport RedisRPC from '@ioc:Adonis/Addons/RedisRPC'\n\nexport default class VangaPlaincalc extends BaseCommand {\n  /**\n   * Command name is used to run the command\n   */\n  public static commandName = 'vanga:plaincalc'\n\n  /**\n   * Command description is displayed in the \"help\" output\n   */\n  public static description = ''\n\n  public static settings = {\n    /**\n     * Set the following value to true, if you want to load the application\n     * before running the command\n     */\n    loadApp: true,\n\n    /**\n     * Set the following value to true, if you want this command to keep running until\n     * you manually decide to exit the process\n     */\n    stayAlive: false,\n  }\n\n  public async run() {\n    this.logger.info('Hello world!')\n    await RedisRPC.server()\n    RedisRPC.addHandler\u003c{}\u003e('exampleMethod', async (payload) =\u003e {\n      console.log(payload)\n      return {success: true}\n    })\n  }\n}\n```\n\n### Client mode\n```ts\nimport Route from '@ioc:Adonis/Core/Route'\nimport RedisRPC from '@ioc:Adonis/Addons/RedisRPC'\nRoute.get('example', () =\u003e {\n  await RedisRPC.client()\n  const result =  await RedisRPC.call('exampleMethod', {data: 'message'})\n  return result\n})\n```\n\n[npm-image]: https://img.shields.io/npm/v/adonis5-redis-rpc.svg?style=for-the-badge\u0026logo=npm\n[npm-url]: https://npmjs.org/package/adonis5-redis-rpc \"npm\"\n\n[license-image]: https://img.shields.io/npm/l/adonis5-redis-rpc?color=blueviolet\u0026style=for-the-badge\n[license-url]: LICENSE.md \"license\"\n\n[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge\u0026logo=typescript\n[typescript-url]:  \"typescript\"\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freg2005%2Fadonis5-redis-rpc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freg2005%2Fadonis5-redis-rpc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freg2005%2Fadonis5-redis-rpc/lists"}