fix: ConfigObject type (#27)

eslint · May 27, 2024 · e42b15d · e42b15d
1 parent c611c72
commit e42b15d
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/packages/config-array/src/config-array.js b/packages/config-array/src/config-array.js
@@ -21,7 +21,7 @@ import { filesAndIgnoresSchema } from "./files-and-ignores-schema.js";
 
 /** @typedef {import("@eslint/object-schema").PropertyDefinition} PropertyDefinition */
 /** @typedef {import("@eslint/object-schema").ObjectDefinition} ObjectDefinition */
-/** @typedef {import("./types.ts").BaseConfigObject} BaseConfigObject */
+/** @typedef {import("./types.ts").ConfigObject} ConfigObject */
 /** @typedef {import("minimatch").IMinimatchStatic} IMinimatchStatic */
 /** @typedef {import("minimatch").IMinimatch} IMinimatch */
 
@@ -125,7 +125,7 @@ class ConfigError extends Error {
 
 /**
  * Gets the name of a config object.
- * @param {BaseConfigObject} config The config object to get the name of.
+ * @param {ConfigObject} config The config object to get the name of.
  * @returns {string} The name of the config object.
  */
 function getConfigName(config) {

diff --git a/packages/config-array/src/types.ts b/packages/config-array/src/types.ts
@@ -3,7 +3,7 @@
  * @author Nicholas C. Zakas
  */
 
-export interface BaseConfigObject {
+export interface ConfigObject {
 	/**
 	 * The files to include.
 	 */
@@ -18,4 +18,7 @@ export interface BaseConfigObject {
 	 * The name of the config object.
 	 */
 	name?: string;
+
+	// may also have any number of other properties
+	[key: string]: unknown;
 }