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
40 lines
1.5 KiB
Plaintext
40 lines
1.5 KiB
Plaintext
import type { PayloadRequest } from '../types/index.js';
|
|
/**
|
|
* Increments a filename by appending or incrementing a numeric suffix.
|
|
* @example
|
|
* incrementName('file.jpg') // 'file-1.jpg'
|
|
* incrementName('file-1.jpg') // 'file-2.jpg'
|
|
* incrementName('file-99.jpg') // 'file-100.jpg'
|
|
*/
|
|
export declare const incrementName: (name: string) => string;
|
|
type Args = {
|
|
collectionSlug: string;
|
|
desiredFilename: string;
|
|
prefix?: string;
|
|
req: PayloadRequest;
|
|
staticPath: string;
|
|
};
|
|
/**
|
|
* Generates a safe, unique filename by checking for conflicts in both the database
|
|
* and filesystem. If a conflict exists, it increments a numeric suffix until a
|
|
* unique name is found.
|
|
*
|
|
* @param args.collectionSlug - The slug of the upload collection
|
|
* @param args.desiredFilename - The original filename to make safe
|
|
* @param args.prefix - Optional prefix path for cloud storage adapters
|
|
* @param args.req - The Payload request object
|
|
* @param args.staticPath - The filesystem path where uploads are stored
|
|
* @returns A unique filename that doesn't conflict with existing files
|
|
*
|
|
* @example
|
|
* // If 'photo.jpg' already exists, returns 'photo-1.jpg'
|
|
* const safeName = await getSafeFileName({
|
|
* collectionSlug: 'media',
|
|
* desiredFilename: 'photo.jpg',
|
|
* req,
|
|
* staticPath: '/uploads/media',
|
|
* })
|
|
*/
|
|
export declare function getSafeFileName({ collectionSlug, desiredFilename, prefix, req, staticPath, }: Args): Promise<string>;
|
|
export {};
|
|
//# sourceMappingURL=getSafeFilename.d.ts.map |