Skip to content

Commit

Permalink
Release v2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
achou11 committed Oct 15, 2024
1 parent 7c690d0 commit 6ea2c2a
Show file tree
Hide file tree
Showing 275 changed files with 8,527 additions and 9,960 deletions.
174 changes: 174 additions & 0 deletions docs/api/md/-internal-/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
[**API**](../README.md)**Docs**

***

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

# \<internal\>

## Index

### Namespaces

- ["/home/runner/work/comapeo-core/comapeo-core/src/datastore/index"](namespaces/home_runner_work_comapeo-core_comapeo-core_src_datastore_index/README.md)
- ["/home/runner/work/comapeo-core/comapeo-core/src/local-peers"](namespaces/home_runner_work_comapeo-core_comapeo-core_src_local-peers/README.md)
- ["/home/runner/work/comapeo-core/comapeo-core/src/schema/client"](namespaces/home_runner_work_comapeo-core_comapeo-core_src_schema_client/README.md)
- ["/home/runner/work/comapeo-core/comapeo-core/src/schema/project"](namespaces/home_runner_work_comapeo-core_comapeo-core_src_schema_project/README.md)
- ["/home/runner/work/comapeo-core/comapeo-core/src/sync/core-sync-state"](namespaces/home_runner_work_comapeo-core_comapeo-core_src_sync_core-sync-state/README.md)
- ["/home/runner/work/comapeo-core/comapeo-core/src/sync/namespace-sync-state"](namespaces/home_runner_work_comapeo-core_comapeo-core_src_sync_namespace-sync-state/README.md)
- ["hyperdrive"](namespaces/hyperdrive/README.md)
- [Hyperblobs](namespaces/Hyperblobs/README.md)
- [Hyperdrive](namespaces/Hyperdrive/README-1.md)

### Classes

- [BigSparseArray](classes/BigSparseArray.md)
- [BlobApi](classes/BlobApi.md)
- [BlobReadStream](classes/BlobReadStream.md)
- [BlobStore](classes/BlobStore.md)
- [BlobWriteStream](classes/BlobWriteStream.md)
- [CoreIndex](classes/CoreIndex.md)
- [CoreManager](classes/CoreManager.md)
- [CoreOwnership](classes/CoreOwnership.md)
- [Corestore](classes/Corestore.md)
- [CoreSyncState](classes/CoreSyncState.md)
- [DataStore](classes/DataStore.md)
- [DataType](classes/DataType.md)
- [default](classes/default.md)
- [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)
- [MapeoProject](classes/MapeoProject.md)
- [MemberApi](classes/MemberApi.md)
- [Peer](classes/Peer.md)
- [PeerSyncController](classes/PeerSyncController.md)
- [PendingInvites](classes/PendingInvites.md)
- [Protomux](classes/Protomux.md)
- [RemoteBitfieldPage](classes/RemoteBitfieldPage.md)
- [RemoteBitfieldSegment](classes/RemoteBitfieldSegment.md)
- [Roles](classes/Roles.md)
- [SparseIndex](classes/SparseIndex.md)
- [SyncApi](classes/SyncApi.md)
- [SyncState](classes/SyncState.md)

### Interfaces

- [BitmapOpts](interfaces/BitmapOpts.md)
- [BlobDownloadState](interfaces/BlobDownloadState.md)
- [Channel](interfaces/Channel.md)
- [CorestoreEvents](interfaces/CorestoreEvents.md)
- [DataTypeEvents](interfaces/DataTypeEvents.md)
- [DocCapability](interfaces/DocCapability.md)
- [HaveMsg](interfaces/HaveMsg.md)
- [HyperdriveEvents](interfaces/HyperdriveEvents.md)
- [HyperdriveGetOpts](interfaces/HyperdriveGetOpts.md)
- [HyperdriveOptions](interfaces/HyperdriveOptions.md)
- [LocalCoreState](interfaces/LocalCoreState.md)
- [LocationObject](interfaces/LocationObject.md)
- [LocationObjectCoords](interfaces/LocationObjectCoords.md)
- [MapsPluginOpts](interfaces/MapsPluginOpts.md)
- [MemberInfo](interfaces/MemberInfo.md)
- [Message](interfaces/Message.md)
- [Metadata](interfaces/Metadata.md)
- [PeerInfoBase](interfaces/PeerInfoBase.md)
- [PendingInvite](interfaces/PendingInvite.md)
- [RemoteDeviceNamespaceGroupSyncState](interfaces/RemoteDeviceNamespaceGroupSyncState.md)
- [RemoteDeviceSyncState](interfaces/RemoteDeviceSyncState.md)
- [Role](interfaces/Role.md)
- [StartOpts](interfaces/StartOpts.md)
- [State](interfaces/State.md)
- [SvgOpts](interfaces/SvgOpts.md)

