Skip to content
This repository has been archived by the owner on Aug 9, 2021. It is now read-only.

Commit

Permalink
docs: generate readme
Browse files Browse the repository at this point in the history
  • Loading branch information
oed committed Mar 12, 2019
1 parent 48e42d7 commit 0ff1bc6
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,8 @@ const { profileGraphQL, getProfile, getProfiles, getVerifiedAccounts } = require
* _static_
* [.getProfile(address, opts)](#Box.getProfile) ⇒ <code>Object</code>
* [.getProfiles(address, opts)](#Box.getProfiles) ⇒ <code>Object</code>
* [.getSpace(address, name, opts)](#Box.getSpace) ⇒ <code>Object</code>
* [.listSpaces(address, opts)](#Box.listSpaces) ⇒ <code>Object</code>
* [.profileGraphQL(query, opts)](#Box.profileGraphQL) ⇒ <code>Object</code>
* [.getVerifiedAccounts(profile)](#Box.getVerifiedAccounts) ⇒ <code>Object</code>
* [.openBox(address, ethereumProvider, opts)](#Box.openBox)[<code>Box</code>](#Box)
Expand Down Expand Up @@ -329,6 +331,35 @@ Get a list of public profiles for given addresses. This relies on 3Box profile A
| opts | <code>Object</code> | Optional parameters |
| opts.profileServer | <code>String</code> | URL of Profile API server |

<a name="Box.getSpace"></a>

#### Box.getSpace(address, name, opts) ⇒ <code>Object</code>
Get the public data in a space of a given address with the given name

**Kind**: static method of [<code>Box</code>](#Box)
**Returns**: <code>Object</code> - a json object with the public space data

| Param | Type | Description |
| --- | --- | --- |
| address | <code>String</code> | An ethereum address |
| name | <code>String</code> | A space name |
| opts | <code>Object</code> | Optional parameters |
| opts.profileServer | <code>String</code> | URL of Profile API server |

<a name="Box.listSpaces"></a>

#### Box.listSpaces(address, opts) ⇒ <code>Object</code>
Get the names of all spaces a user has

**Kind**: static method of [<code>Box</code>](#Box)
**Returns**: <code>Object</code> - an array with all spaces as strings

| Param | Type | Description |
| --- | --- | --- |
| address | <code>String</code> | An ethereum address |
| opts | <code>Object</code> | Optional parameters |
| opts.profileServer | <code>String</code> | URL of Profile API server |

<a name="Box.profileGraphQL"></a>

#### Box.profileGraphQL(query, opts) ⇒ <code>Object</code>
Expand Down

0 comments on commit 0ff1bc6

Please sign in to comment.