Interface FilePondServerConfigProps

types/index.d.ts:275–335

}

export interface FilePondServerConfigProps {
    /**
     * Immediately upload new files to the server.
     * @default true
     */
    instantUpload?: boolean;
    /**
     * The maximum number of files that can be uploaded in parallel.
     * @default 2
     */
    maxParallelUploads?: number;

    /**
     * Server API Configuration.
     * See: https://pqina.nl/filepond/docs/patterns/api/server
     * @default null
     */
    server?:
        | string
        | {
              url?: string;
              timeout?: number;
              headers?: { [key: string]: string | boolean | number };
              process?: string | ServerUrl | ProcessServerConfigFunction | null;
              revert?: string | ServerUrl | RevertServerConfigFunction | null;
              restore?: string | ServerUrl | RestoreServerConfigFunction | null;
              load?: string | ServerUrl | LoadServerConfigFunction | null;
              fetch?: string | ServerUrl | FetchServerConfigFunction | null;
              patch?: string | ServerUrl | null;
              remove?: RemoveServerConfigFunction | null;
          }
        | null;

    /**
     * Enable chunk uploads
     * @default false
     */
    chunkUploads?: boolean;
    /**
     * Force use of chunk uploads even for files smaller than chunk size
     * @default false
     */
    chunkForce?: boolean;
    /**
     * Size of chunks (5MB default)
     * @default 5000000
     */
    chunkSize?: number;
    /**
     * Amount of times to retry upload of a chunk when it fails
     * @default [500, 1000, 3000]
     */
    chunkRetryDelays?: number[];

    /**
     * A list of file locations that should be loaded immediately.
     * See: https://pqina.nl/filepond/docs/patterns/api/filepond-object/#setting-initial-files
     * @default []