### Type Aliases

- [ArrayAtLeastOne](type-aliases/ArrayAtLeastOne.md)
- [BitField](type-aliases/BitField.md)
- [BlobDownloadStateError](type-aliases/BlobDownloadStateError.md)
- [BlobFilter](type-aliases/BlobFilter.md)
- [BlobId](type-aliases/BlobId.md)
- [BlobIdBase](type-aliases/BlobIdBase.md)
- [BlobType](type-aliases/BlobType.md)
- [BlobVariant](type-aliases/BlobVariant.md)
- [Chunk](type-aliases/Chunk.md)
- [Core](type-aliases/Core.md)
- [CoreOwnershipWithSignatures](type-aliases/CoreOwnershipWithSignatures.md)
- [CoreOwnershipWithSignaturesValue](type-aliases/CoreOwnershipWithSignaturesValue.md)
- [CoreRecord](type-aliases/CoreRecord.md)
- [CoreStorage](type-aliases/CoreStorage.md)
- [DeviceInfoDataType](type-aliases/DeviceInfoDataType.md)
- [DeviceInfoParam](type-aliases/DeviceInfoParam.md)
- [EditableProjectSettings](type-aliases/EditableProjectSettings.md)
- [ElementOf](type-aliases/ElementOf.md)
- [GetMapeoDocTables](type-aliases/GetMapeoDocTables.md)
- [HypercorePeer](type-aliases/HypercorePeer.md)
- [HypercoreRemoteBitfield](type-aliases/HypercoreRemoteBitfield.md)
- [HypercoreRemoteBitfieldPage](type-aliases/HypercoreRemoteBitfieldPage.md)
- [IconVariant](type-aliases/IconVariant.md)
- [IndexedDocIds](type-aliases/IndexedDocIds.md)
- [InternalDriveEmitter](type-aliases/InternalDriveEmitter.md)
- [InviteInternal](type-aliases/InviteInternal.md)
- [Keypair](type-aliases/Keypair.md)
- [KeyPair](type-aliases/KeyPair-1.md)
- [MapBuffers](type-aliases/MapBuffers.md)
- [MapeoDocMap](type-aliases/MapeoDocMap.md)
- [MapeoDocTableName](type-aliases/MapeoDocTableName.md)
- [MapeoDocTables](type-aliases/MapeoDocTables.md)
- [MapeoValueMap](type-aliases/MapeoValueMap.md)
- [Namespace](type-aliases/Namespace.md)
- [NamespaceSchemas](type-aliases/NamespaceSchemas.md)
- [OpenedNetNoiseStream](type-aliases/OpenedNetNoiseStream.md)
- [OpenedNoiseStream](type-aliases/OpenedNoiseStream.md)
- [PeerInfoConnected](type-aliases/PeerInfoConnected.md)
- [PeerInfoDisconnected](type-aliases/PeerInfoDisconnected.md)
- [ProjectDataType](type-aliases/ProjectDataType.md)
- [ProtocolStream](type-aliases/ProtocolStream.md)
- [PublicKey](type-aliases/PublicKey.md)
- [PublicPeerInfo](type-aliases/PublicPeerInfo.md)
- [Range](type-aliases/Range.md)
- [RawStream](type-aliases/RawStream.md)
- [ReplicationStream](type-aliases/ReplicationStream.md)
- [RoleId](type-aliases/RoleId.md)
- [SchemaName](type-aliases/SchemaName.md)
- [SecretKey](type-aliases/SecretKey.md)
- [State](type-aliases/State.md)
- [SupportedBlobVariants](type-aliases/SupportedBlobVariants.md)
- [SyncCapability](type-aliases/SyncCapability.md)
- [SyncEnabledState](type-aliases/SyncEnabledState.md)
- [SyncType](type-aliases/SyncType.md)
- [ValidSizes](type-aliases/ValidSizes.md)

