ipfs-http-client
Version:
A client library for the IPFS HTTP API
39 lines • 2.44 kB
TypeScript
export = Remote;
/**
* @typedef {import('../../types').Options} Options
* @typedef {import('ipfs-core-types/src/utils').AbortOptions} AbortOptions
* @typedef {import('ipfs-core-types/src/pin/remote').Pin} Pin
* @typedef {import('ipfs-core-types/src/pin/remote').AddOptions} AddOptions
* @typedef {import('ipfs-core-types/src/pin/remote').Query} Query
* @typedef {import('ipfs-core-types/src/pin/remote').Status} Status
* @typedef {import('../../types').HTTPClientExtraOptions} HTTPClientExtraOptions
* @typedef {import('ipfs-core-types/src/pin/remote').API<HTTPClientExtraOptions>} RemotePiningAPI
*/
declare class Remote {
/**
* @param {Options} options
*/
constructor(options: Options);
client: Client;
/** @readonly */
readonly service: Service;
add(cid: CID, options: import("ipfs-core-types/src/pin/remote").AddOptions & import("ipfs-core-types/src/utils").AbortOptions & import("../../types").HTTPClientExtraOptions): Promise<import("ipfs-core-types/src/pin/remote").Pin>;
ls(query: import("ipfs-core-types/src/pin/remote").Query & import("ipfs-core-types/src/utils").AbortOptions & import("../../types").HTTPClientExtraOptions): AsyncIterable<import("ipfs-core-types/src/pin/remote").Pin>;
rm(query: import("ipfs-core-types/src/pin/remote").Query & import("ipfs-core-types/src/utils").AbortOptions & import("../../types").HTTPClientExtraOptions): Promise<void>;
rmAll(query: import("ipfs-core-types/src/pin/remote").Query & import("ipfs-core-types/src/utils").AbortOptions & import("../../types").HTTPClientExtraOptions): Promise<void>;
}
declare namespace Remote {
export { Options, AbortOptions, Pin, AddOptions, Query, Status, HTTPClientExtraOptions, RemotePiningAPI };
}
import Client = require("../../lib/core");
import Service = require("./service");
import { CID } from "multiformats/cid";
type Options = import('../../types').Options;
type AbortOptions = import('ipfs-core-types/src/utils').AbortOptions;
type Pin = import('ipfs-core-types/src/pin/remote').Pin;
type AddOptions = import('ipfs-core-types/src/pin/remote').AddOptions;
type Query = import('ipfs-core-types/src/pin/remote').Query;
type Status = import('ipfs-core-types/src/pin/remote').Status;
type HTTPClientExtraOptions = import('../../types').HTTPClientExtraOptions;
type RemotePiningAPI = import('ipfs-core-types/src/pin/remote').API<HTTPClientExtraOptions>;
//# sourceMappingURL=index.d.ts.map