Skip to content

Commit

Permalink
Release v2.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
achou11 committed Oct 21, 2024
1 parent 2da2a2a commit 2074687
Show file tree
Hide file tree
Showing 8 changed files with 47 additions and 119 deletions.
4 changes: 2 additions & 2 deletions docs/api/md/-internal-/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,12 @@
- [default](classes/default.md)
- [default](classes/default.md)
- [DenseIndex](classes/DenseIndex.md)
- [DriveLiveDownload](classes/DriveLiveDownload.md)
- [Hyperblobs](classes/Hyperblobs.md)
- [Hyperdrive](classes/Hyperdrive.md)
- [IconApi](classes/IconApi.md)
- [Index](classes/Index.md)
- [IndexWriter](classes/IndexWriter.md)
- [InviteApi](classes/InviteApi.md)
- [LiveDownload](classes/LiveDownload.md)
- [LocalDiscovery](classes/LocalDiscovery.md)
- [LocalPeers](classes/LocalPeers.md)
- [Logger](classes/Logger.md)
Expand All @@ -65,6 +63,7 @@
### Interfaces

- [BitmapOpts](interfaces/BitmapOpts.md)
- [BlobDownloadEvents](interfaces/BlobDownloadEvents.md)
- [BlobDownloadState](interfaces/BlobDownloadState.md)
- [Channel](interfaces/Channel.md)
- [CorestoreEvents](interfaces/CorestoreEvents.md)
Expand Down Expand Up @@ -137,6 +136,7 @@
- [PublicPeerInfo](type-aliases/PublicPeerInfo.md)
- [Range](type-aliases/Range.md)
- [RawStream](type-aliases/RawStream.md)
- [Readable](type-aliases/Readable.md)
- [ReplicationStream](type-aliases/ReplicationStream.md)
- [RoleId](type-aliases/RoleId.md)
- [SchemaName](type-aliases/SchemaName.md)
Expand Down
18 changes: 8 additions & 10 deletions docs/api/md/-internal-/classes/BlobStore.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Enable to return an object with a `block` property with number of bytes removed

### createEntryReadStream()

> **createEntryReadStream**(`driveId`, `entry`, `options`?): `Promise`\<[`BlobReadStream`](BlobReadStream.md)\>
> **createEntryReadStream**(`driveId`, `entry`, `options`?): `Promise`\<[`Readable`](../type-aliases/Readable.md)\>
Optimization for creating the blobs read stream when you have
previously read the entry from Hyperdrive using `drive.entry`
Expand All @@ -79,13 +79,13 @@ Set to `true` to wait for a blob to download, otherwise will throw if blob is no

#### Returns

`Promise`\<[`BlobReadStream`](BlobReadStream.md)\>
`Promise`\<[`Readable`](../type-aliases/Readable.md)\>

***

### createReadStream()

> **createReadStream**(`blobId`, `options`?): `Readable`\<`any`, `any`, `any`, `true`, `false`, `ReadableEvents`\<`any`\>\>
> **createReadStream**(`blobId`, `options`?): [`Readable`](../type-aliases/Readable.md)
#### Parameters

Expand All @@ -103,7 +103,7 @@ Set to `true` to wait for a blob to download, otherwise will throw if blob is no

#### Returns

`Readable`\<`any`, `any`, `any`, `true`, `false`, `ReadableEvents`\<`any`\>\>
[`Readable`](../type-aliases/Readable.md)

***

Expand All @@ -129,7 +129,7 @@ Metadata to store with the blob

### download()

> **download**(`filter`?, `options`?): [`LiveDownload`](LiveDownload.md)
> **download**(`filter`?, `options`?): `TypedEmitter`\<[`BlobDownloadEvents`](../interfaces/BlobDownloadEvents.md)\>
Download blobs from all drives, optionally filtering particular blob types
or blob variants. Download will be 'live' and will continue downloading new
Expand All @@ -152,9 +152,7 @@ Optional AbortSignal to cancel in-progress download

#### Returns

[`LiveDownload`](LiveDownload.md)

EventEmitter with `.state` propery, emits `state` with new state when it updates
`TypedEmitter`\<[`BlobDownloadEvents`](../interfaces/BlobDownloadEvents.md)\>

***

Expand Down Expand Up @@ -188,7 +186,7 @@ Set to `true` to wait for a blob to download, otherwise will throw if blob is no

### get()

> **get**(`blobId`, `opts`): `Promise`\<`Buffer`\>
> **get**(`blobId`, `opts`): `Promise`\<`Uint8Array`\>
#### Parameters

Expand All @@ -206,7 +204,7 @@ Set to `true` to wait for a blob to download, otherwise will throw if blob is no

#### Returns

`Promise`\<`Buffer`\>
`Promise`\<`Uint8Array`\>

***

Expand Down
51 changes: 0 additions & 51 deletions docs/api/md/-internal-/classes/DriveLiveDownload.md

This file was deleted.

53 changes: 0 additions & 53 deletions docs/api/md/-internal-/classes/LiveDownload.md

This file was deleted.

23 changes: 23 additions & 0 deletions docs/api/md/-internal-/interfaces/BlobDownloadEvents.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
[**API**](../../README.md)**Docs**

***

[API](../../README.md) / [\<internal\>](../README.md) / BlobDownloadEvents

# Interface: BlobDownloadEvents

## Properties

### state()

> **state**: (`state`) => `void`
Emitted with the current download state whenever it changes (not emitted during initial 'checking' status)

#### Parameters

**state**: [`BlobDownloadState`](BlobDownloadState.md) \| [`BlobDownloadStateError`](../type-aliases/BlobDownloadStateError.md)

#### Returns

`void`
11 changes: 11 additions & 0 deletions docs/api/md/-internal-/type-aliases/Readable.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
[**API**](../../README.md)**Docs**

***

[API](../../README.md) / [\<internal\>](../README.md) / Readable

# Type Alias: Readable

> **Readable**\<\>: `NodeReadable` \| `StreamxReadable`
## Type Parameters
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@comapeo/core",
"version": "2.0.0",
"version": "2.0.1",
"description": "Offline p2p mapping library",
"main": "src/index.js",
"types": "dist/index.d.ts",
Expand Down

0 comments on commit 2074687

Please sign in to comment.