Function deleteDirectory

  • Delete a directory from the uploads-folder on the configured HBO-ICT.Cloud environment, but only when it is empty.

    Parameters

    • path: string

      Path to the directory to delete, can contain forward slashes (/) to access subfolders. Folder has to be empty!

    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.

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

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

Generated using TypeDoc