@helia/interface 2.0.0-4b4bf37 → 2.0.0-51316ba
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/src/index.d.ts +3 -3
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/pins.d.ts +4 -4
- package/dist/src/pins.d.ts.map +1 -1
- package/package.json +3 -2
- package/src/index.ts +3 -3
- package/src/pins.ts +4 -4
package/dist/src/index.d.ts
CHANGED
|
@@ -43,15 +43,15 @@ export interface Helia<T = Libp2p> {
|
|
|
43
43
|
/**
|
|
44
44
|
* Starts the Helia node
|
|
45
45
|
*/
|
|
46
|
-
start
|
|
46
|
+
start(): Promise<void>;
|
|
47
47
|
/**
|
|
48
48
|
* Stops the Helia node
|
|
49
49
|
*/
|
|
50
|
-
stop
|
|
50
|
+
stop(): Promise<void>;
|
|
51
51
|
/**
|
|
52
52
|
* Remove any unpinned blocks from the blockstore
|
|
53
53
|
*/
|
|
54
|
-
gc
|
|
54
|
+
gc(options?: GCOptions): Promise<void>;
|
|
55
55
|
}
|
|
56
56
|
export type GcEvents = ProgressEvent<'helia:gc:deleted', CID> | ProgressEvent<'helia:gc:error', Error>;
|
|
57
57
|
export interface GCOptions extends AbortOptions, ProgressOptions<GcEvents> {
|
package/dist/src/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AACrC,OAAO,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAC7D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAErE,YAAY,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE3D;;GAEG;AACH,MAAM,WAAW,KAAK,CAAC,CAAC,GAAG,MAAM;IAC/B;;OAEG;IACH,MAAM,EAAE,CAAC,CAAA;IAET;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,SAAS,EAAE,SAAS,CAAA;IAEpB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAA;IAEV;;OAEG;IACH,KAAK,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AACrC,OAAO,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAC7D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAErE,YAAY,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE3D;;GAEG;AACH,MAAM,WAAW,KAAK,CAAC,CAAC,GAAG,MAAM;IAC/B;;OAEG;IACH,MAAM,EAAE,CAAC,CAAA;IAET;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,SAAS,EAAE,SAAS,CAAA;IAEpB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAA;IAEV;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAEtB;;OAEG;IACH,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAErB;;OAEG;IACH,EAAE,CAAC,OAAO,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACvC;AAED,MAAM,MAAM,QAAQ,GAClB,aAAa,CAAC,kBAAkB,EAAE,GAAG,CAAC,GACtC,aAAa,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAA;AAExC,MAAM,WAAW,SAAU,SAAQ,YAAY,EAAE,eAAe,CAAC,QAAQ,CAAC;CAEzE"}
|
package/dist/src/pins.d.ts
CHANGED
|
@@ -31,19 +31,19 @@ export interface Pins {
|
|
|
31
31
|
* Pin a block in the blockstore. It will not be deleted
|
|
32
32
|
* when garbage collection is run.
|
|
33
33
|
*/
|
|
34
|
-
add
|
|
34
|
+
add(cid: CID, options?: AddOptions): Promise<Pin>;
|
|
35
35
|
/**
|
|
36
36
|
* Unpin the block that corresponds to the passed CID. The block will
|
|
37
37
|
* be deleted when garbage collection is run.
|
|
38
38
|
*/
|
|
39
|
-
rm
|
|
39
|
+
rm(cid: CID, options?: RmOptions): Promise<Pin>;
|
|
40
40
|
/**
|
|
41
41
|
* List all blocks that have been pinned.
|
|
42
42
|
*/
|
|
43
|
-
ls
|
|
43
|
+
ls(options?: LsOptions): AsyncGenerator<Pin, void, undefined>;
|
|
44
44
|
/**
|
|
45
45
|
* Return true if the passed CID is pinned
|
|
46
46
|
*/
|
|
47
|
-
isPinned
|
|
47
|
+
isPinned(cid: CID, options?: IsPinnedOptions): Promise<boolean>;
|
|
48
48
|
}
|
|
49
49
|
//# sourceMappingURL=pins.d.ts.map
|
package/dist/src/pins.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pins.d.ts","sourceRoot":"","sources":["../../src/pins.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAA;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAErE,MAAM,MAAM,OAAO,GAAG,WAAW,GAAG,QAAQ,GAAG,UAAU,CAAA;AAEzD,MAAM,WAAW,GAAG;IAClB,GAAG,EAAE,GAAG,CAAA;IACR,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC9B;AAED,MAAM,MAAM,YAAY,GACtB,aAAa,CAAC,eAAe,EAAE,GAAG,CAAC,CAAA;AAErC,MAAM,WAAW,UAAW,SAAQ,YAAY,EAAE,eAAe,CAAC,YAAY,GAAG,sBAAsB,CAAC;IACtG;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAA;CACrD;AAED,MAAM,WAAW,SAAU,SAAQ,YAAY;CAE9C;AAED,MAAM,WAAW,SAAU,SAAQ,YAAY;IAC7C,GAAG,CAAC,EAAE,GAAG,CAAA;CACV;AAED,MAAM,WAAW,eAAgB,SAAQ,YAAY;CAEpD;AAED,MAAM,WAAW,IAAI;IACnB;;;OAGG;IACH,GAAG,
|
|
1
|
+
{"version":3,"file":"pins.d.ts","sourceRoot":"","sources":["../../src/pins.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAA;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAErE,MAAM,MAAM,OAAO,GAAG,WAAW,GAAG,QAAQ,GAAG,UAAU,CAAA;AAEzD,MAAM,WAAW,GAAG;IAClB,GAAG,EAAE,GAAG,CAAA;IACR,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC9B;AAED,MAAM,MAAM,YAAY,GACtB,aAAa,CAAC,eAAe,EAAE,GAAG,CAAC,CAAA;AAErC,MAAM,WAAW,UAAW,SAAQ,YAAY,EAAE,eAAe,CAAC,YAAY,GAAG,sBAAsB,CAAC;IACtG;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAA;CACrD;AAED,MAAM,WAAW,SAAU,SAAQ,YAAY;CAE9C;AAED,MAAM,WAAW,SAAU,SAAQ,YAAY;IAC7C,GAAG,CAAC,EAAE,GAAG,CAAA;CACV;AAED,MAAM,WAAW,eAAgB,SAAQ,YAAY;CAEpD;AAED,MAAM,WAAW,IAAI;IACnB;;;OAGG;IACH,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;IAEjD;;;OAGG;IACH,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;IAE/C;;OAEG;IACH,EAAE,CAAC,OAAO,CAAC,EAAE,SAAS,GAAG,cAAc,CAAC,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;IAE7D;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CAChE"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@helia/interface",
|
|
3
|
-
"version": "2.0.0-
|
|
3
|
+
"version": "2.0.0-51316ba",
|
|
4
4
|
"description": "The Helia API",
|
|
5
5
|
"license": "Apache-2.0 OR MIT",
|
|
6
6
|
"homepage": "https://github.com/ipfs/helia/tree/master/packages/interface#readme",
|
|
@@ -55,6 +55,7 @@
|
|
|
55
55
|
"eslintConfig": {
|
|
56
56
|
"extends": "ipfs",
|
|
57
57
|
"parserOptions": {
|
|
58
|
+
"project": true,
|
|
58
59
|
"sourceType": "module"
|
|
59
60
|
}
|
|
60
61
|
},
|
|
@@ -74,6 +75,6 @@
|
|
|
74
75
|
"progress-events": "^1.0.0"
|
|
75
76
|
},
|
|
76
77
|
"devDependencies": {
|
|
77
|
-
"aegir": "^
|
|
78
|
+
"aegir": "^41.0.0"
|
|
78
79
|
}
|
|
79
80
|
}
|
package/src/index.ts
CHANGED
|
@@ -50,17 +50,17 @@ export interface Helia<T = Libp2p> {
|
|
|
50
50
|
/**
|
|
51
51
|
* Starts the Helia node
|
|
52
52
|
*/
|
|
53
|
-
start
|
|
53
|
+
start(): Promise<void>
|
|
54
54
|
|
|
55
55
|
/**
|
|
56
56
|
* Stops the Helia node
|
|
57
57
|
*/
|
|
58
|
-
stop
|
|
58
|
+
stop(): Promise<void>
|
|
59
59
|
|
|
60
60
|
/**
|
|
61
61
|
* Remove any unpinned blocks from the blockstore
|
|
62
62
|
*/
|
|
63
|
-
gc
|
|
63
|
+
gc(options?: GCOptions): Promise<void>
|
|
64
64
|
}
|
|
65
65
|
|
|
66
66
|
export type GcEvents =
|
package/src/pins.ts
CHANGED
|
@@ -43,21 +43,21 @@ export interface Pins {
|
|
|
43
43
|
* Pin a block in the blockstore. It will not be deleted
|
|
44
44
|
* when garbage collection is run.
|
|
45
45
|
*/
|
|
46
|
-
add
|
|
46
|
+
add(cid: CID, options?: AddOptions): Promise<Pin>
|
|
47
47
|
|
|
48
48
|
/**
|
|
49
49
|
* Unpin the block that corresponds to the passed CID. The block will
|
|
50
50
|
* be deleted when garbage collection is run.
|
|
51
51
|
*/
|
|
52
|
-
rm
|
|
52
|
+
rm(cid: CID, options?: RmOptions): Promise<Pin>
|
|
53
53
|
|
|
54
54
|
/**
|
|
55
55
|
* List all blocks that have been pinned.
|
|
56
56
|
*/
|
|
57
|
-
ls
|
|
57
|
+
ls(options?: LsOptions): AsyncGenerator<Pin, void, undefined>
|
|
58
58
|
|
|
59
59
|
/**
|
|
60
60
|
* Return true if the passed CID is pinned
|
|
61
61
|
*/
|
|
62
|
-
isPinned
|
|
62
|
+
isPinned(cid: CID, options?: IsPinnedOptions): Promise<boolean>
|
|
63
63
|
}
|