ipfs-http-client/dist/src/pin/index.d.ts

A client library for the IPFS HTTP API

/**
 * @param {import('../types').Options} config
 */
export function createPin(config: import('../types').Options): {
    addAll: (source: import("ipfs-core-types").AwaitIterable<import("ipfs-core-types/src/pin/index.js").AddInput>, options?: (import("ipfs-core-types/src/pin/index.js").AddAllOptions & import("../types").HTTPClientExtraOptions) | undefined) => AsyncIterable<import("multiformats").CID<unknown, number, number, import("multiformats").Version>>;
    add: (cid: string | import("multiformats").CID<unknown, number, number, import("multiformats").Version>, options?: (import("ipfs-core-types/src/pin/index.js").AddOptions & import("../types").HTTPClientExtraOptions) | undefined) => Promise<import("multiformats").CID<unknown, number, number, import("multiformats").Version>>;
    ls: (options?: (import("ipfs-core-types/src/pin/index.js").LsOptions & import("../types").HTTPClientExtraOptions) | undefined) => AsyncIterable<import("ipfs-core-types/src/pin/index.js").LsResult>;
    rmAll: (source: import("ipfs-core-types").AwaitIterable<import("ipfs-core-types/src/pin/index.js").RmAllInput>, options?: (import("ipfs-core-types").AbortOptions & import("../types").HTTPClientExtraOptions) | undefined) => AsyncIterable<import("multiformats").CID<unknown, number, number, import("multiformats").Version>>;
    rm: (ipfsPath: string | import("multiformats").CID<unknown, number, number, import("multiformats").Version>, options?: (import("ipfs-core-types/src/pin/index.js").RmOptions & import("../types").HTTPClientExtraOptions) | undefined) => Promise<import("multiformats").CID<unknown, number, number, import("multiformats").Version>>;
    remote: {
        add: (cid: import("multiformats").CID<unknown, number, number, import("multiformats").Version>, options: import("ipfs-core-types/src/pin/remote/index.js").AddOptions & import("ipfs-core-types").AbortOptions & import("../types").HTTPClientExtraOptions) => Promise<import("ipfs-core-types/src/pin/remote/index.js").Pin>;
        ls: (query: import("ipfs-core-types/src/pin/remote/index.js").Query & import("ipfs-core-types").AbortOptions & import("../types").HTTPClientExtraOptions) => AsyncIterable<import("ipfs-core-types/src/pin/remote/index.js").Pin>;
        rm: (query: import("ipfs-core-types/src/pin/remote/index.js").Query & import("ipfs-core-types").AbortOptions & import("../types").HTTPClientExtraOptions) => Promise<void>;
        rmAll: (query: import("ipfs-core-types/src/pin/remote/index.js").Query & import("ipfs-core-types").AbortOptions & import("../types").HTTPClientExtraOptions) => Promise<void>;
        service: {
            add: (name: string, credentials: import("ipfs-core-types/src/pin/remote/service/index.js").Credentials & import("ipfs-core-types").AbortOptions & import("../types").HTTPClientExtraOptions) => Promise<void>;
            ls: (options?: {}) => Promise<import("ipfs-core-types/src/pin/remote/service/index.js").RemotePinServiceWithStat[]>;
            rm: (name: string, options?: (import("ipfs-core-types").AbortOptions & import("../types").HTTPClientExtraOptions) | undefined) => Promise<void>;
        };
    };
};
//# sourceMappingURL=index.d.ts.map