Automatically or manuallye rename files.

import { defineFilePond } from 'filepond';
import { locale } from 'filepond/locales/en-gb.js';
import { FileNameTransform } from 'filepond/extensions/file-name-transform.js';

defineFilePond({
    locale,
    extensions: [
        // Add the FileNameTransform extension
        [FileNameTransform, {
            // Any entry that is added should be renamed
            shouldTransform: (entry) => {
                return true;
            },
            // We add "hi" between the file name and its extension
            renameEntry:(entry, { basename, extension }) => {
                return basename + '-hi' + extension;
            }
        }]
    ]
})

Configuration

The FileNameTransform extension accepts an option object of type FileNameTransformOptions which defines the properties below.

actionTransform

Action name to use for rename. Defaults to 'renameFile'

actionTransform?: string

sanitizeName

Function to use for sanitizing the user input.

sanitizeName?: (fileName: string) => string

renameEntry

Allows requesting a new filename.

renameEntry?: (entry: FilePondFileEntry, options: { basename: string; extentsion: string; history: string[]; }) => Promise<string>