Class InterestMap<DTInterestId, DTInterestFullfillment>

Type parameters

DTInterestId
DTInterestFullfillment

Hierarchy

InterestMap

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new InterestMap<DTInterestId, DTInterestFullfillment>(comparisonFuncArg: IInterestComparisonFunc<DTInterestId>, optionsArg?: IInterestMapOptions): InterestMap<DTInterestId, DTInterestFullfillment>

- Defined in lik.interestmap.ts:33
Type parameters
- DTInterestId
- DTInterestFullfillment
Parameters
- comparisonFuncArg: IInterestComparisonFunc<DTInterestId>
- optionsArg: IInterestMapOptions = {}
Returns InterestMap<DTInterestId, DTInterestFullfillment>

Properties

Private comparisonFunc

comparisonFunc: IInterestComparisonFunc<DTInterestId>

a function to compare interests

Private interestObjectMap

interestObjectMap: ObjectMap<Interest<DTInterestId, DTInterestFullfillment>> = ...

stores interests that are currently fullfilled by the cache

interestObservable

interestObservable: ObservableIntake<Interest<DTInterestId, any>> = ...

options

options: IInterestMapOptions

Methods

addInterest

addInterest(interestId: DTInterestId, defaultFullfillmentArg?: DTInterestFullfillment): Promise<Interest<DTInterestId, DTInterestFullfillment>>

- Defined in lik.interestmap.ts:47
adds an interest to the InterestMap

Parameters
- interestId: DTInterestId
- Optional defaultFullfillmentArg: DTInterestFullfillment
Returns Promise<Interest<DTInterestId, DTInterestFullfillment>>

checkInterest

checkInterest(objectArg: DTInterestId): boolean

- Defined in lik.interestmap.ts:93
check interest

Parameters
- objectArg: DTInterestId
Returns boolean

checkInterestByString

checkInterestByString(comparisonStringArg: string): boolean

- Defined in lik.interestmap.ts:102
checks an interest

Parameters
- comparisonStringArg: string
Returns boolean

findInterest

findInterest(interestId: DTInterestId): Interest<DTInterestId, DTInterestFullfillment>

- Defined in lik.interestmap.ts:128
finds an interest

Parameters
- interestId: DTInterestId
Returns Interest<DTInterestId, DTInterestFullfillment>

informLostInterest

informLostInterest(interestId: DTInterestId): void

- Defined in lik.interestmap.ts:117
inform lost interest

Parameters
- interestId: DTInterestId
Returns void

removeInterest

removeInterest(interestArg: Interest<DTInterestId, DTInterestFullfillment>): void

- Defined in lik.interestmap.ts:84
removes an interest from the interest map

Parameters
- interestArg: Interest<DTInterestId, DTInterestFullfillment>
Returns void

Generated using TypeDoc