docs: Do not expose internal OrbitDBAddress function.

src/address.js

@@ -57,41 +57,15 @@ const parseAddress = (address) => {
   return OrbitDBAddress(address)
 }
 
-/**
- * Creates an instance of OrbitDBAddress.
- * @function
- * @param {OrbitDBAddress|string} address A valid OrbitDB database address.
- * @return {OrbitDBAddress} An instance of OrbitDBAddress.
- * @instance
- */
 const OrbitDBAddress = (address) => {
-  /**
-   * @namespace module:Address~OrbitDBAddress
-   * @description The instance returned by {@link module:Address~OrbitDBAddress}.
-   */
-
   if (address && address.protocol === 'orbitdb' && address.path) {
     return address
   }
 
-  /**
-   * The 'orbitdb' protocol.
-   * @memberof module:Address~OrbitDBAddress
-   */
   const protocol = 'orbitdb'
 
-  /**
-   * The path without the /orbitdb/ prefix.
-   * @memberof module:Address~OrbitDBAddress
-   */
   const path = address.replace('/orbitdb/', '').replace('\\orbitdb\\', '')
 
-  /**
-   * Returns OrbitDBAddress as a string.
-   * @function
-   * @return {string} The string form of OrbitDBAddress.
-   * @memberof module:Address~OrbitDBAddress
-   */
   const toString = () => {
     return posixJoin('/', protocol, path)
   }

src/index.js

@@ -11,7 +11,6 @@ export {
 } from './db/index.js'
 
 export {
-  default as OrbitDBAddress,
   isValidAddress,
   parseAddress
 } from './address.js'

test/orbit-db-address.test.js

@@ -1,5 +1,5 @@
 import { strictEqual, notStrictEqual, deepStrictEqual } from 'assert'
-import { OrbitDBAddress, isValidAddress, parseAddress } from '../src/index.js'
+import { default as OrbitDBAddress, isValidAddress, parseAddress } from '../src/address.js'
 
 describe('Address', function () {
   describe('Creating an address from full address string', () => {