ts / dist / cjs / pins.d.ts
316 words
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
/**
 * The standard IPFS Pinning Service API (1.0.0) served at /pins — the same
 * pins as `ipfs` but with the spec's `{ count, results }` envelope and
 * requestid addressing, so standard tooling works:
 *   ipfs pin remote service add ird https://api.ird.ro ird_...
 * Use `ipfs` for the richer native API.
 */
import type { Client } from './client.js';
import type { Body, Query } from './types.js';
/** GET /pins — List pin objects. */
export declare const list: (client: Client, query?: Query<"/pins", "get">) => Promise<{
    count: number;
    results: {
        created: string;
        delegates: string[];
        info: {
            [key: string]: string;
        };
        pin: {
            cid: string;
            meta?: {
                [key: string]: string;
            };
            name?: string;
            origins?: string[];
        };
        requestid: string;
        status: "queued" | "pinning" | "pinned" | "failed";
    }[];
}>;
/** POST /pins — Add a pin (202). */
export declare const add: (client: Client, body: Body<"/pins", "post">) => Promise<{
    created: string;
    delegates: string[];
    info: {
        [key: string]: string;
    };
    pin: {
        cid: string;
        meta?: {
            [key: string]: string;
        };
        name?: string;
        origins?: string[];
    };
    requestid: string;
    status: "queued" | "pinning" | "pinned" | "failed";
}>;
/** GET /pins/{requestid} — Pin object. */
export declare const get: (client: Client, requestid: string) => Promise<{
    created: string;
    delegates: string[];
    info: {
        [key: string]: string;
    };
    pin: {
        cid: string;
        meta?: {
            [key: string]: string;
        };
        name?: string;
        origins?: string[];
    };
    requestid: string;
    status: "queued" | "pinning" | "pinned" | "failed";
}>;
/** POST /pins/{requestid} — Replace a pin (202). */
export declare const replace: (client: Client, requestid: string, body: Body<"/pins/{requestid}", "post">) => Promise<{
    created: string;
    delegates: string[];
    info: {
        [key: string]: string;
    };
    pin: {
        cid: string;
        meta?: {
            [key: string]: string;
        };
        name?: string;
        origins?: string[];
    };
    requestid: string;
    status: "queued" | "pinning" | "pinned" | "failed";
}>;
/** DELETE /pins/{requestid} — Remove a pin (202). */
export declare const remove: (client: Client, requestid: string) => Promise<Record<string, never>>;

static mirror of HEAD · about · clone: git clone https://ird.cod-sursa.ro/ts.git