docs: avoid return type of null for tokenize

eslint · May 10, 2022 · 968d5d9 · 968d5d9
1 parent 616deb4
commit 968d5d9
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/dist/espree.d.ts b/dist/espree.d.ts
@@ -2,11 +2,11 @@
  * Tokenizes the given code.
  * @param {string} code The code to tokenize.
  * @param {ParserOptions} options Options defining how to tokenize.
- * @returns {import('acorn').Token[] | null} An array of tokens.
+ * @returns {import('acorn').Token[]} An array of tokens.
  * @throws {import('./lib/espree').EnhancedSyntaxError} If the input code is invalid.
  * @private
  */
-export function tokenize(code: string, options: ParserOptions): import('acorn').Token[] | null;
+export function tokenize(code: string, options: ParserOptions): import('acorn').Token[];
 /**
  * Parses the given code.
  * @param {string} code The code to tokenize.

diff --git a/dist/espree.d.ts.map b/dist/espree.d.ts.map
diff --git a/espree.js b/espree.js
@@ -182,7 +182,7 @@ const parsers = {
  * Tokenizes the given code.
  * @param {string} code The code to tokenize.
  * @param {ParserOptions} options Options defining how to tokenize.
- * @returns {acorn.Token[]|null} An array of tokens.
+ * @returns {acorn.Token[]} An array of tokens.
  * @throws {EnhancedSyntaxError} If the input code is invalid.
  * @private
  */
@@ -194,7 +194,7 @@ export function tokenize(code, options) {
         options = Object.assign({}, options, { tokens: true }); // eslint-disable-line no-param-reassign
     }
 
-    return new Parser(options, code).tokenize();
+    return /** @type {acorn.Token[]} */ (new Parser(options, code).tokenize());
 }
 
 //------------------------------------------------------------------------------