Fix the return type of format: string -> Promise<string>

prettier · May 25, 2022 · ae3227c · ae3227c
1 parent 26a574c
commit ae3227c
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/src/index.js b/src/index.js
@@ -38,7 +38,7 @@ module.exports = format;
  * @param {String} options.logLevel - the level for the logs
  *  (error, warn, info, debug, trace)
  * @param {Boolean} options.prettierLast - Run Prettier Last
- * @return {String} - the formatted string
+ * @return {Promise<String>} - the formatted string
  */
 async function format(options) {
   const { logLevel = getDefaultLogLevel() } = options;

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -90,6 +90,6 @@ declare namespace format {
  * supplied configuration. The auto-formatting is limited to the issues that
  * Prettier and ESLint can automatically fix.
  */
-declare function format(options: format.Options): string;
+declare function format(options: format.Options): Promise<string>;
 
 export = format;