Commit Graph

469 Commits

Author SHA1 Message Date
Hayden Young
eeb7e8d363 docs: Type defs for returned objects. 2023-06-27 21:51:26 +01:00
Hayden Young
d6c2330122 docs: Do not generate API docs for internal functionality. 2023-06-27 21:51:00 +01:00
Hayden Young
44752a464e refactor: Use hash instead of path when referencing orbitdb addresses. 2023-06-27 14:06:31 +01:00
Hayden Young
cdbe76d708 refactor: Match databases dir to namespace. 2023-06-27 13:33:08 +01:00
Hayden Young
ad13ebe014 fix: Linting. 2023-06-27 13:21:26 +01:00
Hayden Young
88d202008f docs: The join event fires AFTER heads have been exchanged. 2023-06-27 13:19:44 +01:00
Hayden Young
fbf039b8ff docs: Better description of the kv storage. 2023-06-27 13:15:31 +01:00
Hayden Young
d91516ffe1 docs: Fix incorrect memberof references. 2023-06-27 13:06:41 +01:00
Hayden Young
603f79f4b2 Change event doc to original. 2023-06-27 13:03:48 +01:00
Hayden Young
2378a143de Should be a "system", not a "platform". 2023-06-27 13:02:14 +01:00
Hayden Young
bba53d730a docs: Add a README home page to API. 2023-06-25 00:18:39 +01:00
Hayden Young
9befa48a7a docs: Formatting. 2023-06-24 23:50:44 +01:00
Hayden Young
3ceb2aac6c docs: Remove documentation for params for internal database functionality. 2023-06-24 22:07:30 +01:00
Hayden Young
f719248b2e docs: Document the findFn signature. 2023-06-24 21:58:08 +01:00
Hayden Young
578f4890b9 docs: Do not expose internal OrbitDBAddress function. 2023-06-24 16:28:49 +01:00
Hayden Young
e6f86fa203 docs: Do not document utils. They are not exposed externally. 2023-06-24 16:18:46 +01:00
Hayden Young
24a2e1ae5f docs: Change namespace from database to databases. 2023-06-24 16:11:21 +01:00
Hayden Young
ec461809ac docs: Move customization documentation to READMEs. 2023-06-24 15:46:27 +01:00
Hayden Young
6c4a0ced0c docs: Remove API docs. Manifest is an internal module. 2023-06-24 15:36:13 +01:00
Hayden Young
8b17f172fa docs: Move custom identity provider docs to READMEs. 2023-06-24 15:35:48 +01:00
Hayden Young
3af0fc2306 docs: Move custom examples to READMEs. 2023-06-24 15:20:46 +01:00
Hayden Young
a7b611550f docs: Document the properties of an entry. 2023-06-24 15:18:32 +01:00
Hayden Young
438a8d6d64 docs: Add to log module. 2023-06-24 15:18:12 +01:00
Hayden Young
222c7234fe refactor: Rename manifest store. 2023-06-22 01:10:12 +01:00
Hayden Young
4a2f2d6809 docs: Distinguish between opening a new db and opening an existing one. 2023-06-22 00:28:05 +01:00
Hayden Young
41230d6150 docs: Fix referenceCount definition. 2023-06-22 00:20:33 +01:00
Hayden Young
877d6b38ea docs: Metadata new db vs opening db. 2023-06-22 00:17:08 +01:00
Hayden Young
8f88098ee7 docs: Sync default is true. 2023-06-22 00:15:13 +01:00
Hayden Young
7d31c9a763 docs: Correct default ComposedStorage. 2023-06-22 00:00:38 +01:00
Hayden Young
b3fcd36237 docs: Link to IPFSAccessController. 2023-06-21 22:34:08 +01:00
Hayden Young
6c34ff79ab Merge remote-tracking branch 'origin' into docs/pre-release 2023-06-21 21:47:14 +01:00
Hayden Young
a525d91e8f docs: Expose access controllers/identity providers/dbs directly. Remove get* functions for AC/IP/DB loaders. 2023-06-21 21:19:35 +01:00
Hayden Young
29a901d6dc docs: Expand on param. 2023-06-20 00:28:16 +01:00
Hayden Young
f676410543 docs: Do not include in API docs. For internal use only. 2023-06-20 00:26:29 +01:00
Hayden Young
0ca2256b39 docs: PublicKeyIdentityProvider is namespace of IdentityProviders. 2023-06-20 00:24:51 +01:00
Hayden Young
59d8bdc90a docs: Remove docblocks for Identity. Document Identity properties and functions. 2023-06-19 02:24:52 +01:00
Hayden Young
4fa3b0c115 docs: Remove docblocks for internal functions. 2023-06-19 01:54:54 +01:00
Hayden Young
a243efff71 docs: Remove implementation of custom ACs in API. 2023-06-19 01:35:11 +01:00
Hayden Young
4e5b6bb597 chore: Simplify error checking. 2023-06-18 19:33:48 +01:00
Hayden Young
7fafda8416 docs: type is required. 2023-06-18 03:22:18 +01:00
Hayden Young
4c3a338205 refactor: Standardize module loader functions. Do not expose module lists. 2023-06-18 03:05:07 +01:00
Hayden Young
8b93553d0e refactor: Move database type management to db module. 2023-06-18 02:43:03 +01:00
Hayden Young
6def69f345 Identity issue (#82)
* docs: Correctly print out db query results.

* test: Remove concurrent.

* test: Remove unimplemented and 3rd party AC tests.

* test: Remove unimplemented and 3rd party identity tests.

* docs: Move jsdoc config to conf directory.

* Point package.json main at index.js to access all exported functions.

* test: Identities storage pointing at wrong location.

* refactor: Identities is configurable when creating an OrbitDB instance.
2023-06-13 23:55:25 +08:00
Hayden Young
bd6bb021c1 docs: Lamport clock docs. (#77)
* docs: Lamport clock docs.

* docs: Formatting.

* docs: Formatting.

* docs: Formatting.
2023-06-03 06:00:25 +08:00
Hayden Young
b9e573dc6d feat: Expose identity provider managers. (#75)
* feat: Expose identity provider managers.

* refactor: Remove unnecessary provider tools.

* refactor: Match AC management to other management mechanisms (e.g. Identity Providers).
2023-06-02 02:53:40 +08:00
Hayden Young
794136c762 refactor: Functionize identity provider. (#74)
* refactor: Functionize identity provider.

* docs: Building a custom identity provider.

* refactor: Functionize clock.
2023-05-25 00:48:01 +08:00
Hayden Young
60fbe47ee3 Jsdocs (#73)
* fix: Load correct main.

* docs: Enable markdown.

* docs: Add jsdoc blocks.

* docs: Separate orbitdb into module and namespace.

* docs: Database module and namespace.

* docs: Default values for storage.

* docs: Match param naming across modules.

* docs: Use @link where possible.

* docs: Use @example for code.

* docs: KeyStore module and namespace documentation.

* docs: API for Access controller management.

* docs: Document Database events.

* docs: Formatting.

* docs: Notes on Custom AC and including a canAppend function.

* docs: Standardize primitive data types.

* docs: Proposed submodule structure.

* docs: Composed storage. How to create custom storage.

* docs: annotations for all storage modules.

* docs: Documents.

* docs: KeyValueIndexed.

* docs: Provide example for specifying storage for keyvalue.

* docs: KeyValue.

* docs: Remove const documentation where not required.

* docs: KeyStore static functions.

* docs: Identities.

* docs: Identity.

* refactor: Remove unused param.

* docs: Address.

* docs: Address.

* docs: Manifest.

* docs: IPFSAccessController.

* docs: OrbitDBAccessController.

* docs: Utils.

* test: check for correct message.
2023-05-18 03:34:44 +08:00
haad
c117ef63ba Add jsdocs 2023-04-13 09:15:27 +03:00
haad
b1d16fc7b4 Cleanups 2023-04-13 08:26:41 +03:00
haad
e687b51d96 Remove obsolete code from OrbitDB AC 2023-04-13 08:26:19 +03:00