Class RoaringArenaAllocator

Hierarchy

RoaringArenaAllocator

Index

Constructors

Properties

Accessors

escaped size current

Methods

disposeAll escape newRoaringBitmap32 newRoaringBitmap32Iterator newRoaringUint8Array register start stop unregister with start stop with

Constructors

constructor

new RoaringArenaAllocator(): RoaringArenaAllocator
Returns RoaringArenaAllocator
- Defined in index.d.ts:1569

Properties

`Private` #private

#private: any

Accessors

escaped

get escaped(): number
Gets the number of references currently escaped. Escaped references are not disposed when the arena is stopped.

Returns number
The number of escaped references.

See
escape
- Defined in index.d.ts:1564

size

get size(): number
Gets the number of references currently registered.

Returns number
The number of references, escaped or not.
- Defined in index.d.ts:1557

`Static` current

get current(): null | RoaringArenaAllocator
Returns null | RoaringArenaAllocator
- Defined in index.d.ts:1539

Methods

disposeAll

disposeAll(): number
Returns number
- Defined in index.d.ts:1570

escape

escape<T>(disposable): T
Type Parameters
- T extends IDisposable
Parameters
- disposable: T
Returns T
- Defined in index.d.ts:1576

newRoaringBitmap32

newRoaringBitmap32(valuesOrCapacity?): RoaringBitmap32
Parameters
- Optional valuesOrCapacity: null | number | RoaringBitmap32 | BasicTypedArray | Iterable<undefined | null | string | number | false> | readonly (undefined | null | string | number | false)[]
Returns RoaringBitmap32
- Defined in index.d.ts:1588

newRoaringBitmap32Iterator

newRoaringBitmap32Iterator(bitmap?): RoaringBitmap32Iterator
Parameters
- Optional bitmap: null | RoaringBitmap32
Returns RoaringBitmap32Iterator
- Defined in index.d.ts:1585

newRoaringUint8Array

newRoaringUint8Array(lengthOrArray?): RoaringUint8Array
Parameters
- Optional lengthOrArray: null | number | ArrayLike<number> | Iterable<number>
Returns RoaringUint8Array
- Defined in index.d.ts:1577

register

register<T>(disposable): T
Type Parameters
- T extends IDisposable
Parameters
- disposable: T
Returns T
- Defined in index.d.ts:1574

start

start(): RoaringArenaAllocator
Returns RoaringArenaAllocator
- Defined in index.d.ts:1571

stop

stop(): RoaringArenaAllocator
Returns RoaringArenaAllocator
- Defined in index.d.ts:1572

unregister

unregister(disposable): boolean
Parameters
- disposable: undefined | null | IDisposable
Returns boolean
- Defined in index.d.ts:1575

with

with<T>(fn): T
Type Parameters
- T
Parameters
- fn: ((allocator) => T)
  - - (allocator): T
    - Parameters
      
      allocator: RoaringArenaAllocator
      
      Returns T
Returns T
- Defined in index.d.ts:1573

`Static` start

start(): RoaringArenaAllocator
Starts a new arena allocator.

Returns RoaringArenaAllocator
The new arena allocator.
- Defined in index.d.ts:1544

`Static` stop

stop(): null | RoaringArenaAllocator
Stops the current arena allocator.

Returns null | RoaringArenaAllocator
The stopped arena allocator.
See
- start
- current
- with
- Defined in index.d.ts:1552

`Static` with

with(fn, allocator?): void
Parameters
- fn: ((allocator) => void)
  - - (allocator): void
    - Parameters
      
      allocator: RoaringArenaAllocator
      
      Returns void
- Optional allocator: RoaringArenaAllocator
Returns void
- Defined in index.d.ts:1565

Generated using TypeDoc