quasvel
Version:
Access and interact with Aragon Organizations and their apps.
52 lines (40 loc) • 2.41 kB
Markdown
This file documents the main exports of the library.
Connects and returns an `Organization` for `location`.
| Name | Type | Description |
| ------------------ | --------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| `location` | `String` | The Ethereum address or ENS domain of an Aragon organization. |
| `connector` | `Connector` or `[String, Object]` or `String` | Accepts a `Connector` instance, and either a string or a tuple for embedded connectors and their config. |
| `options` | `Object` | The optional configuration object. |
| `options.ethereum` | `EthereumProvider` | An [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) compatible object. |
| `options.network` | [`Networkish`](./types.md
| returns | `Promise<Organization>` | An `Organization` instance. |
```javascript
import connect from '@aragon/connect'
// Connections should get wrapped in a try / catch to capture connection errors
try {
// Connect to an org through The Graph
const org1 = await connect('org1.aragonid.eth', 'thegraph')
// Specify a different Chain ID
const org3 = await connect('org3.aragonid.eth', 'thegraph', { network: 4 })
// Specify a configuration for the connector
const org3 = await connect('org3.aragonid.eth', [
'thegraph',
{ orgSubgraphUrl: 'http://…' },
])
// Custom connector
const org4 = await connect(
'org4.aragonid.eth',
// CustomConnector implements IConnector
new CustomConnector()
)
} catch (err) {
if (err instanceof ConnectionError) {
console.error('Connection error')
} else {
console.error(err)
}
}
```