{"id":16489055,"url":"https://github.com/thundernet8/node-socket-pool","last_synced_at":"2025-05-02T16:32:02.542Z","repository":{"id":79658537,"uuid":"110850363","full_name":"thundernet8/Node-Socket-Pool","owner":"thundernet8","description":"Socket connection pool for Node","archived":false,"fork":false,"pushed_at":"2017-11-22T02:42:13.000Z","size":35,"stargazers_count":2,"open_issues_count":1,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-22T05:19:10.866Z","etag":null,"topics":["nodejs","pool","socket"],"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/thundernet8.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-11-15T15:22:46.000Z","updated_at":"2023-03-23T03:54:41.000Z","dependencies_parsed_at":"2023-06-01T08:01:29.027Z","dependency_job_id":null,"html_url":"https://github.com/thundernet8/Node-Socket-Pool","commit_stats":{"total_commits":17,"total_committers":3,"mean_commits":5.666666666666667,"dds":0.4117647058823529,"last_synced_commit":"08d8484ef715209c7f63791ef461170c449423c9"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thundernet8%2FNode-Socket-Pool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thundernet8%2FNode-Socket-Pool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thundernet8%2FNode-Socket-Pool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thundernet8%2FNode-Socket-Pool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thundernet8","download_url":"https://codeload.github.com/thundernet8/Node-Socket-Pool/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252071933,"owners_count":21690121,"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":["nodejs","pool","socket"],"created_at":"2024-10-11T13:42:43.873Z","updated_at":"2025-05-02T16:32:02.526Z","avatar_url":"https://github.com/thundernet8.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Node-Socket-Pool [![Build Status](https://travis-ci.org/thundernet8/Node-Socket-Pool.svg?branch=master)](https://travis-ci.org/thundernet8/Node-Socket-Pool)\n\nSocket connection pool for Node\n\n## Install\n\n```\nnpm install node-socket-pool\n```\n\nor\n\n```\nyarn add node-socket-pool\n```\n\n## Usage\n\n### Get a client\n\n```typescript\nimport SocketPool from \"node-socket-pool\";\n\nconst pool = new SocketPool({\n    host: \"127.0.0.1\",\n    port: 3000,\n    maxActive: 5,\n    maxIdle: 2,\n    maxIdleTime: 30000,\n    maxWait: 10000\n});\n\n// in async function\nconst socketClient = await pool.getResource();\n\n// or promise\npool\n    .getResource()\n    .then(client =\u003e {})\n    .catch(err =\u003e {\n        // handle err\n    });\n```\n\n### Options\n\n```typescript\nhost: string;\nport: number;\n// 最多维持连接数\nmaxActive?: number;\n// 最多保留空闲连接数\nmaxIdle?: number;\n// Socket连接最长空闲时间(毫秒)(超过时间后将返回资源池)\nmaxIdleTime?: number;\n// pool中没有资源返回时，最大等待时间(毫秒)\nmaxWait?: number;\n```\n\n### Release\n\n```typescript\nclient.release();\n```\n\nor\n\n```typescript\npool.returnResource(client);\n```\n\nclient will auto return to idle resource pool if no data transportation for a\ntime up to maxIdleTime option\n\n### License\n\nNode-socket-pool is freely distributable under the terms of the\n[MIT license](https://github.com/thundernet8/Node-Socket-Pool/blob/master/LICENSE).\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fthundernet8%2FNode-Socket-Pool.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fthundernet8%2FNode-Socket-Pool?ref=badge_large)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthundernet8%2Fnode-socket-pool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthundernet8%2Fnode-socket-pool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthundernet8%2Fnode-socket-pool/lists"}