josephg / josephg/Chipmunk-js

Typescript Type Definitions?

Open
#25 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
539
Forks
59
PR merge metrics
No merged PRs in 30d

Description

These would not only let Typescript users use chipmunk-js conveniently, it'd also let some other languages like F# and Scala (which I'm using) interop more conveniently. Given that chipmunk-js follows the C library pretty closely, it should be pretty straightforward (if tedious) to mark out the type signatures for the various functions and methods.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by surveying the chipmunk-js API and comparing its functions and methods with the C library, as requested in the issue. Define the TypeScript signatures across the API and verify that the resulting definitions support the stated TypeScript, F#, and Scala interoperability goal.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
developer-experience
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.