[Feature request] SpeechRecognizer.prototype.recognizeOnceAsync could return a Promise

[fungiboletus]

Hei,

This is not very important, but you may want some user feedback to justify the implementation. It would be nice if SpeechRecognizer.prototype.recognizeOnceAsync could return a promise in addition to taking callbacks in its arguments. It would not break backward compatibility and improve the user experience IMHO.

From:

const result = await new Promise<SpeechSDKType.SpeechRecognitionResult>((resolve, reject) => {
    recognizer.recognizeOnceAsync(resolve, reject);
});

To:

const result = await recognizer.recognizeOnceAsync();

[jhakulin]

@fungiboletus Thanks for the great feedback! I created internal workitem ref. 4356980 for the issue.

[Mike-Bell]

I think there's a handful of similar places around the SDK. For instance, I also wish that SpeechSynthesizer.speakTextAsync was a promise.

[rhurey]

@fungiboletus maybe there's something here I don't know, but how would changing from taking callbacks to returning a promise not be a breaking change?

[Mike-Bell]

maybe there's something here I don't know, but how would changing from taking callbacks to returning a promise not be a breaking change?

I've seen a lot of API's that support both on the same function: the function returns a promise that can be awaited, and it additionally allows you to supply an optional callback that will be called if supplied.

[rhurey]

Well, that'll be my "Why didn't I think of that?" for the week.

Thanks!

[fungiboletus]

Sorry I didn't formulate well, I edited the issue. I think you can keep the callbacks for backward compatibility and return a promise too. It's not returning anything in the current version.