ballercat/walt

Type declarations for walt-loader.

Open

#129 geöffnet am 25. Juli 2018

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (4.637 Stars) (155 Forks)batch import
good first issuehelp wanted

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
TypeScript module declarations
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80
Research-Richtung
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.