Skip to content
This repository was archived by the owner on Feb 6, 2026. It is now read-only.

Do you want TypeScript types in this repo? #114

Description

@theneva

Hi! 👋

I'm planning to use Brakes in a TypeScript project, and noticed that there are no typings available in the repo or via DefinitelyTyped. Before spending a lot of time, I have two questions.

First: Would you be interested in migrating this repo to TypeScript?

I naïvely cloned and started typing the whole project, in the hopes that I would be able to annotate a few variables and get type definitions for free. A couple of hours later, I realised the error of my ways, and gave up. The almost-functional result is available at https://github.com/awolden/brakes/compare/master...theneva:typescript?expand=1

If no, I won't spend any more time on typing the whole thing. For now, I've resigned to manually writing a type definition file for the Brakes class.

Second question: Would you accept the module type definition file directly into this repo (similar to what is done in for example https://github.com/sindresorhus/copy-text-to-clipboard), or should I go via DefinitelyTyped to publish it?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions