Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
33 lines
1.2 KiB
Plaintext
33 lines
1.2 KiB
Plaintext
import type { Config } from '../config/types.js';
|
|
/**
|
|
* This function builds correct URLs for admin panel routing.
|
|
* Its primary responsibilities are:
|
|
* 1. Read from your `routes.admin` config and appropriately handle `"/"` admin paths
|
|
* 2. Prepend the `basePath` from your Next.js config, if specified
|
|
* 3. Return relative or absolute URLs, as needed
|
|
*/
|
|
type BaseFormatURLArgs = {
|
|
/**
|
|
* The subpath of your application, if specified.
|
|
* @see https://nextjs.org/docs/app/api-reference/config/next-config-js/basePath
|
|
* @example '/docs'
|
|
*/
|
|
basePath?: string;
|
|
includeBasePath?: boolean;
|
|
path?: '' | `/${string}` | null;
|
|
/**
|
|
* Return a relative URL, e.g. ignore `serverURL`.
|
|
* Useful for route-matching, etc.
|
|
*/
|
|
relative?: boolean;
|
|
} & Pick<Config, 'serverURL'>;
|
|
type FormatURLArgs = ({
|
|
adminRoute: NonNullable<Config['routes']>['admin'];
|
|
apiRoute?: never;
|
|
} & BaseFormatURLArgs) | ({
|
|
adminRoute?: never;
|
|
apiRoute: NonNullable<Config['routes']>['api'];
|
|
} & BaseFormatURLArgs);
|
|
export declare const formatAdminURL: (args: FormatURLArgs) => string;
|
|
export {};
|
|
//# sourceMappingURL=formatAdminURL.d.ts.map |