How to add async command to Tiptap editor

[piszczu4]

I want to add an async command to my commands_ extension as below:

declare module '@tiptap/core' {
  interface Commands<ReturnType> {
    commands_: {
      pasteHTML: async () => boolean;
    };
  }
}

export const Commands = Extension.create({
  name: 'commands_',

  addCommands() {
    return {
      // ...commands,
      pasteHTML: () => async () => {
        let text: string = '';
        text = await window.navigator.clipboard.readText();
        this.editor
          .chain()
          .focus()
          .command(({ view }) => {
            view.pasteHTML(text);
            return true;
          });

        return true;
      },

      // pasteText: () => async () => {
      //   let text: string = '';
      //   text = await window.navigator.clipboard.readText();
      //   this.editor
      //     .chain()
      //     .focus()
      //     .command((props) => {
      //       props.view.pasteText(text);
      //       return true;
      //     });
      //   return true;
      // },
    };
  },
});

Unfortunately

      pasteHTML: async () => boolean;

throws an error. What should I change?

[clementbouakildeltarm]

Hello @piszczu4 ! Do you find a solution for this ? Thanks !

[nperez0111]

Tiptap does not support async commands, since the transform they build via chaining is expected to be executed synchronously. If you need to do something async, you have that in your function, just cannot return the promise, only return true to indicate that it actually executed whatever action.

Example:

      pasteHTML: () => ({ dispatch }) => {

      if (dispatch) {
        (async () => {
           let text: string = '';
           text = await window.navigator.clipboard.readText();
           this.editor
            .chain()
            .focus()
            .command(({ view }) => {
               view.pasteHTML(text);
               return true;
             });
        })()
        return true;
      }
        
      },

[dingshaohua-com]

dispath not work，what can i do？

[nperez0111]

#5763