@mnrendra/read-package/dist/index.d.ts

Read the package.json file from any sub-directory in your project.

import { Package } from '@mnrendra/types-package';
export { Package } from '@mnrendra/types-package';
import { SkippedStacks } from '@mnrendra/read-stacked-json';
export { SkippedStacks, ValidSkippedStacks, validateSkippedStacks } from '@mnrendra/read-stacked-json';

/**
 * The options interface.
 *
 * @see https://github.com/mnrendra/read-package#readme
 */
interface Options {
    /**
     * A name or a list of names of stack traces that need to be skipped.
     *
     * @default []
     *
     * @see https://github.com/mnrendra/read-package#readme
     */
    skippedStacks?: SkippedStacks;
    /**
     * The `Error.stackTraceLimit` property specifies the number of stack frames
     * to be collected by a stack trace.
     *
     * @default 10
     *
     * @see https://github.com/mnrendra/read-package#readme
     */
    stackTraceLimit?: number;
}

/**
 * Read the `package.json` file asynchronously.
 *
 * @param {Options} [options] - Optional params.
 *
 * @returns {Promise<Package>} `package.json` JSON value.
 *
 * @see https://github.com/mnrendra/read-package#readme
 */
declare const main$1: ({ skippedStacks, stackTraceLimit }?: Options) => Promise<Package>;

/**
 * Read the `package.json` file synchronously.
 *
 * @param {Options} [options] - Optional params.
 *
 * @returns {Package} `package.json` JSON value.
 *
 * @see https://github.com/mnrendra/read-package#readme
 */
declare const main: ({ skippedStacks, stackTraceLimit }?: Options) => Package;

export { type Options, main$1 as readPackage, main as readPackageSync };
//# sourceMappingURL=index.d.ts.map