Function deleteFile

  • Delete a file from the uploads-folder on the configured HBO-ICT.Cloud environment

    Parameters

    • fileName: string

      Path to the file to delete, can contain forward slashes (/) to access subfolders.

    Returns Promise<string | ApiFailReason>

    Returns a promise which can either fail (string with reason) or succeed (string with "OK").

    Throws

    When the API has not been properly configured using configure, an exception is thrown detailing the missing information.

    Example

    Below is a simplified example, you will have to add try/catch and async/await structures yourself.

    import { api } from "@hboictcloud/api";

    const data = await api.deleteFile("test.png");
    console.log(data);

Generated using TypeDoc