Microsoft/TypeScript

AudioWorkletProcessor type definition is missing

Open

#28,308 opened on Nov 2, 2018

View on GitHub
 (22 comments) (51 reactions) (0 assignees)TypeScript (48,455 stars) (6,726 forks)batch import
BugDomain: lib.d.tsHelp Wanted

Description

TypeScript Version: 3.2.0-dev.201xxxxx

Search Terms: AudioWorkletProcessor

You guys have type definitions for AudioWorkletNode and such but missed the definition for AudioWorkletProcessor as per: https://webaudio.github.io/web-audio-api/#audioworkletprocessor

This is what I have for now:

interface AudioWorkletProcessor {
    readonly port: MessagePort;
    process(inputs: Float32Array[][], outputs: Float32Array[][], parameters: Map<string, Float32Array>): void;
}

declare var AudioWorkletProcessor: {
    prototype: AudioWorkletProcessor;
    new(options?: AudioWorkletNodeOptions): AudioWorkletProcessor;
}

Cheers

Contributor guide

Tech stack
typescript
Domain
developer 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-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 type system basicsWeb Audio API knowledgeUnderstanding of lib.d.ts structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Examine the existing Web Audio API type definitions in TypeScript's lib.dom.d.ts or related files. The issue provides a concrete template for AudioWorkletProcessor. Review comments for any necessary adjustments, such as compatibility with the spec at https://webaudio.github.io/web audio api/#audioworkletprocessor. Implement the interface and constructor type as suggested, ensuring it integrates with existing AudioWorkletNode defintions.