### Variables

- [NAMESPACE\_SCHEMAS](variables/NAMESPACE_SCHEMAS.md)
- [NAMESPACES](variables/NAMESPACES.md)
- [ROLE\_IDS](variables/ROLE_IDS.md)
- [SUPPORTED\_BLOB\_VARIANTS](variables/SUPPORTED_BLOB_VARIANTS.md)

## References

### BlobId

Re-exports [BlobId](namespaces/Hyperblobs/interfaces/BlobId.md)

***

### HyperdriveEntry

Re-exports [HyperdriveEntry](namespaces/Hyperdrive/interfaces/HyperdriveEntry.md)

***

### NamespaceSyncState

Re-exports [NamespaceSyncState](namespaces/home_runner_work_comapeo-core_comapeo-core_src_sync_namespace-sync-state/classes/NamespaceSyncState.md)
57 changes: 57 additions & 0 deletions docs/api/md/-internal-/classes/BigSparseArray.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
[**API**](../../README.md)**Docs**

***

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

# Class: BigSparseArray\<T\>

## Type Parameters

**T**

## Constructors

### new BigSparseArray()

> **new BigSparseArray**\<`T`\>(): [`BigSparseArray`](BigSparseArray.md)\<`T`\>
#### Returns

[`BigSparseArray`](BigSparseArray.md)\<`T`\>

## Properties

### maxLength

> `readonly` **maxLength**: `number`
## Methods

### get()

> **get**(`index`): `undefined` \| `T`
#### Parameters

**index**: `number`

#### Returns

`undefined` \| `T`

***

### set()

> **set**(`index`, `value`): `T`
#### Parameters

**index**: `number`

**value**: `T`

#### Returns

`T`
81 changes: 81 additions & 0 deletions docs/api/md/-internal-/classes/BlobApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
[**API**](../../README.md)**Docs**

***

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

# Class: BlobApi

## Constructors

### new BlobApi()

> **new BlobApi**(`options`): [`BlobApi`](BlobApi.md)
#### Parameters

**options**

**options.blobStore**: [`BlobStore`](BlobStore.md)

**options.getMediaBaseUrl**

#### Returns

[`BlobApi`](BlobApi.md)

## Methods

### create()

> **create**(`filepaths`, `metadata`): `Promise`\<`object`\>
Write blobs for provided variants of a file

#### Parameters

**filepaths**

**filepaths.original**: `string`

**filepaths.preview?**: `string`

**filepaths.thumbnail?**: `string`

**metadata**: [`Metadata`](../interfaces/Metadata.md)

#### Returns

`Promise`\<`object`\>

##### driveId

> **driveId**: `string`
##### hash

> **hash**: `string`
##### name

> **name**: `string`
##### type

> **type**: `"photo"` \| `"audio"` \| `"video"`
***

### getUrl()

> **getUrl**(`blobId`): `Promise`\<`string`\>
Get a url for a blob based on its BlobId

#### Parameters

**blobId**: [`BlobId`](../type-aliases/BlobId.md)

#### Returns

`Promise`\<`string`\>
29 changes: 29 additions & 0 deletions docs/api/md/-internal-/classes/BlobReadStream.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
[**API**](../../README.md)**Docs**

***

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

# Class: BlobReadStream

## Extends

- `Readable`

## Constructors

### new BlobReadStream()

> **new BlobReadStream**(`opts`): [`BlobReadStream`](BlobReadStream.md)
#### Parameters

**opts**: `any`

#### Returns

[`BlobReadStream`](BlobReadStream.md)

#### Overrides

`Readable.constructor`
Loading

0 comments on commit 6ea2c2a

Please sign in to comment.