Files
old-kitabcitab-frontend/kitabcitab/node_modules/next/dist/shared/lib/page-path/absolute-path-to-page.d.ts
2022-12-27 12:05:56 +01:00

17 lines
699 B
TypeScript

/**
* Given the absolute path to the pages folder, an absolute file path for a
* page and the page extensions, this function will return the page path
* relative to the pages folder. It doesn't consider index tail. Example:
* - `/Users/rick/my-project/pages/foo/bar/baz.js` -> `/foo/bar/baz`
*
* @param filepath Absolute path to the page.
* @param opts.pagesDir Absolute path to the pages folder.
* @param opts.extensions Extensions allowed for the page.
* @param opts.keepIndex When true the trailing `index` kept in the path.
*/
export declare function absolutePathToPage(pagePath: string, options: {
extensions: string[];
keepIndex?: boolean;
pagesDir: string;
}): string;