@ethersphere/bee-js 7.1.0 → 7.1.2

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.
@@ -38,7 +38,7 @@ export declare class Bee {
38
38
  * @param options Additional options like tag, encryption, pinning, content-type and request options
39
39
  *
40
40
  * @returns reference is a content hash of the data
41
- * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/access-the-swarm/upload-and-download)
41
+ * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download)
42
42
  * @see [Bee API reference - `POST /bytes`](https://docs.ethswarm.org/api/#tag/Bytes/paths/~1bytes/post)
43
43
  */
44
44
  uploadData(postageBatchId: string | BatchId, data: string | Uint8Array, options?: UploadOptions & UploadRedundancyOptions, requestOptions?: BeeRequestOptions): Promise<UploadResult>;
@@ -49,7 +49,7 @@ export declare class Bee {
49
49
  * @param options Options that affects the request behavior
50
50
  * @throws TypeError if some of the input parameters is not expected type
51
51
  * @throws BeeArgumentError if there is passed ENS domain with invalid unicode characters
52
- * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/access-the-swarm/upload-and-download)
52
+ * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download)
53
53
  * @see [Bee API reference - `GET /bytes`](https://docs.ethswarm.org/api/#tag/Bytes/paths/~1bytes~1{reference}/get)
54
54
  */
55
55
  downloadData(reference: ReferenceOrEns | string, options?: BeeRequestOptions): Promise<Data>;
@@ -60,7 +60,7 @@ export declare class Bee {
60
60
  * @param options Options that affects the request behavior
61
61
  * @throws TypeError if some of the input parameters is not expected type
62
62
  * @throws BeeArgumentError if there is passed ENS domain with invalid unicode characters
63
- * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/access-the-swarm/upload-and-download)
63
+ * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download)
64
64
  * @see [Bee API reference - `GET /bytes`](https://docs.ethswarm.org/api/#tag/Bytes/paths/~1bytes~1{reference}/get)
65
65
  */
66
66
  downloadReadableData(reference: ReferenceOrEns | string, options?: BeeRequestOptions): Promise<ReadableStream<Uint8Array>>;
@@ -72,7 +72,7 @@ export declare class Bee {
72
72
  * @param options Additional options like tag, encryption, pinning, content-type and request options
73
73
  *
74
74
  * @returns reference is a content hash of the data
75
- * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/access-the-swarm/upload-and-download)
75
+ * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download)
76
76
  * @see [Bee API reference - `POST /chunks`](https://docs.ethswarm.org/api/#tag/Chunk/paths/~1chunks/post)
77
77
  */
78
78
  uploadChunk(postageBatchId: string | BatchId, data: Uint8Array, options?: UploadOptions, requestOptions?: BeeRequestOptions): Promise<Reference>;
@@ -83,8 +83,8 @@ export declare class Bee {
83
83
  * @param options Options that affects the request behavior
84
84
  * @throws TypeError if some of the input parameters is not expected type
85
85
  * @throws BeeArgumentError if there is passed ENS domain with invalid unicode characters
86
- * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/access-the-swarm/upload-and-download)
87
- * @see [Bee API reference - `GET /chunks`](https://docs.ethswarm.org/api/#tag/Chunk/paths/~1chunks~1{reference}/get)
86
+ * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download)
87
+ * @see [Bee API reference - `GET /chunks`](https://docs.ethswarm.org/api/#tag/Chunk/paths/~1chunks~1{address}/get)
88
88
  */
89
89
  downloadChunk(reference: ReferenceOrEns | string, options?: BeeRequestOptions): Promise<Data>;
90
90
  /**
@@ -98,9 +98,9 @@ export declare class Bee {
98
98
  * @param name Optional name of the uploaded file
99
99
  * @param options Additional options like tag, encryption, pinning, content-type and request options
100
100
  *
101
- * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive)
102
- * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/access-the-swarm/upload-and-download)
103
- * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/File/paths/~1bzz/post)
101
+ * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive)
102
+ * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download)
103
+ * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post)
104
104
  * @returns reference is a content hash of the file
105
105
  */
106
106
  uploadFile(postageBatchId: string | BatchId, data: string | Uint8Array | Readable | File, name?: string, options?: FileUploadOptions & UploadRedundancyOptions, requestOptions?: BeeRequestOptions): Promise<UploadResultWithCid>;
@@ -113,8 +113,8 @@ export declare class Bee {
113
113
  * @throws TypeError if some of the input parameters is not expected type
114
114
  * @throws BeeArgumentError if there is passed ENS domain with invalid unicode characters
115
115
  * @see Data
116
- * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/access-the-swarm/upload-and-download)
117
- * @see [Bee API reference - `GET /bzz`](https://docs.ethswarm.org/api/#tag/Collection/paths/~1bzz~1{reference}~1{path}/get)
116
+ * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download)
117
+ * @see [Bee API reference - `GET /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz~1%7Breference%7D~1%7Bpath%7D/get)
118
118
  */
119
119
  downloadFile(reference: ReferenceCidOrEns | string, path?: string, options?: BeeRequestOptions): Promise<FileData<Data>>;
120
120
  /**
@@ -126,8 +126,8 @@ export declare class Bee {
126
126
  * @throws TypeError if some of the input parameters is not expected type
127
127
  * @throws BeeArgumentError if there is passed ENS domain with invalid unicode characters
128
128
  *
129
- * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/access-the-swarm/upload-and-download)
130
- * @see [Bee API reference - `GET /bzz`](https://docs.ethswarm.org/api/#tag/Collection/paths/~1bzz~1{reference}~1{path}/get)
129
+ * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download)
130
+ * @see [Bee API reference - `GET /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz~1%7Breference%7D~1%7Bpath%7D/get)
131
131
  */
132
132
  downloadReadableFile(reference: ReferenceCidOrEns | string, path?: string, options?: BeeRequestOptions): Promise<FileData<ReadableStream<Uint8Array>>>;
133
133
  /**
@@ -142,9 +142,9 @@ export declare class Bee {
142
142
  * @param fileList list of files to be uploaded
143
143
  * @param options Additional options like tag, encryption, pinning and request options
144
144
  *
145
- * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive)
146
- * @see [Bee docs - Upload directory](https://docs.ethswarm.org/docs/access-the-swarm/upload-a-directory/)
147
- * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/Collection/paths/~1bzz/post)
145
+ * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive)
146
+ * @see [Bee docs - Upload directory](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download#upload-a-directory)
147
+ * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post)
148
148
  */
149
149
  uploadFiles(postageBatchId: string | BatchId, fileList: FileList | File[], options?: CollectionUploadOptions & UploadRedundancyOptions, requestOptions?: BeeRequestOptions): Promise<UploadResultWithCid>;
150
150
  /**
@@ -170,16 +170,16 @@ export declare class Bee {
170
170
  * @param dir the path of the files to be uploaded
171
171
  * @param options Additional options like tag, encryption, pinning and request options
172
172
  *
173
- * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive)
174
- * @see [Bee docs - Upload directory](https://docs.ethswarm.org/docs/access-the-swarm/upload-a-directory/)
175
- * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/Collection/paths/~1bzz/post)
173
+ * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive)
174
+ * @see [Bee docs - Upload directory](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download#upload-a-directory)
175
+ * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post)
176
176
  */
177
177
  uploadFilesFromDirectory(postageBatchId: string | BatchId, dir: string, options?: CollectionUploadOptions & UploadRedundancyOptions, requestOptions?: BeeRequestOptions): Promise<UploadResultWithCid>;
178
178
  /**
179
179
  * Create a new Tag which is meant for tracking progres of syncing data across network.
180
180
  *
181
181
  * @param options Options that affects the request behavior
182
- * @see [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/access-the-swarm/syncing)
182
+ * @see [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/develop/access-the-swarm/syncing)
183
183
  * @see [Bee API reference - `POST /tags`](https://docs.ethswarm.org/api/#tag/Tag/paths/~1tags/post)
184
184
  */
185
185
  createTag(options?: BeeRequestOptions): Promise<Tag>;
@@ -192,7 +192,7 @@ export declare class Bee {
192
192
  * @throws TypeError if limit or offset are not numbers or undefined
193
193
  * @throws BeeArgumentError if limit or offset have invalid options
194
194
  *
195
- * @see [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/access-the-swarm/syncing)
195
+ * @see [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/develop/access-the-swarm/syncing)
196
196
  * @see [Bee API reference - `GET /tags`](https://docs.ethswarm.org/api/#tag/Tag/paths/~1tags/get)
197
197
  */
198
198
  getAllTags(options?: AllTagsOptions): Promise<Tag[]>;
@@ -203,7 +203,7 @@ export declare class Bee {
203
203
  * @param options Options that affects the request behavior
204
204
  * @throws TypeError if tagUid is in not correct format
205
205
  *
206
- * @see [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/access-the-swarm/syncing)
206
+ * @see [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/develop/access-the-swarm/syncing)
207
207
  * @see [Bee API reference - `GET /tags/{uid}`](https://docs.ethswarm.org/api/#tag/Tag/paths/~1tags~1{uid}/get)
208
208
  *
209
209
  */
@@ -216,7 +216,7 @@ export declare class Bee {
216
216
  * @throws TypeError if tagUid is in not correct format
217
217
  * @throws BeeResponse error if something went wrong on the Bee node side while deleting the tag.
218
218
  *
219
- * @see [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/access-the-swarm/syncing)
219
+ * @see [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/develop/access-the-swarm/syncing)
220
220
  * @see [Bee API reference - `DELETE /tags/{uid}`](https://docs.ethswarm.org/api/#tag/Tag/paths/~1tags~1{uid}/delete)
221
221
  */
222
222
  deleteTag(tagUid: number | Tag, options?: BeeRequestOptions): Promise<void>;
@@ -232,7 +232,7 @@ export declare class Bee {
232
232
  * @throws TypeError if tagUid is in not correct format
233
233
  * @throws BeeResponse error if something went wrong on the Bee node side while deleting the tag.
234
234
  *
235
- * @see [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/access-the-swarm/syncing)
235
+ * @see [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/develop/access-the-swarm/syncing)
236
236
  * @see [Bee API reference - `PATCH /tags/{uid}`](https://docs.ethswarm.org/api/#tag/Tag/paths/~1tags~1{uid}/patch)
237
237
  */
238
238
  updateTag(tagUid: number | Tag, reference: Reference | string, options?: BeeRequestOptions): Promise<void>;
@@ -243,7 +243,7 @@ export declare class Bee {
243
243
  * @param options Options that affects the request behavior
244
244
  * @throws TypeError if reference is in not correct format
245
245
  *
246
- * @see [Bee docs - Pinning](https://docs.ethswarm.org/docs/access-the-swarm/pinning)
246
+ * @see [Bee docs - Pinning](https://docs.ethswarm.org/docs/develop/access-the-swarm/pinning)
247
247
  */
248
248
  pin(reference: Reference | string, options?: BeeRequestOptions): Promise<void>;
249
249
  /**
@@ -253,14 +253,14 @@ export declare class Bee {
253
253
  * @param options Options that affects the request behavior
254
254
  * @throws TypeError if reference is in not correct format
255
255
  *
256
- * @see [Bee docs - Pinning](https://docs.ethswarm.org/docs/access-the-swarm/pinning)
256
+ * @see [Bee docs - Pinning](https://docs.ethswarm.org/docs/develop/access-the-swarm/pinning)
257
257
  */
258
258
  unpin(reference: Reference | string, options?: BeeRequestOptions): Promise<void>;
259
259
  /**
260
260
  * Get list of all locally pinned references
261
261
  *
262
262
  * @param options Options that affects the request behavior
263
- * @see [Bee docs - Pinning](https://docs.ethswarm.org/docs/access-the-swarm/pinning)
263
+ * @see [Bee docs - Pinning](https://docs.ethswarm.org/docs/develop/access-the-swarm/pinning)
264
264
  */
265
265
  getAllPins(options?: BeeRequestOptions): Promise<Reference[]>;
266
266
  /**
@@ -271,7 +271,7 @@ export declare class Bee {
271
271
  * @throws TypeError if some of the input parameters is not expected type
272
272
  * @throws BeeArgumentError if there is passed ENS domain with invalid unicode characters
273
273
  *
274
- * @see [Bee docs - Pinning](https://docs.ethswarm.org/docs/access-the-swarm/pinning)
274
+ * @see [Bee docs - Pinning](https://docs.ethswarm.org/docs/develop/access-the-swarm/pinning)
275
275
  */
276
276
  getPin(reference: Reference | string, options?: BeeRequestOptions): Promise<Pin>;
277
277
  /**
@@ -332,7 +332,7 @@ export declare class Bee {
332
332
  * @param options Options that affects the request behavior
333
333
  * @throws TypeError if `data`, `batchId`, `target` or `recipient` are in invalid format
334
334
  *
335
- * @see [Bee docs - PSS](https://docs.ethswarm.org/docs/dapps-on-swarm/pss)
335
+ * @see [Bee docs - PSS](https://docs.ethswarm.org/docs/develop/tools-and-features/pss)
336
336
  * @see [Bee API reference - `POST /pss`](https://docs.ethswarm.org/api/#tag/Postal-Service-for-Swarm/paths/~1pss~1send~1{topic}~1{targets}/post)
337
337
  */
338
338
  pssSend(postageBatchId: string | BatchId, topic: string, target: AddressPrefix, data: string | Uint8Array, recipient?: string | PublicKey, options?: BeeRequestOptions): Promise<void>;
@@ -347,7 +347,7 @@ export declare class Bee {
347
347
  *
348
348
  * @returns Subscription to a given topic
349
349
  *
350
- * @see [Bee docs - PSS](https://docs.ethswarm.org/docs/dapps-on-swarm/pss)
350
+ * @see [Bee docs - PSS](https://docs.ethswarm.org/docs/develop/tools-and-features/pss)
351
351
  * @see [Bee API reference - `GET /pss`](https://docs.ethswarm.org/api/#tag/Postal-Service-for-Swarm/paths/~1pss~1subscribe~1{topic}/get)
352
352
  */
353
353
  pssSubscribe(topic: string, handler: PssMessageHandler): PssSubscription;
@@ -372,7 +372,7 @@ export declare class Bee {
372
372
  *
373
373
  * @returns Message in byte array
374
374
  *
375
- * @see [Bee docs - PSS](https://docs.ethswarm.org/docs/dapps-on-swarm/pss)
375
+ * @see [Bee docs - PSS](https://docs.ethswarm.org/docs/develop/tools-and-features/pss)
376
376
  * @see [Bee API reference - `GET /pss`](https://docs.ethswarm.org/api/#tag/Postal-Service-for-Swarm/paths/~1pss~1subscribe~1{topic}/get)
377
377
  */
378
378
  pssReceive(topic: string, timeoutMsec?: number): Promise<Data>;
@@ -387,7 +387,7 @@ export declare class Bee {
387
387
  * @param owner Owner's ethereum address in hex or bytes
388
388
  * @param options Options that affects the request behavior
389
389
  *
390
- * @see [Bee docs - Feeds](https://docs.ethswarm.org/docs/dapps-on-swarm/feeds)
390
+ * @see [Bee docs - Feeds](https://docs.ethswarm.org/docs/develop/tools-and-features/feeds)
391
391
  * @see [Bee API reference - `POST /feeds`](https://docs.ethswarm.org/api/#tag/Feed/paths/~1feeds~1{owner}~1{topic}/post)
392
392
  */
393
393
  createFeedManifest(postageBatchId: string | BatchId, type: FeedType, topic: Topic | Uint8Array | string, owner: EthAddress | Uint8Array | string, options?: BeeRequestOptions): Promise<FeedManifestResult>;
@@ -399,7 +399,7 @@ export declare class Bee {
399
399
  * @param owner Owner's ethereum address in hex or bytes
400
400
  * @param options Options that affects the request behavior
401
401
  *
402
- * @see [Bee docs - Feeds](https://docs.ethswarm.org/docs/dapps-on-swarm/feeds)
402
+ * @see [Bee docs - Feeds](https://docs.ethswarm.org/docs/develop/tools-and-features/feeds)
403
403
  */
404
404
  makeFeedReader(type: FeedType, topic: Topic | Uint8Array | string, owner: EthAddress | Uint8Array | string, options?: BeeRequestOptions): FeedReader;
405
405
  /**
@@ -410,7 +410,7 @@ export declare class Bee {
410
410
  * @param signer The signer's private key or a Signer instance that can sign data
411
411
  * @param options Options that affects the request behavior
412
412
  *
413
- * @see [Bee docs - Feeds](https://docs.ethswarm.org/docs/dapps-on-swarm/feeds)
413
+ * @see [Bee docs - Feeds](https://docs.ethswarm.org/docs/develop/tools-and-features/feeds)
414
414
  */
415
415
  makeFeedWriter(type: FeedType, topic: Topic | Uint8Array | string, signer?: Signer | Uint8Array | string, options?: BeeRequestOptions): FeedWriter;
416
416
  /**
@@ -429,7 +429,7 @@ export declare class Bee {
429
429
  *
430
430
  * @throws BeeError if `options.signer` is not specified nor the default Signer on Bee's instance is specified.
431
431
  *
432
- * @see [Bee docs - Feeds](https://docs.ethswarm.org/docs/dapps-on-swarm/feeds)
432
+ * @see [Bee docs - Feeds](https://docs.ethswarm.org/docs/develop/tools-and-features/feeds)
433
433
  */
434
434
  setJsonFeed<T extends AnyJson>(postageBatchId: string | BatchId, topic: string, data: T, options?: JsonFeedOptions, requestOptions?: BeeRequestOptions): Promise<Reference>;
435
435
  /**
@@ -449,7 +449,7 @@ export declare class Bee {
449
449
  * @param options.address Ethereum address of owner of the feed that signed it. This option is exclusive with `signer` option.
450
450
  * @param options.type Type of Feed
451
451
  *
452
- * @see [Bee docs - Feeds](https://docs.ethswarm.org/docs/dapps-on-swarm/feeds)
452
+ * @see [Bee docs - Feeds](https://docs.ethswarm.org/docs/develop/tools-and-features/feeds)
453
453
  */
454
454
  getJsonFeed<T extends AnyJson>(topic: string, options?: JsonFeedOptions): Promise<T>;
455
455
  /**
@@ -466,7 +466,7 @@ export declare class Bee {
466
466
  *
467
467
  * @param ownerAddress The ethereum address of the owner
468
468
  * @param options Options that affects the request behavior
469
- * @see [Bee docs - Chunk Types](https://docs.ethswarm.org/docs/dapps-on-swarm/chunk-types#single-owner-chunks)
469
+ * @see [Bee docs - Chunk Types](https://docs.ethswarm.org/docs/develop/tools-and-features/chunk-types#single-owner-chunks)
470
470
  */
471
471
  makeSOCReader(ownerAddress: EthAddress | Uint8Array | string, options?: BeeRequestOptions): SOCReader;
472
472
  /**
@@ -474,7 +474,7 @@ export declare class Bee {
474
474
  *
475
475
  * @param signer The signer's private key or a Signer instance that can sign data
476
476
  * @param options Options that affects the request behavior
477
- * @see [Bee docs - Chunk Types](https://docs.ethswarm.org/docs/dapps-on-swarm/chunk-types#single-owner-chunks)
477
+ * @see [Bee docs - Chunk Types](https://docs.ethswarm.org/docs/develop/tools-and-features/chunk-types#single-owner-chunks)
478
478
  */
479
479
  makeSOCWriter(signer?: Signer | Uint8Array | string, options?: BeeRequestOptions): SOCWriter;
480
480
  /**
@@ -499,7 +499,7 @@ export declare class Bee {
499
499
  * @param tagUid UID or tag object to be retrieved
500
500
  * @throws TypeError if tagUid is in not correct format
501
501
  *
502
- * @see [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/access-the-swarm/syncing)
502
+ * @see [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/develop/access-the-swarm/syncing)
503
503
  * @see [Bee API reference - `GET /tags/{uid}`](https://docs.ethswarm.org/debug-api/#tag/Tag)
504
504
  *
505
505
  */
@@ -670,7 +670,7 @@ export declare class Bee {
670
670
  * Creates new postage batch from the funds that the node has available in its Ethereum account.
671
671
  *
672
672
  * For better understanding what each parameter means and what are the optimal values please see
673
- * [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive).
673
+ * [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction#keep-your-data-alive).
674
674
  *
675
675
  * **WARNING: THIS CREATES TRANSACTIONS THAT SPENDS MONEY**
676
676
  *
@@ -680,7 +680,7 @@ export declare class Bee {
680
680
  * @throws BeeArgumentError when negative amount or depth is specified
681
681
  * @throws TypeError if non-integer value is passed to amount or depth
682
682
  *
683
- * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive)
683
+ * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive)
684
684
  * @see [Bee Debug API reference - `POST /stamps`](https://docs.ethswarm.org/debug-api/#tag/Postage-Stamps/paths/~1stamps~1{amount}~1{depth}/post)
685
685
  */
686
686
  createPostageBatch(amount: NumberString, depth: number, options?: PostageBatchOptions, requestOptions?: BeeRequestOptions): Promise<BatchId>;
@@ -688,7 +688,7 @@ export declare class Bee {
688
688
  * Topup a fresh amount of BZZ to given Postage Batch.
689
689
  *
690
690
  * For better understanding what each parameter means and what are the optimal values please see
691
- * [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive).
691
+ * [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive).
692
692
  *
693
693
  * **WARNING: THIS CREATES TRANSACTIONS THAT SPENDS MONEY**
694
694
  *
@@ -696,7 +696,7 @@ export declare class Bee {
696
696
  * @param amount Amount to be added to the batch
697
697
  * @param options Request options
698
698
  *
699
- * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive)
699
+ * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive)
700
700
  * @see [Bee Debug API reference - `PATCH /stamps/topup/${id}/${amount}`](https://docs.ethswarm.org/debug-api/#tag/Postage-Stamps/paths/~1stamps~1topup~1{id}~1{amount}/patch)
701
701
  */
702
702
  topUpBatch(postageBatchId: BatchId | string, amount: NumberString, options?: BeeRequestOptions): Promise<void>;
@@ -705,7 +705,7 @@ export declare class Bee {
705
705
  * the Postage Batch to be used for more chunks.
706
706
  *
707
707
  * For better understanding what each parameter means and what are the optimal values please see
708
- * [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive).
708
+ * [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive).
709
709
  *
710
710
  * **WARNING: THIS CREATES TRANSACTIONS THAT SPENDS MONEY**
711
711
  *
@@ -713,7 +713,7 @@ export declare class Bee {
713
713
  * @param depth Amount to be added to the batch
714
714
  * @param options Request options
715
715
  *
716
- * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive)
716
+ * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive)
717
717
  * @see [Bee Debug API reference - `PATCH /stamps/topup/${id}/${amount}`](https://docs.ethswarm.org/debug-api/#tag/Postage-Stamps/paths/~1stamps~1topup~1{id}~1{amount}/patch)
718
718
  */
719
719
  diluteBatch(postageBatchId: BatchId | string, depth: number, options?: BeeRequestOptions): Promise<void>;
@@ -722,7 +722,7 @@ export declare class Bee {
722
722
  *
723
723
  * @param postageBatchId Batch ID
724
724
  *
725
- * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive)
725
+ * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive)
726
726
  * @see [Bee Debug API reference - `GET /stamps/${id}`](https://docs.ethswarm.org/debug-api/#tag/Postage-Stamps/paths/~1stamps~1{id}/get)
727
727
  */
728
728
  getPostageBatch(postageBatchId: BatchId | string, options?: BeeRequestOptions): Promise<PostageBatch>;
@@ -731,14 +731,14 @@ export declare class Bee {
731
731
  *
732
732
  * @param postageBatchId Batch ID
733
733
  *
734
- * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive)
734
+ * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive)
735
735
  * @see [Bee Debug API reference - `GET /stamps/${id}/buckets`](https://docs.ethswarm.org/debug-api/#tag/Postage-Stamps/paths/~1stamps~1{id}~1buckets/get)
736
736
  */
737
737
  getPostageBatchBuckets(postageBatchId: BatchId | string, options?: BeeRequestOptions): Promise<PostageBatchBuckets>;
738
738
  /**
739
739
  * Return all postage batches that has the node available.
740
740
  *
741
- * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/access-the-swarm/keep-your-data-alive)
741
+ * @see [Bee docs - Keep your data alive / Postage stamps](https://docs.ethswarm.org/docs/develop/access-the-swarm/introduction/#keep-your-data-alive)
742
742
  * @see [Bee Debug API reference - `GET /stamps`](https://docs.ethswarm.org/debug-api/#tag/Postage-Stamps/paths/~1stamps/get)
743
743
  */
744
744
  getAllPostageBatch(options?: BeeRequestOptions): Promise<PostageBatch[]>;
@@ -3,7 +3,7 @@ import { NumberString, PublicKey, Reference, TransactionHash } from './index';
3
3
  /**
4
4
  * Object that contains information about progress of upload of data to network.
5
5
  *
6
- * @see [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/access-the-swarm/syncing)
6
+ * @see [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/develop/access-the-swarm/syncing)
7
7
  */
8
8
  export interface ExtendedTag {
9
9
  /**
@@ -177,13 +177,13 @@ export interface NodeInfo {
177
177
  /**
178
178
  * Indicates whether the Bee node has its own deployed chequebook.
179
179
  *
180
- * @see [Bee docs - Chequebook](https://docs.ethswarm.org/docs/introduction/terminology#cheques--chequebook)
180
+ * @see [Bee docs - Chequebook](https://docs.ethswarm.org/docs/learn/glossary#cheques--chequebook)
181
181
  */
182
182
  chequebookEnabled: boolean;
183
183
  /**
184
184
  * Indicates whether SWAP is enabled for the Bee node.
185
185
  *
186
- * @see [Bee docs - SWAP](https://docs.ethswarm.org/docs/introduction/terminology#swap)
186
+ * @see [Bee docs - SWAP](https://docs.ethswarm.org/docs/learn/glossary#swap)
187
187
  */
188
188
  swapEnabled: boolean;
189
189
  }
@@ -43,7 +43,7 @@ export declare const FEED_INDEX_HEX_LENGTH = 16;
43
43
  *
44
44
  * Encrypted reference consists of two parts. The reference address itself (like non-encrypted reference) and decryption key.
45
45
  *
46
- * @see [Bee docs - Store with Encryption](https://docs.ethswarm.org/docs/access-the-swarm/store-with-encryption)
46
+ * @see [Bee docs - Store with Encryption](https://docs.ethswarm.org/docs/develop/access-the-swarm/store-with-encryption)
47
47
  */
48
48
  export type Reference = HexString<typeof REFERENCE_HEX_LENGTH> | HexString<typeof ENCRYPTED_REFERENCE_HEX_LENGTH>;
49
49
  /**
@@ -109,23 +109,23 @@ export interface UploadOptions {
109
109
  *
110
110
  * Locally pinned data is possible to reupload to network if it disappear.
111
111
  *
112
- * @see [Bee docs - Pinning](https://docs.ethswarm.org/docs/access-the-swarm/pinning)
113
- * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/Collection/paths/~1bzz/post)
112
+ * @see [Bee docs - Pinning](https://docs.ethswarm.org/docs/develop/access-the-swarm/pinning)
113
+ * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post)
114
114
  */
115
115
  pin?: boolean;
116
116
  /**
117
117
  * Will encrypt the uploaded data and return longer hash which also includes the decryption key.
118
118
  *
119
- * @see [Bee docs - Store with Encryption](https://docs.ethswarm.org/docs/access-the-swarm/store-with-encryption)
120
- * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/Collection/paths/~1bzz/post)
119
+ * @see [Bee docs - Store with Encryption](https://docs.ethswarm.org/docs/develop/access-the-swarm/store-with-encryption)
120
+ * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post)
121
121
  * @see Reference
122
122
  */
123
123
  encrypt?: boolean;
124
124
  /**
125
125
  * Tags keep track of syncing the data with network. This option allows attach existing Tag UUID to the uploaded data.
126
126
  *
127
- * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/Collection/paths/~1bzz/post)
128
- * @see [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/access-the-swarm/syncing)
127
+ * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post)
128
+ * @see [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/develop/access-the-swarm/syncing)
129
129
  * @link Tag
130
130
  */
131
131
  tag?: number;
@@ -189,13 +189,13 @@ export interface FileUploadOptions extends UploadOptions {
189
189
  /**
190
190
  * Specifies Content-Length for the given data. It is required when uploading with Readable.
191
191
  *
192
- * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/File)
192
+ * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post)
193
193
  */
194
194
  size?: number;
195
195
  /**
196
196
  * Specifies given Content-Type so when loaded in browser the file is correctly represented.
197
197
  *
198
- * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/File)
198
+ * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post)
199
199
  */
200
200
  contentType?: string;
201
201
  }
@@ -203,15 +203,15 @@ export interface CollectionUploadOptions extends UploadOptions {
203
203
  /**
204
204
  * Default file to be returned when the root hash of collection is accessed.
205
205
  *
206
- * @see [Bee docs - Upload a directory](https://docs.ethswarm.org/docs/access-the-swarm/upload-a-directory)
207
- * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/File)
206
+ * @see [Bee docs - Upload a directory](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download#upload-a-directory)
207
+ * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post)
208
208
  */
209
209
  indexDocument?: string;
210
210
  /**
211
211
  * Configure custom error document to be returned when a specified path can not be found in collection.
212
212
  *
213
- * @see [Bee docs - Upload a directory](https://docs.ethswarm.org/docs/access-the-swarm/upload-a-directory)
214
- * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/File)
213
+ * @see [Bee docs - Upload a directory](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download#upload-a-directory)
214
+ * @see [Bee API reference - `POST /bzz`](https://docs.ethswarm.org/api/#tag/BZZ/paths/~1bzz/post)
215
215
  */
216
216
  errorDocument?: string;
217
217
  }
@@ -224,7 +224,7 @@ export interface UploadHeaders {
224
224
  /**
225
225
  * Object that contains infromation about progress of upload of data to network.
226
226
  *
227
- * @see [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/access-the-swarm/syncing)
227
+ * @see [Bee docs - Syncing / Tags](https://docs.ethswarm.org/docs/develop/access-the-swarm/syncing)
228
228
  */
229
229
  export interface Tag {
230
230
  /**
@@ -4,6 +4,6 @@ import { AddressPrefix } from '../types';
4
4
  * target that Bee node will except.
5
5
  *
6
6
  * @param target is a non-prefixed hex string Bee address
7
- * @see [Bee docs - PSS](https://docs.ethswarm.org/docs/dapps-on-swarm/pss)
7
+ * @see [Bee docs - PSS](https://docs.ethswarm.org/docs/develop/tools-and-features/pss)
8
8
  */
9
9
  export declare function makeMaxTarget(target: string): AddressPrefix;
@@ -2,7 +2,7 @@ export declare class TarStream {
2
2
  pieces: Uint8Array[];
3
3
  currentFileSize: number;
4
4
  get output(): Uint8Array;
5
- beginFile(path: string, size: number): Promise<void>;
5
+ beginFile(path: string, size: number): void;
6
6
  appendFile(data: Uint8Array): Promise<void>;
7
7
  endFile(): Promise<void>;
8
8
  end(): Promise<void>;
@@ -3,7 +3,7 @@ import { PassThrough } from 'stream';
3
3
  export declare class TarStream {
4
4
  output: PassThrough;
5
5
  currentFileSize: number;
6
- beginFile(path: string, size: number): Promise<void>;
6
+ beginFile(path: string, size: number): void;
7
7
  appendFile(data: Uint8Array): Promise<void>;
8
8
  endFile(): Promise<void>;
9
9
  end(): Promise<void>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ethersphere/bee-js",
3
- "version": "7.1.0",
3
+ "version": "7.1.2",
4
4
  "description": "Javascript client for Bee",
5
5
  "keywords": [
6
6
  "bee",
@@ -97,7 +97,7 @@
97
97
  "chai-as-promised": "^7.1.1",
98
98
  "chai-parentheses": "^0.0.2",
99
99
  "cross-env": "^7.0.3",
100
- "depcheck": "^1.4.3",
100
+ "depcheck": "^1.4.7",
101
101
  "eslint": "^8.13.0",
102
102
  "eslint-config-prettier": "^8.5.0",
103
103
  "eslint-plugin-prettier": "^4.0.0",