@chris.troutner/ipfs-message-port-client
Version:
IPFS client library for accessing IPFS node over message port
64 lines • 5.45 kB
TypeScript
export = CoreClient;
/**
* @template T
* @typedef {import('@chris.troutner/ipfs-message-port-protocol/src/core').RemoteIterable<T>} RemoteIterable
*/
/**
* @typedef {import('@chris.troutner/ipfs-message-port-protocol/src/cid').EncodedCID} EncodedCID
* @typedef {import('@chris.troutner/ipfs-message-port-protocol/src/root').EncodedAddInput} EncodedAddInput
* @typedef {import('@chris.troutner/ipfs-message-port-protocol/src/root').EncodedAddAllInput} EncodedAddAllInput
* @typedef {import('@chris.troutner/ipfs-message-port-protocol/src/root').EncodedAddResult} EncodedAddResult
* @typedef {import('@chris.troutner/ipfs-message-port-protocol/src/root').EncodedIPFSEntry} EncodedIPFSEntry
* @typedef {import('@chris.troutner/ipfs-message-port-protocol/src/root').EncodedFileInput} EncodedFileInput
* @typedef {import('@chris.troutner/ipfs-message-port-protocol/src/root').EncodedFileContent} EncodedFileContent
* @typedef {import('@chris.troutner/ipfs-message-port-protocol/src/root').EncodedDirectoryInput} EncodedDirectoryInput
*
* @typedef {import('@chris.troutner/ipfs-message-port-server').CoreService} CoreService
*
* @typedef {import('./client').MessageTransport} MessageTransport
* @typedef {import('./interface').MessagePortClientOptions} MessagePortClientOptions
* @typedef {import('@chris.troutner/ipfs-core-types/src/root').API<MessagePortClientOptions>} RootAPI
*
* @typedef {import('@chris.troutner/ipfs-core-types/src/utils').ImportCandidate} ImportCandidate
* @typedef {import('@chris.troutner/ipfs-core-types/src/utils').ToFile} ToFile
* @typedef {import('@chris.troutner/ipfs-core-types/src/utils').ToDirectory} ToDirectory
* @typedef {import('@chris.troutner/ipfs-core-types/src/utils').ToContent} ToContent
* @typedef {import('@chris.troutner/ipfs-core-types/src/utils').ImportCandidateStream} ImportCandidateStream
*/
/**
* @class
* @extends {Client<CoreService>}
*/
declare class CoreClient extends Client<import("@chris.troutner/ipfs-message-port-server").CoreService> {
/**
* @param {MessageTransport} transport
*/
constructor(transport: MessageTransport);
addAll(source: import("@chris.troutner/ipfs-core-types/src/utils").ImportCandidateStream, options?: (import("@chris.troutner/ipfs-core-types/src/root").AddAllOptions & import("@chris.troutner/ipfs-core-types/src/utils").AbortOptions & import("./interface").MessagePortClientOptions) | undefined): AsyncIterable<import("@chris.troutner/ipfs-core-types/src/root").AddResult>;
add(entry: import("@chris.troutner/ipfs-core-types/src/utils").ImportCandidate, options?: (import("@chris.troutner/ipfs-core-types/src/root").AddOptions & import("./interface").MessagePortClientOptions) | undefined): Promise<import("@chris.troutner/ipfs-core-types/src/root").AddResult>;
cat(ipfsPath: import("@chris.troutner/ipfs-core-types/src/utils").IPFSPath, options?: (import("@chris.troutner/ipfs-core-types/src/root").CatOptions & import("./interface").MessagePortClientOptions) | undefined): AsyncIterable<Uint8Array>;
ls(ipfsPath: import("@chris.troutner/ipfs-core-types/src/utils").IPFSPath, options?: (import("@chris.troutner/ipfs-core-types/src/root").ListOptions & import("./interface").MessagePortClientOptions) | undefined): AsyncIterable<import("@chris.troutner/ipfs-core-types/src/root").IPFSEntry>;
}
declare namespace CoreClient {
export { RemoteIterable, EncodedCID, EncodedAddInput, EncodedAddAllInput, EncodedAddResult, EncodedIPFSEntry, EncodedFileInput, EncodedFileContent, EncodedDirectoryInput, CoreService, MessageTransport, MessagePortClientOptions, RootAPI, ImportCandidate, ToFile, ToDirectory, ToContent, ImportCandidateStream };
}
import Client = require("./client");
type MessageTransport = import('./client').MessageTransport;
type RemoteIterable<T> = import('@chris.troutner/ipfs-message-port-protocol/src/core').RemoteIterable<T>;
type EncodedCID = import('@chris.troutner/ipfs-message-port-protocol/src/cid').EncodedCID;
type EncodedAddInput = import('@chris.troutner/ipfs-message-port-protocol/src/root').EncodedAddInput;
type EncodedAddAllInput = import('@chris.troutner/ipfs-message-port-protocol/src/root').EncodedAddAllInput;
type EncodedAddResult = import('@chris.troutner/ipfs-message-port-protocol/src/root').EncodedAddResult;
type EncodedIPFSEntry = import('@chris.troutner/ipfs-message-port-protocol/src/root').EncodedIPFSEntry;
type EncodedFileInput = import('@chris.troutner/ipfs-message-port-protocol/src/root').EncodedFileInput;
type EncodedFileContent = import('@chris.troutner/ipfs-message-port-protocol/src/root').EncodedFileContent;
type EncodedDirectoryInput = import('@chris.troutner/ipfs-message-port-protocol/src/root').EncodedDirectoryInput;
type CoreService = import('@chris.troutner/ipfs-message-port-server').CoreService;
type MessagePortClientOptions = import('./interface').MessagePortClientOptions;
type RootAPI = import('@chris.troutner/ipfs-core-types/src/root').API<MessagePortClientOptions>;
type ImportCandidate = import('@chris.troutner/ipfs-core-types/src/utils').ImportCandidate;
type ToFile = import('@chris.troutner/ipfs-core-types/src/utils').ToFile;
type ToDirectory = import('@chris.troutner/ipfs-core-types/src/utils').ToDirectory;
type ToContent = import('@chris.troutner/ipfs-core-types/src/utils').ToContent;
type ImportCandidateStream = import('@chris.troutner/ipfs-core-types/src/utils').ImportCandidateStream;
//# sourceMappingURL=core.d.ts.map