{"id":20597211,"url":"https://github.com/cathive/razer-chroma-js","last_synced_at":"2026-05-08T03:12:08.288Z","repository":{"id":59506782,"uuid":"537148216","full_name":"cathive/razer-chroma-js","owner":"cathive","description":"JavaScript / TypeScript bindings for the Razer Chroma REST API","archived":false,"fork":false,"pushed_at":"2023-04-13T09:49:20.000Z","size":284,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-02-16T23:03:15.067Z","etag":null,"topics":["javascript","nodejs","razer-chroma","razer-peripherals"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/razer-chroma-sdk","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cathive.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.md","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-09-15T18:00:42.000Z","updated_at":"2022-09-20T09:25:46.000Z","dependencies_parsed_at":"2024-11-16T08:21:31.938Z","dependency_job_id":"eb397512-6ff6-4a3c-93de-ef47e8d78bd2","html_url":"https://github.com/cathive/razer-chroma-js","commit_stats":{"total_commits":8,"total_committers":1,"mean_commits":8.0,"dds":0.0,"last_synced_commit":"bc89ed52ae444d6042529188a93b1ade7baa771a"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cathive%2Frazer-chroma-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cathive%2Frazer-chroma-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cathive%2Frazer-chroma-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cathive%2Frazer-chroma-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cathive","download_url":"https://codeload.github.com/cathive/razer-chroma-js/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242231441,"owners_count":20093636,"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":["javascript","nodejs","razer-chroma","razer-peripherals"],"created_at":"2024-11-16T08:21:06.655Z","updated_at":"2026-05-08T03:12:03.251Z","avatar_url":"https://github.com/cathive.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Access Razer Chroma RESTful API from Node.js / browsers\n\nThis library can be used to interact with the RESTful API of the [Razer Chroma SDK](https://assets.razerzone.com/dev_portal/REST/html/index.html).\n\n## Usage\n\nYou can use this library from Node.js or your browser.\n\nInternally, the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) will\nbe used to direct web requests towards the Chroma SDK RESTful endpoint on a local machine.\n\n### Full example\n\nThe following TypeScript example shows how to obtain an instance of the `RazerChromaSDK` client\n(the component that speaks to the RESTful endpoint on localhost) and how to use the instance to\nperform some basic operations:\n\n```typescript\nimport { RazerChromaSDK, Category, Device, Effect, Color } from \"razer-chroma-sdk\";\n\n(async () =\u003e {\n\n    const sdk = await RazerChromaSDK.initialize({\n        title: \"My kewl game\",\n        description: \"My game is really kewl. You should try it.\",\n        author: {\n            name: \"ACME Inc.\",\n            contact: \"http://example.com/\"\n        },\n        device_supported: [ Device.MOUSE, Device.KEYBOARD ],\n        category: Category.GAME\n    });\n\n    const mouseBlueFx = await sdk.effects.create(Device.MOUSE, {\n        effect: Effect.STATIC,\n        param: { color: Color.BLUE }\n    });\n    await sdk.effects.set(mouseBlueFx);\n\n    // Don't forget to un-initialize the SDK after using it, to free up resources.\n    await sdk.uninitialize();\n\n})();\n```\n\n### Important note about un-initialization\n\nAs a user of this library you are always responsible for calling the `async uninitialize()` method\non all SDK instances created by your code to free up resources.\n\n## Further documentation\n\nSince this API is basically only a very thin wrapper around the RESTful API of the Razer Chroma SDK,\nyou might want to check the [Razer Chroma SDK REST Documentation](https://assets.razerzone.com/dev_portal/REST/html/index.html) for further details about how to create different more elaborated\neffects.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcathive%2Frazer-chroma-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcathive%2Frazer-chroma-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcathive%2Frazer-chroma-js/lists"}