Skip to content
Search TypeScript functions and methods by types
TypeScript Haskell Go Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets
example
packages
.gitignore
.prettierignore
.prettierrc
LICENSE
go.mod
lerna.json
package.json
readme.md
yarn.lock

readme.md

tsearch

Search engine for TypeScript functions, methods and types.

devlog

Architecture

tsearch consists of 3 differt applications, found in the packages/ directory:

  • The cli for extracting function types from TypeScript projects.
  • The server that performs searching on the types extracted by the cli.
  • The client UI to search for types.

Development

tsearch is still under development, for now to run it you need to clone the repo:

git clone https://github.com/gillchristian/ts-earch.git # https
git clone git@github.com:gillchristian/ts-earch.git     # ssh

Install all dependencies (lerna takes care of installing the dependencies of the packages):

$ yarn

Extract function types to search with the client. This step is required otherwise there will be no types to search:

$ yarn extract '/absolute/path/to/typescript/project/**/*.{ts,tsx}'

Running

To use tsearch we have to build first and the run the app. After that you can open it in localhost:3000:

$ yarn build
$ yarn start

Development

For development we run the watcher and the dev server in a different terminal process/tab:

$ yarn watch
$ yarn dev

The server runs in localhost:8080 and the client in localhost:3000.

Inspiration

tsearch is inspired on Haskell API search engine Hoogle.

LICENSE

MIT License © Christian Gill

You can’t perform that action at this time.