Skip to content

Commit

Permalink
initial example docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Adam committed Jan 26, 2024
1 parent a920e5f commit 7a99785
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 0 deletions.
4 changes: 4 additions & 0 deletions packages/sdk/src/https/datasets/milestone/MilestoneDataset.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
import { Dataset, Milestone } from '@build-5/interfaces';
import { DatasetClass } from '../Dataset';

/**
* Milestone Dataset
*
*/
export class MilestoneDataset<D extends Dataset> extends DatasetClass<D, Milestone> {}
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
import { MilestoneTransaction } from '@build-5/interfaces';
import { SubsetClass } from '../Subset';

/**
* Milestone Transactions subset
*
*/
export class MilestoneTransactionSubset extends SubsetClass<MilestoneTransaction> {}
9 changes: 9 additions & 0 deletions packages/sdk/src/https/datasets/proposal/ProposalDataset.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,16 @@ import {
} from '@build-5/interfaces';
import { DatasetClass } from '../Dataset';

/**
* Proposal Dataset
*/
export class ProposalDataset<D extends Dataset> extends DatasetClass<D, Proposal> {
/**
* Method to create Proposal
*
* @param req Use {@link Build5Request} with data based on {@link ProposalCreateRequest}
* @returns
*/
create = (req: Build5Request<ProposalCreateRequest>) =>
this.sendRequest(WEN_FUNC.createProposal)<ProposalCreateRequest, Proposal>(req);

Expand Down

0 comments on commit 7a99785

Please sign in to comment.