Commit Graph

9 Commits

Author SHA1 Message Date
haad
42efd1ae3d Clarify OrbitDBAddress docs 2023-06-30 08:14:23 +03:00
Hayden Young
eeb7e8d363 docs: Type defs for returned objects. 2023-06-27 21:51:26 +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
578f4890b9 docs: Do not expose internal OrbitDBAddress function. 2023-06-24 16:28:49 +01: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
saul
06a68bbe1c Replace usages of path with path join util. 2023-03-28 12:55:15 +13:00
haad
4a7d3f0720 Move files, clean up 2023-03-01 18:16:06 +02:00