Class RefCounts<O>

Manually reference-count a collection of objects. Will not keep references to objects with a ref-count of 0.

Type Parameters

O

Index

Constructors

Accessors

[iterator] refs size

Methods

add clear copyFrom count delete has

Constructors

constructor

new RefCounts<O>(): RefCounts<O>
Type Parameters
- O
Returns RefCounts<O>

Accessors

[iterator]

get "[iterator]"(): readonly O[]
Iterator over the reference-counted objects.

Returns readonly O[]
- Defined in util/ref-counts.ts:22

refs

get refs(): readonly O[]
Read-only array of the reference-counted objects.

Returns readonly O[]
- Defined in util/ref-counts.ts:27

size

get size(): number
Number of reference-counted objects.

Returns number
- Defined in util/ref-counts.ts:15

Methods

add

add(o: O): number
Add a reference to o.
Parameters
- o: O
  Object
Returns number
New ref-count for o
- Defined in util/ref-counts.ts:54

clear

clear(): void
Clear all references.

Returns void
- Defined in util/ref-counts.ts:106

copyFrom

copyFrom(other: RefCounts<O>): void
Copy ref-counts from other.
Parameters
- other: RefCounts<O>
  Other instance of RefCounts
Returns void
- Defined in util/ref-counts.ts:95

count

count(o: O): number
Get the ref-count of o
Parameters
- o: O
  Object
Returns number
Ref-count, 0 also if the
- Defined in util/ref-counts.ts:45

delete

delete(o: O, toZero?: boolean): number
Delete a reference to o.
Parameters
- o: O
  Object
- toZero: boolean = false
  Optional, if true, deletes all references to o
Returns number
New ref-count for o
- Defined in util/ref-counts.ts:68

has

has(o: O): boolean
Check if o exists (has a ref-count > 0).
Parameters
- o: O
  Object
Returns boolean
true if ref-count > 0
- Defined in util/ref-counts.ts:36