next/dist/shared/lib/page-path/remove-page-path-tail.d.ts

The React Framework

/**
 * Removes the file extension for a page and the trailing `index` if it exists
 * making sure to not return an empty string. The page head is not touched
 * and returned as it is passed. Examples:
 *   - `/foo/bar/baz/index.js` -> `/foo/bar/baz`
 *   - `/foo/bar/baz.js` -> `/foo/bar/baz`
 *
 * @param pagePath A page to a page file (absolute or relative)
 * @param options.extensions Extensions allowed for the page.
 * @param options.keepIndex When true the trailing `index` is _not_ removed.
 */
export declare function removePagePathTail(pagePath: string, options: {
    extensions: ReadonlyArray<string>;
    keepIndex?: boolean;
}): string;