BUG: index.d.ts says that run commands should return void but docs say their return value may be used

Question

GrapesJS version

I confirm to use the latest version of GrapesJS

What browser are you using?

Any

Reproducible demo link

https://grapesjs.com/docs/modules/Commands.html#stateful-commands

Describe the bug

How to reproduce the bug?

in a typescript setup,

import grapesjs from "grapesjs";

export const ExportPlugin = (editor: grapesjs.Editor) => {
  editor.Commands.add("render html", (editor) => {
    return "<html><body>example</body></html>";
  }););
};

What is the expected behavior?

it is allowed, as in the "Let's return something" example at https://grapesjs.com/docs/modules/Commands.html#stateful-commands

What is the current behavior?

Argument of type '(editor: grapesjs.Editor) => string' is not assignable to parameter of type '(editor: Editor) => void | { run: (editor: Editor, sender?: any) => void; stop: (editor: Editor, sender?: any) => void; }'.
  Type 'string' is not assignable to type 'void | { run: (editor: Editor, sender?: any) => void; stop: (editor: Editor, sender?: any) => void; }'.

I'm having difficulty making the example work with the

{
  run: (editor: Editor, sender?: any) => void;
  stop: (editor: Editor, sender?: any) => void;
}

definitions as well - (in addition to the (editor: Editor) => void definition, as described above)

Should all 3 of these void declarations in fact be any?

Code of Conduct

I agree to follow this project's Code of Conduct

BUG: index.d.ts says that run commands should return void but docs say their return value may be used

Question

GrapesJS version

What browser are you using?

Reproducible demo link

Describe the bug

Code of Conduct

Answers (1)

Related Questions and Answers

BUG: index.d.ts says that components must be Backbone.Collection<Component> but the docs say Component[] is also accepted

BUG: Missing inline styles used by CKEditor when adding raw html components

BUG: is there any way to remove cross svg on selected default value of Float, Position and text-align

BUG: Too much recursion

Paid Plugins That Match This Issue

Browse Plugin Categories