index.d.ts in immosquare-cleaner-0.1.52

- old
+ new

@@ -2,10 +2,11 @@
 export type PropertyDefinition = import("@eslint/object-schema").PropertyDefinition;
 export type ObjectDefinition = import("@eslint/object-schema").ObjectDefinition;
 export type ConfigObject = import("./types.ts").ConfigObject;
 export type IMinimatchStatic = import("minimatch").IMinimatchStatic;
 export type IMinimatch = import("minimatch").IMinimatch;
+export type PathImpl = typeof import("@jsr/std__path");
 export type ObjectSchemaInstance = import("@eslint/object-schema").ObjectSchema;
 /**
  * Represents an array of config objects and provides method for working with
  * those config objects.
  */
@@ -13,11 +14,12 @@
     /**
      * Creates a new instance of ConfigArray.
      * @param {Iterable|Function|Object} configs An iterable yielding config
      *      objects, or a config function, or a config object.
      * @param {Object} options The options for the ConfigArray.
-     * @param {string} [options.basePath=""] The path of the config file
+     * @param {string} [options.basePath="/"] The absolute path of the config file directory.
+     * 		Defaults to `"/"`.
      * @param {boolean} [options.normalized=false] Flag indicating if the
      *      configs have already been normalized.
      * @param {Object} [options.schema] The additional schema
      *      definitions to use for the ConfigArray schema.
      * @param {Array<string>} [options.extraConfigTypes] List of config types supported.
@@ -75,11 +77,11 @@
      * @returns {ConfigArray} The current ConfigArray instance.
      */
     normalizeSync(context?: any): ConfigArray;
     /**
      * Returns the config object for a given file path and a status that can be used to determine why a file has no config.
-     * @param {string} filePath The complete path of a file to get a config for.
+     * @param {string} filePath The path of a file to get a config for.
      * @returns {{ config?: Object, status: "ignored"|"external"|"unconfigured"|"matched" }}
      * An object with an optional property `config` and property `status`.
      * `config` is the config object for the specified file as returned by {@linkcode ConfigArray.getConfig},
      * `status` a is one of the constants returned by {@linkcode ConfigArray.getConfigStatus}.
      */
@@ -87,48 +89,49 @@
         config?: any;
         status: "ignored" | "external" | "unconfigured" | "matched";
     };
     /**
      * Returns the config object for a given file path.
-     * @param {string} filePath The complete path of a file to get a config for.
+     * @param {string} filePath The path of a file to get a config for.
      * @returns {Object|undefined} The config object for this file or `undefined`.
      */
     getConfig(filePath: string): any | undefined;
     /**
      * Determines whether a file has a config or why it doesn't.
-     * @param {string} filePath The complete path of the file to check.
+     * @param {string} filePath The path of the file to check.
      * @returns {"ignored"|"external"|"unconfigured"|"matched"} One of the following values:
      * * `"ignored"`: the file is ignored
      * * `"external"`: the file is outside the base path
      * * `"unconfigured"`: the file is not matched by any config
      * * `"matched"`: the file has a matching config
      */
     getConfigStatus(filePath: string): "ignored" | "external" | "unconfigured" | "matched";
     /**
      * Determines if the given filepath is ignored based on the configs.
-     * @param {string} filePath The complete path of a file to check.
+     * @param {string} filePath The path of a file to check.
      * @returns {boolean} True if the path is ignored, false if not.
      * @deprecated Use `isFileIgnored` instead.
      */
     isIgnored(filePath: string): boolean;
     /**
      * Determines if the given filepath is ignored based on the configs.
-     * @param {string} filePath The complete path of a file to check.
+     * @param {string} filePath The path of a file to check.
      * @returns {boolean} True if the path is ignored, false if not.
      */
     isFileIgnored(filePath: string): boolean;
     /**
      * Determines if the given directory is ignored based on the configs.
      * This checks only default `ignores` that don't have `files` in the
      * same config. A pattern such as `/foo` be considered to ignore the directory
      * while a pattern such as `/foo/**` is not considered to ignore the
      * directory because it is matching files.
-     * @param {string} directoryPath The complete path of a directory to check.
+     * @param {string} directoryPath The path of a directory to check.
      * @returns {boolean} True if the directory is ignored, false if not. Will
      * 		return true for any directory that is not inside of `basePath`.
      * @throws {Error} When the `ConfigArray` is not normalized.
      */
     isDirectoryIgnored(directoryPath: string): boolean;
+    #private;
 }
 export namespace ConfigArraySymbol {
     let isNormalized: symbol;
     let configCache: symbol;
     let schema: symbol;