@1hive/connect-gardens

Index

Classes Other

Classes Utility

GardenConnector

Functions Main

Main Functions

connectGarden

connectGarden(organization: default, config?: Config): Garden

- Defined in connect.ts:19
The default way to connect a Garden and start fetching data from the subgraph.

Parameters
- organization: default
  
  Organization class we are connecting to using Aragon Connect.
- Optional config: Config
  
  A configuration object.
Returns Garden
A new Garden instance.

getGarden

getGarden(config: Config, id: string): Promise<Organization>

- Defined in gardens.ts:64
Fetch a garden from a subgraph.

Parameters
- config: Config
  
  A configuration object.
- id: string
  
  The garden's id
Returns Promise<Organization>
A promise that resolvles to a garden.

getGardens

getGardens(config: Config, params: GardenParams): Promise<Organization[]>

- Defined in gardens.ts:43
Fetch a list of gardens from a subgraph.

Parameters
- config: Config
  
  A configuration object.
- params: GardenParams
  
  A filters object.
Returns Promise<Organization[]>
A promise that resolves to a group of gardens.

getUser

getUser(config: Config, params: UserParams): Promise<User[]>

- Defined in gardens.ts:83
The default way to connect a garden and start fetching data from the subgraph.

Parameters
- config: Config
  
  A configuration object.
- params: UserParams
  
  A filters object.
Returns Promise<User[]>
A promise that resolves to a group of users.

Generated using TypeDoc