@chris.troutner/ipfs-message-port-client
Version:
IPFS client library for accessing IPFS node over message port
31 lines • 2.27 kB
TypeScript
export = BlockClient;
/**
* @typedef {import('./client').MessageTransport} MessageTransport
* @typedef {import('@chris.troutner/ipfs-message-port-server').BlockService} BlockService
* @typedef {import('./interface').MessagePortClientOptions} MessagePortClientOptions
* @typedef {import('@chris.troutner/ipfs-core-types/src/block').API<MessagePortClientOptions>} BlockAPI
*/
/**
* @class
* @extends {Client<BlockService>}
*/
declare class BlockClient extends Client<import("@chris.troutner/ipfs-message-port-server").BlockService> {
/**
* @param {MessageTransport} transport
*/
constructor(transport: MessageTransport);
get(cid: string | CID | Uint8Array, options?: (import("@chris.troutner/ipfs-core-types").AbortOptions & import("@chris.troutner/ipfs-core-types/src/utils").PreloadOptions & import("./interface").MessagePortClientOptions) | undefined): Promise<import("ipld-block")>;
put(block: Uint8Array | import("ipld-block"), options?: (import("@chris.troutner/ipfs-core-types/src/block").PutOptions & import("./interface").MessagePortClientOptions) | undefined): Promise<import("ipld-block")>;
rm(cid: CID | CID[], options?: (import("@chris.troutner/ipfs-core-types/src/block").RmOptions & import("./interface").MessagePortClientOptions) | undefined): AsyncIterable<import("@chris.troutner/ipfs-core-types/src/block").RmResult>;
stat(ipfsPath: import("@chris.troutner/ipfs-core-types/src/utils").IPFSPath, options?: (import("@chris.troutner/ipfs-core-types").AbortOptions & import("@chris.troutner/ipfs-core-types/src/utils").PreloadOptions & import("./interface").MessagePortClientOptions) | undefined): Promise<import("@chris.troutner/ipfs-core-types/src/block").StatResult>;
}
declare namespace BlockClient {
export { MessageTransport, BlockService, MessagePortClientOptions, BlockAPI };
}
import Client = require("./client");
import CID = require("cids");
type MessageTransport = import('./client').MessageTransport;
type BlockService = import('@chris.troutner/ipfs-message-port-server').BlockService;
type MessagePortClientOptions = import('./interface').MessagePortClientOptions;
type BlockAPI = import('@chris.troutner/ipfs-core-types/src/block').API<MessagePortClientOptions>;
//# sourceMappingURL=block.d.ts.map