JS API Reference
Class: RentalModuleImpl
resource-rental/rental.module.RentalModuleImpl
Implements
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new RentalModuleImpl(deps): RentalModuleImpl
Parameters
| Name | Type |
|---|---|
deps | Object |
deps.marketModule | MarketModule |
deps.paymentModule | PaymentModule |
deps.activityModule | ActivityModule |
deps.networkModule | NetworkModule |
deps.storageProvider | StorageProvider |
deps.logger | Logger |
Returns
Defined in
src/resource-rental/rental.module.ts:39
Properties
events
• events: EventEmitter<ResourceRentalModuleEvents, any>
Implementation of
Defined in
src/resource-rental/rental.module.ts:38
Methods
createResourceRental
▸ createResourceRental(agreement, allocation, options?): ResourceRental
Factory that creates a new resource rental that's fully configured. This method will also create the payment process for the agreement.
Parameters
| Name | Type |
|---|---|
agreement | Agreement |
allocation | Allocation |
options? | ResourceRentalOptions |
Returns
Implementation of
RentalModule.createResourceRental
Defined in
src/resource-rental/rental.module.ts:50
createResourceRentalPool
▸ createResourceRentalPool(draftPool, allocation, options?): ResourceRentalPool
Factory that creates new resource rental pool that's fully configured
Parameters
| Name | Type |
|---|---|
draftPool | DraftOfferProposalPool |
allocation | Allocation |
options? | ResourceRentalPoolOptions |
Returns
Implementation of
RentalModule.createResourceRentalPool