Source: system/storage-base-delete-file.ts

/**
 * @author Michael Hasenstein <hasenstein@yahoo.com>
 * @copyright REFINIO GmbH 2017
 * @license CC-BY-NC-SA-2.5; portions MIT License
 * @version 0.0.1
 */

/**
 * The delete function is in its own module to underline the exceptional nature of removing
 * files from ONE.
 * @module
 */

/* eslint-disable @typescript-eslint/no-unused-vars */

import {createError} from '../errors';
import type {StorageDirTypes} from '../storage-base-common';
import {STORAGE} from '../storage-base-common';

/**
 * This method removes an entry from storage. If the key does not exist, nothing happens, no
 * error is thrown.
 *
 * **Note:** There will be no error if the file to be deleted does not exist to begin with.
 * @static
 * @async
 * @param {string} filename - The filename to be deleted
 * @param {StorageDirTypes} [type='objects']
 * @returns {Promise<undefined>} Returns a promise that resolves with `undefined`.
 * @throws {Error} Throws an `Error` if no filename is given
 */
export function deleteFile(
    filename: string,
    type: StorageDirTypes = STORAGE.OBJECTS
): Promise<void> {
    return Promise.reject(createError('DUMMY'));
}