Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronmgdr committed Nov 13, 2024
1 parent c48a687 commit 5980799
Show file tree
Hide file tree
Showing 13 changed files with 802 additions and 500 deletions.
4 changes: 4 additions & 0 deletions docs/sdk/governance/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,8 @@
### Modules

- [index](modules/index.md)
- [interactive-proposal-builder](modules/interactive_proposal_builder.md)
- [proposal-builder](modules/proposal_builder.md)
- [proposals](modules/proposals.md)
- [test-utils/globals](modules/test_utils_globals.md)
- [test-utils/setup.global](modules/test_utils_setup_global.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
[@celo/governance](../README.md) / [interactive-proposal-builder](../modules/interactive_proposal_builder.md) / InteractiveProposalBuilder

# Class: InteractiveProposalBuilder

[interactive-proposal-builder](../modules/interactive_proposal_builder.md).InteractiveProposalBuilder

## Table of contents

### Constructors

- [constructor](interactive_proposal_builder.InteractiveProposalBuilder.md#constructor)

### Methods

- [outputTransactions](interactive_proposal_builder.InteractiveProposalBuilder.md#outputtransactions)
- [promptTransactions](interactive_proposal_builder.InteractiveProposalBuilder.md#prompttransactions)

## Constructors

### constructor

**new InteractiveProposalBuilder**(`builder`): [`InteractiveProposalBuilder`](interactive_proposal_builder.InteractiveProposalBuilder.md)

#### Parameters

| Name | Type |
| :------ | :------ |
| `builder` | [`ProposalBuilder`](proposal_builder.ProposalBuilder.md) |

#### Returns

[`InteractiveProposalBuilder`](interactive_proposal_builder.InteractiveProposalBuilder.md)

#### Defined in

[packages/sdk/governance/src/interactive-proposal-builder.ts:14](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/interactive-proposal-builder.ts#L14)

## Methods

### outputTransactions

**outputTransactions**(): `Promise`\<`void`\>

#### Returns

`Promise`\<`void`\>

#### Defined in

[packages/sdk/governance/src/interactive-proposal-builder.ts:16](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/interactive-proposal-builder.ts#L16)

___

### promptTransactions

**promptTransactions**(): `Promise`\<[`ProposalTransactionJSON`](../interfaces/proposals.ProposalTransactionJSON.md)[]\>

#### Returns

`Promise`\<[`ProposalTransactionJSON`](../interfaces/proposals.ProposalTransactionJSON.md)[]\>

#### Defined in

[packages/sdk/governance/src/interactive-proposal-builder.ts:21](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/interactive-proposal-builder.ts#L21)
Loading

0 comments on commit 5980799

Please sign in to comment.