synapse-react-client/dist/utils/functions/FileHandleUtils.d.ts

[](https://badge.fury.io/js/synapse-react-client) [](https://github.com/prettier/prettie

import { UploadDestination } from '@sage-bionetworks/synapse-client';
import { EntityBundle, FileHandle } from '@sage-bionetworks/synapse-types';
type FileHandleStorageInfo = {
    endpoint: string;
    bucket: string;
    fileKey: string;
} | {
    url: string;
} | {
    location: string;
};
/**
 * Returns storage location information for a particular file handle, where the format of the information depends on the type of file handle.
 * @param fileHandle
 */
export declare function getFileHandleStorageInfo(fileHandle: FileHandle, storageLocationUploadDestination: UploadDestination | undefined): FileHandleStorageInfo;
/**
 * Gets the friendly name of a bucket/storage location using the file handle.
 *
 * @param fileHandle
 * @returns
 */
export declare function getStorageLocationName(fileHandle: FileHandle, storageLocationUploadDestination: UploadDestination | undefined): string;
/**
 * Gets the data file handle from an entity bundle.
 * Returns undefined if the entity does not have a data file handle that is visible to the caller.
 * @param entityBundle
 */
export declare function getDataFileHandle(entityBundle: EntityBundle): FileHandle | undefined;
export declare function getUploadDestinationString(uploadDestination: UploadDestination): string;
export {};
//# sourceMappingURL=FileHandleUtils.d.ts.map