@egodigital/nef/lib/catalogs/DirectoryCatalog.d.ts

Managed Extensibility Framework like library written for Node.js

/**
 * This file is part of the @egodigital/nef distribution.
 * Copyright (c) e.GO Digital GmbH, Aachen, Germany (https://www.e-go-digital.com/)
 *
 * @egodigital/nef is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, version 3.
 *
 * @egodigital/nef is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
import { CatalogBase } from './CatalogBase';
/**
 * Options for 'DirectoryCatalog' class.
 */
export interface DirectoryCatalogOptions {
    /**
     * The custom current work directory. Default: process.cwd()
     */
    cwd?: string;
    /**
     * One or more patterns of file to exclude.
     */
    exclude?: string | string[];
    /**
     * One or more patterns. Default: *.js or *.ts
     */
    patterns?: string | string[];
}
/**
 * A catalog based on one or more JavaScript modules in a directory.
 */
export declare class DirectoryCatalog extends CatalogBase {
    readonly directory: string;
    readonly options?: DirectoryCatalogOptions;
    /**
     * Initializes a new instance of that class.
     *
     * @param {string} directory The path to the directory.
     * @param {FileCatalogOptions} [options] Custom options.
     */
    constructor(directory: string, options?: DirectoryCatalogOptions);
    /** @inheritdoc */
    getClasses(): Promise<any[]>;
    /** @inheritdoc */
    getClassesSync(): any[];
    private getGlobOptions;
    private getPatterns;
    private loadClasses;
}