eligrey/FileSaver.js

include TS types in the repo

Open

#540 opened on Apr 5, 2019

View on GitHub
 (5 comments) (0 reactions) (0 assignees)JavaScript (21,193 stars) (4,366 forks)batch import
enhancementhelp wanted

Description

I know types are available in @types, but it would be nicer if they were part of this package. TS has grown so much that most popular packages include types in their repo.

Contributor guide

Tech stack
typescript
Domain
frontend
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-3 hours
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 FileSaver.js API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
This issue requests adding TypeScript type definitions directly to the FileSaver.js repository instead of relying on the separate @types/filesaver package. To implement, one would need to create a declaration file (e.g., index.d.ts) with type annotations for the exported functions like saveAs. Check the existing source code at the repository root and the type definitions from DefinitelyTyped (https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/filesaver) for reference. Discuss in the issue about maintaining types alongside the JavaScript source.