Function formatDuration

formatDuration(type: "fixed" | "subscription", duration: number, maxDuration?: number, isChangeable?: boolean): Rent.DurationType
Name
formatDuration

Summary
Returns an object representing a duration in either fixed or subscription format.

Returns
An object representing the duration of a contract.
Parameters
- type: "fixed" | "subscription"
  
  The type of duration. Can be either 'fixed' or 'subscription'.
- duration: number
  
  The length of the contract duration in blocks.
- Optional maxDuration: number
  
  (Optional) The maximum length of the contract subscription duration in blocks. Only applicable for subscriptions.
- isChangeable: boolean = false
  
  (Optional) A boolean indicating if the duration can be changed. Only applicable for subscriptions.
Returns Rent.DurationType
- Defined in src/rent/utils.ts:24

Generated using TypeDoc