[Q/A] sendToBackground TS type error

[yaxiaoliu]

What happened?

A bug happened!

why name is never ? exceped is string

Version

Latest

What OS are you seeing the problem on?

MacOSX

What browsers are you seeing the problem on?

Chrome

Relevant log output

No response

(OPTIONAL) Contribution

• I would like to fix this BUG via a PR

Code of Conduct

• I agree to follow this project's Code of Conduct
• I checked the current issues for duplicate problems.

[louisgv]

Make sure you run the dev server and restart TS, otherwise the declaration will not register.

[yaxiaoliu]

thanks, it's my wrong

[bilalafzal-ti]

Make sure you run the dev server and restart TS, otherwise the declaration will not register. Still facing this issue.

• Dev server is running
• TS Server also restarted

Versions:

{
    "@plasmohq/messaging": "^0.3.0",
    "plasmo": "0.69.2"
}

[louisgv]

@bilalafzal-ti Can you show me the tree of your project?

[bilalafzal-ti]

@bilalafzal-ti Can you show me the tree of your project?

@louisgv Calling the sendToBackground function from popup.tsx

I even moved the type definition files from background/messages/ping to /background.ts but it did not work.

[louisgv]

@bilalafzal-ti try pnpm create plasmo --with-messaging and see if it works, then adjust your project accordingly. I suspect you might need to move background.ts into background/index.ts

[drmikecrowe]

I have the exact same problem:

Background is already in index.ts:

Here's the pattern I'm using (this is src/background/messages/associate-site.ts):

Versions:

{
  "dependencies": {
    "@plasmohq/messaging": "^0.3.0",
    "@plasmohq/storage": "^1.6.0",
    "plasmo": "^0.70.1"
  }
}

[drmikecrowe]

@louisgv -- Not sure who closed this, has this been fixed?

[louisgv]

@drmikecrowe try upgrade all your dependency

[louisgv]

This error occurs when the TS Language server in VSCode has yet to register the new tsconfig file that was mutated when the dev server was created

So the steps to fix this are:

1. run pnpm dev (so that the underline typing of the bgsw messages are generated)
2. on VSCode, run CMD/CTRL + SHIFT + P, and do TypeScript restart language server

The type will be never until the TS server registered the declaration files generated by plasmo (which is referenced in tsconfig as .plasmo/*

This is a common procedure whenever a new type package is added BTW

[shamoons]

I'm still having this issue

[matzkoh]

"verbatimModuleSyntax": true, so "type": "module" is required, but in that case import ". /messaging" in .plasmo/index.d.ts does not have the extension, so the type is not loaded.

Adding ".plasmo/messaging.d.ts" to include will work.

[ookkoouu]

the name is auto-gen by filenames in background/*.ts

1. create file like background/yourHandler.ts
2. build or dev (restart TS server in some case)
3. Plasmo creates .plasmo/messaging.d.ts
4. name is infer in "yourHandler"

[matzkoh]

There is no problem with the TS server, editor, or user usage.
When generating .plasmo/index.d.ts, it should be import "./messaging.d.ts", not import "./messaging".

As I wrote above, this is a bug.
Workaround is also as described above.

If this workaround does not work, the causes are compounded and other posts in this thread may be helpful.