{"id":18561724,"url":"https://github.com/devartsite/getport","last_synced_at":"2025-11-01T12:30:37.034Z","repository":{"id":62421779,"uuid":"303405564","full_name":"DevArtSite/getport","owner":"DevArtSite","description":"Get an available TCP port on Deno","archived":false,"fork":false,"pushed_at":"2021-05-26T22:54:24.000Z","size":16,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-26T13:37:20.843Z","etag":null,"topics":["deno","getport","hostname","preferred-ports","tcp-port"],"latest_commit_sha":null,"homepage":"","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/DevArtSite.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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-10-12T13:45:34.000Z","updated_at":"2022-10-23T16:44:07.000Z","dependencies_parsed_at":"2022-11-01T17:31:47.659Z","dependency_job_id":null,"html_url":"https://github.com/DevArtSite/getport","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevArtSite%2Fgetport","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevArtSite%2Fgetport/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevArtSite%2Fgetport/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevArtSite%2Fgetport/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DevArtSite","download_url":"https://codeload.github.com/DevArtSite/getport/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239288300,"owners_count":19614091,"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":["deno","getport","hostname","preferred-ports","tcp-port"],"created_at":"2024-11-06T22:07:43.892Z","updated_at":"2025-11-01T12:30:36.976Z","avatar_url":"https://github.com/DevArtSite.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DEPRECATED use [@std/net] (https://jsr.io/@std/net) \n# getport [![deno doc](https://doc.deno.land/badge.svg)](https://doc.deno.land/https/deno.land/x/getport/mod.ts)\n\n\u003e Get an available [TCP port](https://en.wikipedia.org/wiki/Port_(computer_networking))\n\n## Usage\n\n```ts\nimport { getPort, randomPort, makeRange } from \"https://deno.land/x/getport/mod.ts\";\n```\n\n```shell\ndeno run --allow-net script.ts\n```\n\n## Example\n\n- Without params\n\n    ```ts\n    import { getPort } from \"https://deno.land/x/getport/mod.ts\";\n    const port = getPort();\n    console.log(port); //=\u003e Return first port available between 1024 and 65535\n    ```\n\n- Pass in a preferred port:\n\n    ```ts\n    import { getPort } from \"https://deno.land/x/getport/mod.ts\";\n    const port = await getPort(3000);\n    console.log(port); //=\u003e Will use 3000 if available, otherwise returns the port plus one\n    ```\n\n- Pass in an array of preferred ports:\n\n    ```ts\n    import { getPort } from \"https://deno.land/x/getport/mod.ts\";\n    const port = await getPort({ port: [3000, 3001, 3002] });\n    console.log(port); //=\u003e Will use once element in the preferred ports array if available, otherwise returns the last port in array plus one\n    ```\n\n- Use the `makeRange()` helper in case you need a port in a certain range:\n\n    ```ts\n    import { getPort, randomPort, makeRange } from \"https://deno.land/x/getport/mod.ts\";\n    const range = makeRange(3000, 3100);\n    console.log(range); //=\u003e Return [3000, 3002, ..., 3099, 3100]\n    const port = await getPort(range);\n    console.log(port); //=\u003e Will use first available port between 3000 and 3100\n    ```\n\n## API\n\n- ### getPort\n\n  - @param port [Port](###Port)\n  - @param hostname [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)\n  - @return [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)\n\n    ```ts\n    /**\n     * Return available port.\n     * @param {number | number[]} port\n     * @param {string?} hostname\n     * @return {number}\n     */\n    const port = getPort();\n    ```\n\n- ### makeRange\n\n  - @param from [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)\n  - @param to [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)\n  - @return [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)\n\n    ```ts\n    /**\n     * Create an array of number by min and max.\n     * @param {number} from Must be between 1024 and 65535\n     * @param {number} to Must be between 1024 and 65535 and greater than from\n     * @return {number[]}\n     */\n    const port = makeRange();\n    ```\n\n- ### randomPort\n\n  - @param hostname [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)\n  - @return [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)\n\n    ```ts\n    /**\n     * Return a random port between 1024 and 65535.\n     * @param {string?} hostname\n     * @return {number}\n     */\n    const port = randomPort();\n    ```\n\n## Change Logs\n\nSee [CHANGELOG.md](CHANGELOG.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevartsite%2Fgetport","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevartsite%2Fgetport","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevartsite%2Fgetport/lists"}