Web3.js: web3-eth-accounts TypeScript definition file is broken (and/or confusing)

Created on 30 Dec 2019 · 9Comments · Source: ChainSafe/web3.js

Expected behavior

TypeScript definition file should reflect that Accounts is the _default_ export, not a named export.

Actual behavior

TypeScript compiler raises an error when attempting to import Accounts as the default export, but we reach a runtime TypeError if we import Accounts as a named export.

Steps to reproduce the behavior

Try this code snippet in a TypeScript file:

import { Accounts } from 'web3-eth-accounts';

new Accounts() // TypeScript does not complain
// => TypeError: "Accounts is not a constructor"

For comparison:

import Accounts from 'web3-eth-accounts';

new Accounts() // TypeScript complains with: "This expression is not constructable."
// => works at runtime...

Versions

[email protected]

1.x Stale more information needed types

Source

smithki

👍1

Most helpful comment

Btw.: We can't change this that easy because it would break many already existing projects.

I see this as a _bug_, though. Considering the expected behavior does not currently work, I do not understand how it can be considered a breaking change. Thankfully, there is a workaround using declaration merging:

import { AccountsBase } from 'web3-core';
import Accounts from 'web3-eth-accounts';

declare module 'web3-eth-accounts' {
  export default class Accounts extends AccountsBase {}
}

smithki on 19 Feb 2020

👍2

All 9 comments

Thanks for opening this issue! Have you followed our TS guidance here which does require additional configuration?

~~Btw.: We can't change this that easy because it would break many already existing projects.~~

Edit: Sorry, it is possible to change it in a non-breaking manner we would only have to export it named and as default from the same file.

nivida on 6 Jan 2020

Btw.: We can't change this that easy because it would break many already existing projects.

import { AccountsBase } from 'web3-core';
import Accounts from 'web3-eth-accounts';

declare module 'web3-eth-accounts' {
  export default class Accounts extends AccountsBase {}
}

smithki on 19 Feb 2020

👍2

We are re-assessing this. There are a few inconsistencies within the deceleration files. Feel free to follow along on #3606 for updates

GregTheGreek on 30 Jun 2020

👍1

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days if no further activity occurs. Thank you for your contributions. If you believe this was a mistake, please comment.