Function ls

ls(
    endpoint_xid: string,
    options?: {
        query?: {
            filter?: string;
            limit?: number | `${number}`;
            offset?: number | `${number}`;
            orderby?: string;
            path?: string;
            show_hidden?: "true" | "false";
        };
    } & {
        headers?: Headers;
        query?: {
            [key: string]: | undefined
            | null
            | string
            | number
            | boolean
            | (undefined | null | string | number)[];
        };
    },
    sdkOptions?: SDKOptions,
): Promise<JSONFetchResponse<FileListDocument | DirectoryListingError>>
List the contents of the directory at the specified path on an endpoint’s filesystem. The endpoint must be activated before performing this operation.
Parameters
- endpoint_xid: string
- Optionaloptions: {
      query?: {
          filter?: string;
          limit?: number | `${number}`;
          offset?: number | `${number}`;
          orderby?: string;
          path?: string;
          show_hidden?: "true" | "false";
      };
  } & {
      headers?: Headers;
      query?: {
          [key: string]: | undefined
          | null
          | string
          | number
          | boolean
          | (undefined | null | string | number)[];
      };
  }
- OptionalsdkOptions: SDKOptions
Returns Promise<JSONFetchResponse<FileListDocument | DirectoryListingError>>
See
https://docs.globus.org/api/transfer/file_operations/#list_directory_contents
- Defined in src/services/transfer/service/file-operations.ts:74

Function ls

Parameters

Returns Promise<JSONFetchResponse<FileListDocument | DirectoryListingError>>

See

Settings