Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs refer to non existent type #497

Open
2 of 4 tasks
soryy708 opened this issue Nov 13, 2024 · 3 comments
Open
2 of 4 tasks

docs refer to non existent type #497

soryy708 opened this issue Nov 13, 2024 · 3 comments

Comments

@soryy708
Copy link

Is there an existing issue for this?

  • I have searched the existing issues

Current behavior

Docs home page says to:

import { Mocked } from '@suites/unit';

https://suites.dev/docs

but it errors with

Module '"@suites/unit"' has no exported member 'Mocked'. ts(2305)

Minimum reproduction code

.

Steps to reproduce

Try to import Mocked

Expected behavior

Either the type should be exported by the library, or the docs should be updated to the correct type

Suites version

@suites/[email protected]

Node.js version

v20.13.1

In which operating systems have you tested?

  • macOS
  • Windows
  • Linux

Other

No response

@Maloric
Copy link

Maloric commented Nov 13, 2024

Having the same issue. It looks like it should be imported from @suites/doubles.jest. Source file is here:
https://github.com/suites-dev/suites/blob/master/packages/doubles/jest/src/types.ts

@soryy708
Copy link
Author

@Maloric are you using Yarn v1.x?

I reached out to the author, and he pointed me at:

Perhaps the docs home page should have a notice that links there

@soryy708
Copy link
Author

Looks like this issue relates to:

I propose we keep this issue open until the documentation is updated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants