@ethersphere/bee-js
Version:
Javascript client for Bee
36 lines (35 loc) • 1.65 kB
TypeScript
import type { BeeRequestOptions, DownloadOptions, RedundantUploadOptions, ReferenceInformation } from '../types';
import { UploadResult } from '../types';
import { Bytes } from '../utils/bytes';
import { ResourceLocator } from '../utils/resource-locator';
import { BatchId, Reference } from '../utils/typed-bytes';
/**
* Upload data to a Bee node
*
* @param requestOptions Options for making requests
* @param data Data to be uploaded
* @param postageBatchId Postage BatchId that will be assigned to uploaded data
* @param options Additional options like tag, encryption, pinning
*/
export declare function upload(requestOptions: BeeRequestOptions, data: string | Uint8Array, postageBatchId: BatchId, options?: RedundantUploadOptions): Promise<UploadResult>;
/**
* Requests content length for a reference
*
* @param requestOptions Options for making requests
* @param hash Bee content reference
*/
export declare function head(requestOptions: BeeRequestOptions, reference: Reference | Uint8Array | string): Promise<ReferenceInformation>;
/**
* Download data as a byte array
*
* @param requestOptions Options for making requests
* @param hash Bee content reference
*/
export declare function download(requestOptions: BeeRequestOptions, resource: ResourceLocator, options?: DownloadOptions): Promise<Bytes>;
/**
* Download data as a readable stream
*
* @param requestOptions Options for making requests
* @param hash Bee content reference
*/
export declare function downloadReadable(requestOptions: BeeRequestOptions, resource: ResourceLocator, options?: DownloadOptions): Promise<ReadableStream<Uint8Array>>;