fix: Update FlatCompat docs + typings to reflect Array (#99)

* update typings * Update docs
eslint · Dec 28, 2022 · 5be711e · 5be711e
1 parent 5d8f9c9
commit 5be711e
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -37,19 +37,19 @@ const compat = new FlatCompat({
 export default [
 
     // mimic ESLintRC-style extends
-    compat.extends("standard", "example"),
+    ...compat.extends("standard", "example"),
 
     // mimic environments
-    compat.env({
+    ...compat.env({
         es2020: true,
         node: true
     }),
 
     // mimic plugins
-    compat.plugins("airbnb", "react"),
+    ...compat.plugins("airbnb", "react"),
 
     // translate an entire config
-    compat.config({
+    ...compat.config({
         plugins: ["airbnb", "react"],
         extends: "standard",
         env: {

diff --git a/lib/flat-compat.js b/lib/flat-compat.js
@@ -273,7 +273,7 @@ class FlatCompat {
     /**
      * Translates the `env` section of an ESLintRC-style config.
      * @param {Object} envConfig The `env` section of an ESLintRC config.
-     * @returns {Object} A flag-config object representing the environments.
+     * @returns {Object[]} An array of flag-config objects representing the environments.
      */
     env(envConfig) {
         return this.config({
@@ -284,7 +284,7 @@ class FlatCompat {
     /**
      * Translates the `extends` section of an ESLintRC-style config.
      * @param {...string} configsToExtend The names of the configs to load.
-     * @returns {Object} A flag-config object representing the config.
+     * @returns {Object[]} An array of flag-config objects representing the config.
      */
     extends(...configsToExtend) {
         return this.config({
@@ -295,7 +295,7 @@ class FlatCompat {
     /**
      * Translates the `plugins` section of an ESLintRC-style config.
      * @param {...string} plugins The names of the plugins to load.
-     * @returns {Object} A flag-config object representing the plugins.
+     * @returns {Object[]} An array of flag-config objects representing the plugins.
      */
     plugins(...plugins) {
         return this.config({