getify/asynquence

A Typescript definitions file would be great

Open

#45 opened on Jun 22, 2014

View on GitHub
 (3 comments) (1 reaction) (0 assignees)JavaScript (156 forks)batch import
help wanted

Repository metrics

Stars
 (1,739 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

I'll be using asynquence in Typescript in addition to Javascript.

A definition file is a header file. A file like this (asynquence.d.ts) would tell Typescript what the asynquence API looks like, so that it can auto-complete, give compiler errors if you pass the wrong type, leave off a parameter, etc. It will obviously take some familiarity with Typescript to write one. There are definition files for most popular frameworks/libraries: DefinitelyTyped project.

I will start playing with generating one, and will post back here if I have much luck.

Contributor guide

Research direction
Study the asynquence API and create a TypeScript definition file (.d.ts) that declares all public types, functions, and interfaces.
Tech stack
javascripttypescript
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75