npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

typedef-converter

v0.1.4

Published

Converts typescript definition files to flow library files

Downloads

3

Readme

Typescript to Flow converter

This projects exists because having to write duplicate library definitions is no fun at all.

The state of the converter

It's surprisingly robust and non-lossy as it stands right now, in big part thanks to how similar flow and typescript definition files are. I've ran it against the typescript definition for yargs and it converted it to a flow library definition that worked out of the box.

It almost works with multiple files - biggest issue right now is not inserting the proper module, instead favouring the root module which should never have properties.

The difficult parts

Namespaces

Namespaces have been a big headache. What it does right now is that it converts any namespace to a module
and then imports any references to that module. What's currently not working in terms of namespaces is exporting all properties of the namespace as a default object, but that should be a fairly trivial change.

Variables

Since TS and flow variables dont match in functionality, the converter has to resolve variable references manually. A common case looks like this:

var yargs: yargs.Argv;
	export = yargs;

Which then resolves to declare module.exports: Argv.

External library imports

Definitions in TS and flow are often quite different, and imported types from other libraries dont usually have a one-to-one mapping. As an example, libraries using React.Component<> are difficult to translate to flow. This might require manual processing, or we add a set of hardcoded mutations that handle common cases.

Odd TS conventions

Lodash has been one of the reference libraries i've worked with when creating the converter. The definition is mostly just a series of interfaces with the same name being re-declared over and over again for each function, which doesn't translate to flow at all. If anyone knows how to make sense of the lodash definition, send me a tweet.

Usage

Standard usage (will produce lodash.flow.js):

yarn global add typedef-converter
typedef-converter lodash.d.ts

Options

-o / --out: Specifies the filename of the exported file