Skip to content

Commit 6ea2c2a

Browse files
author
achou11
committed
Release v2.0.0
1 parent 7c690d0 commit 6ea2c2a

File tree

275 files changed

+8527
-9960
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

275 files changed

+8527
-9960
lines changed

docs/api/md/-internal-/README.md

Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
[**API**](../README.md)**Docs**
2+
3+
***
4+
5+
[API](../README.md) / \<internal\>
6+
7+
# \<internal\>
8+
9+
## Index
10+
11+
### Namespaces
12+
13+
- ["/home/runner/work/comapeo-core/comapeo-core/src/datastore/index"](namespaces/home_runner_work_comapeo-core_comapeo-core_src_datastore_index/README.md)
14+
- ["/home/runner/work/comapeo-core/comapeo-core/src/local-peers"](namespaces/home_runner_work_comapeo-core_comapeo-core_src_local-peers/README.md)
15+
- ["/home/runner/work/comapeo-core/comapeo-core/src/schema/client"](namespaces/home_runner_work_comapeo-core_comapeo-core_src_schema_client/README.md)
16+
- ["/home/runner/work/comapeo-core/comapeo-core/src/schema/project"](namespaces/home_runner_work_comapeo-core_comapeo-core_src_schema_project/README.md)
17+
- ["/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)
18+
- ["/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)
19+
- ["hyperdrive"](namespaces/hyperdrive/README.md)
20+
- [Hyperblobs](namespaces/Hyperblobs/README.md)
21+
- [Hyperdrive](namespaces/Hyperdrive/README-1.md)
22+
23+
### Classes
24+
25+
- [BigSparseArray](classes/BigSparseArray.md)
26+
- [BlobApi](classes/BlobApi.md)
27+
- [BlobReadStream](classes/BlobReadStream.md)
28+
- [BlobStore](classes/BlobStore.md)
29+
- [BlobWriteStream](classes/BlobWriteStream.md)
30+
- [CoreIndex](classes/CoreIndex.md)
31+
- [CoreManager](classes/CoreManager.md)
32+
- [CoreOwnership](classes/CoreOwnership.md)
33+
- [Corestore](classes/Corestore.md)
34+
- [CoreSyncState](classes/CoreSyncState.md)
35+
- [DataStore](classes/DataStore.md)
36+
- [DataType](classes/DataType.md)
37+
- [default](classes/default.md)
38+
- [default](classes/default.md)
39+
- [default](classes/default.md)
40+
- [DenseIndex](classes/DenseIndex.md)
41+
- [DriveLiveDownload](classes/DriveLiveDownload.md)
42+
- [Hyperblobs](classes/Hyperblobs.md)
43+
- [Hyperdrive](classes/Hyperdrive.md)
44+
- [IconApi](classes/IconApi.md)
45+
- [Index](classes/Index.md)
46+
- [IndexWriter](classes/IndexWriter.md)
47+
- [InviteApi](classes/InviteApi.md)
48+
- [LiveDownload](classes/LiveDownload.md)
49+
- [LocalDiscovery](classes/LocalDiscovery.md)
50+
- [LocalPeers](classes/LocalPeers.md)
51+
- [Logger](classes/Logger.md)
52+
- [MapeoProject](classes/MapeoProject.md)
53+
- [MemberApi](classes/MemberApi.md)
54+
- [Peer](classes/Peer.md)
55+
- [PeerSyncController](classes/PeerSyncController.md)
56+
- [PendingInvites](classes/PendingInvites.md)
57+
- [Protomux](classes/Protomux.md)
58+
- [RemoteBitfieldPage](classes/RemoteBitfieldPage.md)
59+
- [RemoteBitfieldSegment](classes/RemoteBitfieldSegment.md)
60+
- [Roles](classes/Roles.md)
61+
- [SparseIndex](classes/SparseIndex.md)
62+
- [SyncApi](classes/SyncApi.md)
63+
- [SyncState](classes/SyncState.md)
64+
65+
### Interfaces
66+
67+
- [BitmapOpts](interfaces/BitmapOpts.md)
68+
- [BlobDownloadState](interfaces/BlobDownloadState.md)
69+
- [Channel](interfaces/Channel.md)
70+
- [CorestoreEvents](interfaces/CorestoreEvents.md)
71+
- [DataTypeEvents](interfaces/DataTypeEvents.md)
72+
- [DocCapability](interfaces/DocCapability.md)
73+
- [HaveMsg](interfaces/HaveMsg.md)
74+
- [HyperdriveEvents](interfaces/HyperdriveEvents.md)
75+
- [HyperdriveGetOpts](interfaces/HyperdriveGetOpts.md)
76+
- [HyperdriveOptions](interfaces/HyperdriveOptions.md)
77+
- [LocalCoreState](interfaces/LocalCoreState.md)
78+
- [LocationObject](interfaces/LocationObject.md)
79+
- [LocationObjectCoords](interfaces/LocationObjectCoords.md)
80+
- [MapsPluginOpts](interfaces/MapsPluginOpts.md)
81+
- [MemberInfo](interfaces/MemberInfo.md)
82+
- [Message](interfaces/Message.md)
83+
- [Metadata](interfaces/Metadata.md)
84+
- [PeerInfoBase](interfaces/PeerInfoBase.md)
85+
- [PendingInvite](interfaces/PendingInvite.md)
86+
- [RemoteDeviceNamespaceGroupSyncState](interfaces/RemoteDeviceNamespaceGroupSyncState.md)
87+
- [RemoteDeviceSyncState](interfaces/RemoteDeviceSyncState.md)
88+
- [Role](interfaces/Role.md)
89+
- [StartOpts](interfaces/StartOpts.md)
90+
- [State](interfaces/State.md)
91+
- [SvgOpts](interfaces/SvgOpts.md)
92+
93+
### Type Aliases
94+
95+
- [ArrayAtLeastOne](type-aliases/ArrayAtLeastOne.md)
96+
- [BitField](type-aliases/BitField.md)
97+
- [BlobDownloadStateError](type-aliases/BlobDownloadStateError.md)
98+
- [BlobFilter](type-aliases/BlobFilter.md)
99+
- [BlobId](type-aliases/BlobId.md)
100+
- [BlobIdBase](type-aliases/BlobIdBase.md)
101+
- [BlobType](type-aliases/BlobType.md)
102+
- [BlobVariant](type-aliases/BlobVariant.md)
103+
- [Chunk](type-aliases/Chunk.md)
104+
- [Core](type-aliases/Core.md)
105+
- [CoreOwnershipWithSignatures](type-aliases/CoreOwnershipWithSignatures.md)
106+
- [CoreOwnershipWithSignaturesValue](type-aliases/CoreOwnershipWithSignaturesValue.md)
107+
- [CoreRecord](type-aliases/CoreRecord.md)
108+
- [CoreStorage](type-aliases/CoreStorage.md)
109+
- [DeviceInfoDataType](type-aliases/DeviceInfoDataType.md)
110+
- [DeviceInfoParam](type-aliases/DeviceInfoParam.md)
111+
- [EditableProjectSettings](type-aliases/EditableProjectSettings.md)
112+
- [ElementOf](type-aliases/ElementOf.md)
113+
- [GetMapeoDocTables](type-aliases/GetMapeoDocTables.md)
114+
- [HypercorePeer](type-aliases/HypercorePeer.md)
115+
- [HypercoreRemoteBitfield](type-aliases/HypercoreRemoteBitfield.md)
116+
- [HypercoreRemoteBitfieldPage](type-aliases/HypercoreRemoteBitfieldPage.md)
117+
- [IconVariant](type-aliases/IconVariant.md)
118+
- [IndexedDocIds](type-aliases/IndexedDocIds.md)
119+
- [InternalDriveEmitter](type-aliases/InternalDriveEmitter.md)
120+
- [InviteInternal](type-aliases/InviteInternal.md)
121+
- [Keypair](type-aliases/Keypair.md)
122+
- [KeyPair](type-aliases/KeyPair-1.md)
123+
- [MapBuffers](type-aliases/MapBuffers.md)
124+
- [MapeoDocMap](type-aliases/MapeoDocMap.md)
125+
- [MapeoDocTableName](type-aliases/MapeoDocTableName.md)
126+
- [MapeoDocTables](type-aliases/MapeoDocTables.md)
127+
- [MapeoValueMap](type-aliases/MapeoValueMap.md)
128+
- [Namespace](type-aliases/Namespace.md)
129+
- [NamespaceSchemas](type-aliases/NamespaceSchemas.md)
130+
- [OpenedNetNoiseStream](type-aliases/OpenedNetNoiseStream.md)
131+
- [OpenedNoiseStream](type-aliases/OpenedNoiseStream.md)
132+
- [PeerInfoConnected](type-aliases/PeerInfoConnected.md)
133+
- [PeerInfoDisconnected](type-aliases/PeerInfoDisconnected.md)
134+
- [ProjectDataType](type-aliases/ProjectDataType.md)
135+
- [ProtocolStream](type-aliases/ProtocolStream.md)
136+
- [PublicKey](type-aliases/PublicKey.md)
137+
- [PublicPeerInfo](type-aliases/PublicPeerInfo.md)
138+
- [Range](type-aliases/Range.md)
139+
- [RawStream](type-aliases/RawStream.md)
140+
- [ReplicationStream](type-aliases/ReplicationStream.md)
141+
- [RoleId](type-aliases/RoleId.md)
142+
- [SchemaName](type-aliases/SchemaName.md)
143+
- [SecretKey](type-aliases/SecretKey.md)
144+
- [State](type-aliases/State.md)
145+
- [SupportedBlobVariants](type-aliases/SupportedBlobVariants.md)
146+
- [SyncCapability](type-aliases/SyncCapability.md)
147+
- [SyncEnabledState](type-aliases/SyncEnabledState.md)
148+
- [SyncType](type-aliases/SyncType.md)
149+
- [ValidSizes](type-aliases/ValidSizes.md)
150+
151+
### Variables
152+
153+
- [NAMESPACE\_SCHEMAS](variables/NAMESPACE_SCHEMAS.md)
154+
- [NAMESPACES](variables/NAMESPACES.md)
155+
- [ROLE\_IDS](variables/ROLE_IDS.md)
156+
- [SUPPORTED\_BLOB\_VARIANTS](variables/SUPPORTED_BLOB_VARIANTS.md)
157+
158+
## References
159+
160+
### BlobId
161+
162+
Re-exports [BlobId](namespaces/Hyperblobs/interfaces/BlobId.md)
163+
164+
***
165+
166+
### HyperdriveEntry
167+
168+
Re-exports [HyperdriveEntry](namespaces/Hyperdrive/interfaces/HyperdriveEntry.md)
169+
170+
***
171+
172+
### NamespaceSyncState
173+
174+
Re-exports [NamespaceSyncState](namespaces/home_runner_work_comapeo-core_comapeo-core_src_sync_namespace-sync-state/classes/NamespaceSyncState.md)
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
[**API**](../../README.md)**Docs**
2+
3+
***
4+
5+
[API](../../README.md) / [\<internal\>](../README.md) / BigSparseArray
6+
7+
# Class: BigSparseArray\<T\>
8+
9+
## Type Parameters
10+
11+
**T**
12+
13+
## Constructors
14+
15+
### new BigSparseArray()
16+
17+
> **new BigSparseArray**\<`T`\>(): [`BigSparseArray`](BigSparseArray.md)\<`T`\>
18+
19+
#### Returns
20+
21+
[`BigSparseArray`](BigSparseArray.md)\<`T`\>
22+
23+
## Properties
24+
25+
### maxLength
26+
27+
> `readonly` **maxLength**: `number`
28+
29+
## Methods
30+
31+
### get()
32+
33+
> **get**(`index`): `undefined` \| `T`
34+
35+
#### Parameters
36+
37+
**index**: `number`
38+
39+
#### Returns
40+
41+
`undefined` \| `T`
42+
43+
***
44+
45+
### set()
46+
47+
> **set**(`index`, `value`): `T`
48+
49+
#### Parameters
50+
51+
**index**: `number`
52+
53+
**value**: `T`
54+
55+
#### Returns
56+
57+
`T`
Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
[**API**](../../README.md)**Docs**
2+
3+
***
4+
5+
[API](../../README.md) / [\<internal\>](../README.md) / BlobApi
6+
7+
# Class: BlobApi
8+
9+
## Constructors
10+
11+
### new BlobApi()
12+
13+
> **new BlobApi**(`options`): [`BlobApi`](BlobApi.md)
14+
15+
#### Parameters
16+
17+
**options**
18+
19+
**options.blobStore**: [`BlobStore`](BlobStore.md)
20+
21+
**options.getMediaBaseUrl**
22+
23+
#### Returns
24+
25+
[`BlobApi`](BlobApi.md)
26+
27+
## Methods
28+
29+
### create()
30+
31+
> **create**(`filepaths`, `metadata`): `Promise`\<`object`\>
32+
33+
Write blobs for provided variants of a file
34+
35+
#### Parameters
36+
37+
**filepaths**
38+
39+
**filepaths.original**: `string`
40+
41+
**filepaths.preview?**: `string`
42+
43+
**filepaths.thumbnail?**: `string`
44+
45+
**metadata**: [`Metadata`](../interfaces/Metadata.md)
46+
47+
#### Returns
48+
49+
`Promise`\<`object`\>
50+
51+
##### driveId
52+
53+
> **driveId**: `string`
54+
55+
##### hash
56+
57+
> **hash**: `string`
58+
59+
##### name
60+
61+
> **name**: `string`
62+
63+
##### type
64+
65+
> **type**: `"photo"` \| `"audio"` \| `"video"`
66+
67+
***
68+
69+
### getUrl()
70+
71+
> **getUrl**(`blobId`): `Promise`\<`string`\>
72+
73+
Get a url for a blob based on its BlobId
74+
75+
#### Parameters
76+
77+
**blobId**: [`BlobId`](../type-aliases/BlobId.md)
78+
79+
#### Returns
80+
81+
`Promise`\<`string`\>
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
[**API**](../../README.md)**Docs**
2+
3+
***
4+
5+
[API](../../README.md) / [\<internal\>](../README.md) / BlobReadStream
6+
7+
# Class: BlobReadStream
8+
9+
## Extends
10+
11+
- `Readable`
12+
13+
## Constructors
14+
15+
### new BlobReadStream()
16+
17+
> **new BlobReadStream**(`opts`): [`BlobReadStream`](BlobReadStream.md)
18+
19+
#### Parameters
20+
21+
**opts**: `any`
22+
23+
#### Returns
24+
25+
[`BlobReadStream`](BlobReadStream.md)
26+
27+
#### Overrides
28+
29+
`Readable.constructor`

0 commit comments

Comments
 (0)