Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Interest<DTInterestId, DTInterestFullfillment>

Type parameters

  • DTInterestId

  • DTInterestFullfillment

Hierarchy

  • Interest

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Interest<DTInterestId, DTInterestFullfillment>(interestMapArg: InterestMap<DTInterestId, DTInterestFullfillment>, interestArg: DTInterestId, comparisonFuncArg: IInterestComparisonFunc<DTInterestId>, optionsArg?: IInterestOptions<DTInterestFullfillment>): Interest<DTInterestId, DTInterestFullfillment>

  • Type parameters

    • DTInterestId

    • DTInterestFullfillment

    Parameters

    Returns Interest<DTInterestId, DTInterestFullfillment>

Properties

comparisonFunc

comparisonFunc: IInterestComparisonFunc<DTInterestId>

destructionTimer

destructionTimer: Timer = ...

fullfillmentStore

fullfillmentStore: any[] = []

a generic store to store objects in that are needed for fullfillment;

Private interestDeferred

interestDeferred: Deferred<DTInterestFullfillment> = ...

interestFullfilled

interestFullfilled: Promise<DTInterestFullfillment> = ...

Private interestMapRef

interestMapRef: InterestMap<DTInterestId, DTInterestFullfillment>

isFullfilled

isFullfilled: boolean = false

options

options: IInterestOptions<DTInterestFullfillment>

originalInterest

originalInterest: DTInterestId

Accessors

comparisonString

  • get comparisonString(): string

  • quick access to a string that makes the interest comparable for checking for similar interests

    Returns string

Methods

destroy

  • destroy(): void

  • self destructs the interest

    Returns void

fullfillInterest

  • fullfillInterest(objectArg: DTInterestFullfillment): void

  • fullfill the interest

    Parameters

    • objectArg: DTInterestFullfillment

    Returns void

markLost

  • markLost(): void

  • notifies the interest that the interest in it has been lost

    Returns void

renew

  • renew(): void

  • notifies the interest that the interest in it has been restored

    Returns void

Generated using TypeDoc