ballercat/walt

Type declarations for walt-loader.

Open

#129 opened on Jul 25, 2018

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (4,637 stars) (155 forks)batch import
good first issuehelp wanted

Description

Feature Request

Today I found that walt-loader doesn't work seamlessly in a webpack environment using typescript because its missing type declarations.

This is the type file I've used:

type WaltInstantiate = (deps?: any) => Promise<WebAssembly.ResultObject>

declare module "*.walt" {
    const value: WaltInstantiate
    export default value;
}

where WebAssembly.ResultObject is defined in @types/emscripten.

Contributor guide

Tech stack
typescriptwasm
Domain
developer experiencebuild system
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.
under 1 hour
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
TypeScript module declarations
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The issue requests adding TypeScript type declarations for walt loader. The user provided an example .d.ts file. The first step is to examine the walt loader source code to understand its exported API (likely a function that returns a WebAssembly module). Then create a .d.ts file that exposes the correct types, possibly in the root or alongside the loader. There are no linked PRs or recent comments, so the work is simply to add the declaration file and submit as a PR.