Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 1.51 KB

README.md

File metadata and controls

53 lines (34 loc) · 1.51 KB
Raw

resolve-ts-types

todo

intro

Take some typescript code that contains type x = <something> amd resolve what <something> is. For example, given this:

type T = typeof global.setTimeout;

When running this through resolve-ts-types, you'll get

type T = (
  callback: (...args: any[]) => void,
  ms: number,
  ...args: any[]
) => NodeJS.Timeout;

The resulting resolved type can be used in snapshot tests, to check that some code has the type you expect.

Local Development

This project was bootstrapped with TSDX.

Below is a list of commands you will probably find useful.

npm start or yarn start

Runs the project in development/watch mode. Your project will be rebuilt upon changes. TSDX has a special logger for you convenience. Error messages are pretty printed and formatted for compatibility VS Code's Problems tab.

Your library will be rebuilt if you make edits.

npm run build or yarn build

Bundles the package to the dist folder. The package is optimized and bundled with Rollup into multiple formats (CommonJS, UMD, and ES Module).

npm test or yarn test

Runs the test watcher (Jest) in an interactive mode. By default, runs tests related to files changed since the last commit.