josdejong/mathjs

Insufficient typing for `add`, `subtract`, `dotMultiply` etc

Open

#2,349 opened on Nov 9, 2021

View on GitHub
 (0 comments) (3 reactions) (0 assignees)JavaScript (1,298 forks)batch import
help wantedtypescript

Repository metrics

Stars
 (13,832 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

The functions

lack sufficiently fine-grained type definitions. In particular, this produces an error:

math.add([1, 2], [3, 4])[0];
// Element implicitly has an 'any' type because expression
// of type '0' can't be used to index type 'MathType'.
// Property '0' does not exist on type 'MathType'

while it should be clear that the result is a one-dimensional array.

Adding some overloads would make the TypeScript experience with Mathjs much smoother.

Contributor guide

Research direction
Examine the existing type definitions in types/index.d.ts, identify the functions (add, subtract, dotMultiply, dotDivide, dotPow) that need more specific overloads to handle array inputs, and add overloads that return appropriate array types like number[] when both inputs are arrays.
Tech stack
javascripttypescript
Domain
backend
Issue type
Bug
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.
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
TypeScriptJavaScriptGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75