{"id":15314338,"url":"https://github.com/barelyhuman/typeapi","last_synced_at":"2025-04-15T02:12:55.754Z","repository":{"id":101913717,"uuid":"583662928","full_name":"barelyhuman/typeapi","owner":"barelyhuman","description":null,"archived":false,"fork":false,"pushed_at":"2024-04-23T18:03:48.000Z","size":476,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-15T02:12:50.659Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://typeapi.barelyhuman.dev","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/barelyhuman.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}},"created_at":"2022-12-30T13:46:29.000Z","updated_at":"2024-07-08T06:26:46.000Z","dependencies_parsed_at":"2024-04-12T21:29:58.091Z","dependency_job_id":"09f5f46f-0ade-40ed-81b3-5670f1d928c4","html_url":"https://github.com/barelyhuman/typeapi","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barelyhuman%2Ftypeapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barelyhuman%2Ftypeapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barelyhuman%2Ftypeapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barelyhuman%2Ftypeapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/barelyhuman","download_url":"https://codeload.github.com/barelyhuman/typeapi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248991558,"owners_count":21194894,"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-10-01T08:45:08.318Z","updated_at":"2025-04-15T02:12:55.728Z","avatar_url":"https://github.com/barelyhuman.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# typeapi\n\n\u003e A simple web based typescript type definitions parser\n\n- [typeapi](#typeapi)\n  - [Usecase](#usecase)\n  - [Usage](#usage)\n  - [Self Hosting](#self-hosting)\n  - [Roadmap](#roadmap)\n\n## Usecase\n\nNeed a simple way to find out what types are exposed by a library, kinda like an\nAPI doc.\n\n## Usage\n\nJust visit `https://typeapi.barelyhuman.dev/pkg/\u003cnpm-package-name\u003e` to see the\ntypes of a package.\n\neg:\n\n```\nhttps://typeapi.barelyhuman.dev/pkg/@barelyhuman/tocolor@next\n```\n\n## Self Hosting\n\n- typeAPI is available as a runnable docker image that can be run in the\n  following manner\n\n```sh\ndocker pull ghcr.io/barelyhuman/typeapi:\u003cversion\u003e # replace \u003cversion\u003e with the latest tag from the releases section\ndocker run -d -p=\"4321:4321\" ghcr.io/barelyhuman/typeapi:\u003cversion\u003e # unpersisted version\n\n# persisted version, give save the data in the current folder (if you'd like to replicate the db for backup)\ndocker run -d -v ${PWD}:/data -e \"DB_PATH=/data/data.db\" -p=\"4321:4321\" ghcr.io/barelyhuman/typeapi:\u003cversion\u003e\n```\n\n## Roadmap\n\n- [x] basic one level type definition parser for interfaces, types, and\n      functions\n- [x] handle `package.exports` fields\n      [#3](https://github.com/barelyhuman/typeapi/pull/3)\n- [x] astro rewrite\n- [ ] cache version type definition instead\n- [ ] use a virtual in memory fs to read all `.d.ts` files from the package\n- [ ] generate types for packages without any declarations\n- [ ] auto redirect to `@types/\u003cpkg\u003e` for known packages\n- [x] a friendlier UI\n  - [x] Keyboard Accessible (has some points missing)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbarelyhuman%2Ftypeapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbarelyhuman%2Ftypeapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbarelyhuman%2Ftypeapi/lists"}