Function listDirectory

  • List all files and directories inside a directory, inside the uploads-folder on the configured HBO-ICT.Cloud environment.

    Parameters

    • path: string

      Path to the directory to list, 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 files and directories).

    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.listDirectory("test");
    console.log(data);

Generated using TypeDoc