sindresorhus/electron-timber

Please add TypeScript definitions

Open

#24 opened on Jun 16, 2021

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (422 stars) (9 forks)user submission
enhancementhelp wanted

Description

I think a lot of people, maybe even most people, are going to start new Electron projects in 2021 using TypeScript.

Please add a d.ts file to this repository that contains the definitions for the API, so that TypeScript can work with this library.

Contributor guide

Tech stack
javascripttypescript
Domain
desktopdeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic TypeScript knowledgefamiliarity with electron timber API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
The issue requests adding TypeScript definitions (index.d.ts) for the electron timber library. Start by reading the existing JavaScript source files to understand the exported API. Look at similar libraries for example type definitions. Consider generating initial types from the source and then refining them. No linked PRs or assignees, so this is open to contributions.