internetarchive-ts - v0.1.0
    Preparing search index...

    Function deleteFiles

    • Beta

      Delete files from an item. Note: Some system files, such as <itemname>_meta.xml, cannot be deleted.

      Parameters

      • identifier: string

        The globally unique Archive.org identifier for a given item.

      • params: {
            archiveSession?: IaSession;
            cascadeDelete?: any;
            config?: IaAuthConfig;
            excludePattern?: string | string[];
            files?: string | string[];
            formats?: string | string[];
            globPattern?: string | string[];
            headers?: HttpHeaders;
            onTheFly?: boolean;
            retries?: number;
        }

        Delete item params

        • OptionalarchiveSession?: IaSession

          Optional archiveSession object. If not defined, one will be created internally

        • OptionalcascadeDelete?: any

          Delete all files associated with the specified file, including upstream derivatives and the original.

        • Optionalconfig?: IaAuthConfig

          Configuration

        • OptionalexcludePattern?: string | string[]

          Exclude files matching the given glob pattern

        • Optionalfiles?: string | string[]

          Only return files matching the given filenames

        • Optionalformats?: string | string[]

          Only return files matching the given formats

        • OptionalglobPattern?: string | string[]

          Only return files matching the given glob pattern

        • Optionalheaders?: HttpHeaders
        • OptionalonTheFly?: boolean

          Include on-the-fly files (i.e. derivative EPUB)

        • Optionalretries?: number

      Returns Promise<Response[]>

      IaApiError