josdejong/mathjs

TypeScript: inconsistent factory signature (unable to declare custom dependencies)

Open

#2,324 opened on Sep 21, 2021

View on GitHub
 (1 comment) (1 reaction) (0 assignees)JavaScript (1,298 forks)batch import
bughelp wantedtypescript

Repository metrics

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

Description

I'm customizing mathjs extending its types and methods. In JS I can register a type :

  factory('DateTime', ['typed'], function createDateTime({ typed }: { typed?: any }) {
    typed.addType({
      name: 'DateTime',
      test: (x: any) => x && x.constructor.name === 'DateTime'
    })
    return DateTime
  }),

and then use it as a dependency:

factory('datetime', ['typed', 'DateTime'], function createDateTime({ typed, DateTime }) {}

but in TypeScript it's not possible - I'm getting: Type '"DateTime"' is not assignable to type 'keyof MathJsStatic'.

PS> And BTW creating math object is also quite confusing in TypeScript:

import { create, all, factory } from 'mathjs';
const mathjs = create(all);
mathjs!.import!([ ... ]);

Contributor guide

Research direction
Inspect the TypeScript type declaration for the 'factory' function and the MathJsStatic interface to understand why custom dependency names like 'DateTime' are not assignable. Look for index signature constraints.
Tech stack
typescriptjavascript
Domain
developer experiencetooling
Issue type
Bug
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.
Half day
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
TypeScriptGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55