https://github.com/barelyhuman/typeapi
https://github.com/barelyhuman/typeapi
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/barelyhuman/typeapi
- Owner: barelyhuman
- License: mit
- Created: 2022-12-30T13:46:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-23T18:03:48.000Z (about 1 year ago)
- Last Synced: 2025-04-15T02:12:50.659Z (2 months ago)
- Language: JavaScript
- Homepage: https://typeapi.barelyhuman.dev
- Size: 465 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: license
Awesome Lists containing this project
README
# typeapi
> A simple web based typescript type definitions parser
- [typeapi](#typeapi)
- [Usecase](#usecase)
- [Usage](#usage)
- [Self Hosting](#self-hosting)
- [Roadmap](#roadmap)
## Usecase
Need a simple way to find out what types are exposed by a library, kinda like an
API doc.
## Usage
Just visit `https://typeapi.barelyhuman.dev/pkg/` to see the
types of a package.
eg:
```
https://typeapi.barelyhuman.dev/pkg/@barelyhuman/tocolor@next
```
## Self Hosting
- typeAPI is available as a runnable docker image that can be run in the
following manner
```sh
docker pull ghcr.io/barelyhuman/typeapi: # replace with the latest tag from the releases section
docker run -d -p="4321:4321" ghcr.io/barelyhuman/typeapi: # unpersisted version
# persisted version, give save the data in the current folder (if you'd like to replicate the db for backup)
docker run -d -v ${PWD}:/data -e "DB_PATH=/data/data.db" -p="4321:4321" ghcr.io/barelyhuman/typeapi:
```
## Roadmap
- [x] basic one level type definition parser for interfaces, types, and
functions
- [x] handle `package.exports` fields
[#3](https://github.com/barelyhuman/typeapi/pull/3)
- [x] astro rewrite
- [ ] cache version type definition instead
- [ ] use a virtual in memory fs to read all `.d.ts` files from the package
- [ ] generate types for packages without any declarations
- [ ] auto redirect to `@types/` for known packages
- [x] a friendlier UI
- [x] Keyboard Accessible (has some points missing)