{"id":19281751,"url":"https://github.com/scality/sproxydclient","last_synced_at":"2025-04-22T01:31:05.830Z","repository":{"id":9070757,"uuid":"46151455","full_name":"scality/sproxydclient","owner":"scality","description":"Node.js client library for the Proprietary Scality sproxyd software","archived":false,"fork":false,"pushed_at":"2025-02-21T16:12:01.000Z","size":406,"stargazers_count":2,"open_issues_count":7,"forks_count":2,"subscribers_count":56,"default_branch":"development/8.1","last_synced_at":"2025-04-01T17:53:34.899Z","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":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/scality.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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":"2015-11-13T22:50:13.000Z","updated_at":"2025-02-21T16:12:03.000Z","dependencies_parsed_at":"2024-05-10T14:44:08.010Z","dependency_job_id":"73c4d3f3-f323-4478-a125-0b92e7a4a616","html_url":"https://github.com/scality/sproxydclient","commit_stats":null,"previous_names":[],"tags_count":454,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scality%2Fsproxydclient","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scality%2Fsproxydclient/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scality%2Fsproxydclient/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scality%2Fsproxydclient/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scality","download_url":"https://codeload.github.com/scality/sproxydclient/tar.gz/refs/heads/development/8.1","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250161970,"owners_count":21385014,"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-09T21:24:02.493Z","updated_at":"2025-04-22T01:31:05.586Z","avatar_url":"https://github.com/scality.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# nodeJS sproxyd client API\n\n[![CircleCI][badgepub]](https://circleci.com/gh/scality/sproxydclient)\n[![Scality CI][badgepriv]](http://ci.ironmann.io/gh/scality/sproxydclient)\n\n## Contributing\n\nIn order to contribute, please follow the\n[Contributing Guidelines](\nhttps://github.com/scality/Guidelines/blob/master/CONTRIBUTING.md).\n\n## Usage\n\n### Installation\n\n```shell\nnpm install --save scality/sproxydclient\n```\n\n### API\n\nThe client API consists of a class handling basic operations on its side,\nusing a callback to return whatever value is needed.\n\n#### Initialisation\n\nopts is an optional parameter, that will evolve to an array of connectors.\n\n```es6\nvar SproxydClient = require('sproxydclient');\n\nvar opts = {\n    hostname: 'example.com',\n    port: '81',\n    path: '/proxy/arc/',\n};\n\nvar client = new SproxydClient(opts);\n```\n\n#### PUT\n\n```es6\nassert(stream instanceof stream.Readable);\nClient.put(stream: stream.Readable, size: number, (err: Error, key: string) =\u003e {});\n```\n\n#### GET\n\n```es6\nClient.get(key: string, (err: Error, stream: http.IncomingMessage) =\u003e {});\n```\n\n#### DELETE\n\n```es6\nClient.delete(key: string, (err: Error) =\u003e {});\n```\n\n## TODO\n\nThe API is still in its infancy stages. We need to:\n- Detect said failures before sending our requests (Phi accrual detector)\n\n[badgepub]: https://circleci.com/gh/scality/sproxydclient.svg?style=svg\n[badgepriv]: http://ci.ironmann.io/gh/scality/sproxydclient.svg?style=shield\u0026circle-token=06bf5c091353d80a1296682f78ea08aeb986ce83\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscality%2Fsproxydclient","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscality%2Fsproxydclient","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscality%2Fsproxydclient/lists"}