Class InMemoryBuffer

Hierarchy

TypedEmitter<IInMemBufferEvents>
- InMemoryBuffer

Index

Constructors

Properties

#buffer #iter #lock #options #waitQueue defaultMaxListeners

Accessors

isEmpty options size

Constructors

constructor

new InMemoryBuffer(options): InMemoryBuffer
Parameters
- options: IInMemoryBufferOptions
Returns InMemoryBuffer
Overrides TypedEmitter<IInMemBufferEvents>.constructor
- Defined in src/structs/InMemBuffer.ts:24

Properties

`Private` #buffer

#buffer: OrderedMap<PossibleKeyType, DataNode>

`Private` #iter

#iter: OrderedMapIterator<PossibleKeyType, DataNode>

`Private` #lock

#lock: boolean = false

`Private` #options

#options: IInMemoryBufferOptions

`Private` #waitQueue

#waitQueue: [PossibleKeyType, DataNode][] = []

`Static` defaultMaxListeners

defaultMaxListeners: number

Accessors

isEmpty

get isEmpty(): boolean
Returns boolean
- Defined in src/structs/InMemBuffer.ts:35

options

get options(): IInMemoryBufferOptions
Returns IInMemoryBufferOptions
- Defined in src/structs/InMemBuffer.ts:39

size

get size(): number
Returns number
- Defined in src/structs/InMemBuffer.ts:31

Methods

addListener

addListener<U>(event, listener): this
Type Parameters
- U extends keyof IInMemBufferEvents
Parameters
- event: U
- listener: IInMemBufferEvents[U]
Returns this
Inherited from TypedEmitter.addListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:11

clear

clear(): void
Returns void
- Defined in src/structs/InMemBuffer.ts:84

emit

emit<U>(event, ...args): boolean
Type Parameters
- U extends keyof IInMemBufferEvents
Parameters
- event: U
- Rest ...args: Parameters<IInMemBufferEvents[U]>
Returns boolean
Inherited from TypedEmitter.emit
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:19

eventNames

eventNames<U>(): U[]
Type Parameters
- U extends keyof IInMemBufferEvents
Returns U[]
Inherited from TypedEmitter.eventNames
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:20

flush

flush(): Uint8Array[]
Returns Uint8Array[]
- Defined in src/structs/InMemBuffer.ts:67

get

get(key): undefined | DataNode
Parameters
- key: PossibleKeyType
Returns undefined | DataNode
- Defined in src/structs/InMemBuffer.ts:63

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from TypedEmitter.getMaxListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:24

has

has(key): boolean
Parameters
- key: PossibleKeyType
Returns boolean
- Defined in src/structs/InMemBuffer.ts:59

insert

insert(data): void
Parameters
- data: DataNode
Returns void
- Defined in src/structs/InMemBuffer.ts:47

isLocked

isLocked(): boolean
Returns boolean
- Defined in src/structs/InMemBuffer.ts:43

listenerCount

listenerCount(type): number
Parameters
- type: keyof IInMemBufferEvents
Returns number
Inherited from TypedEmitter.listenerCount
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:21

listeners

listeners<U>(type): IInMemBufferEvents[U][]
Type Parameters
- U extends keyof IInMemBufferEvents
Parameters
- type: U
Returns IInMemBufferEvents[U][]
Inherited from TypedEmitter.listeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:22

off

off<U>(event, listener): this
Type Parameters
- U extends keyof IInMemBufferEvents
Parameters
- event: U
- listener: IInMemBufferEvents[U]
Returns this
Inherited from TypedEmitter.off
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:18

on

on<U>(event, listener): this
Type Parameters
- U extends keyof IInMemBufferEvents
Parameters
- event: U
- listener: IInMemBufferEvents[U]
Returns this
Inherited from TypedEmitter.on
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:17

once

once<U>(event, listener): this
Type Parameters
- U extends keyof IInMemBufferEvents
Parameters
- event: U
- listener: IInMemBufferEvents[U]
Returns this
Inherited from TypedEmitter.once
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:16

prependListener

prependListener<U>(event, listener): this
Type Parameters
- U extends keyof IInMemBufferEvents
Parameters
- event: U
- listener: IInMemBufferEvents[U]
Returns this
Inherited from TypedEmitter.prependListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:12

prependOnceListener

prependOnceListener<U>(event, listener): this
Type Parameters
- U extends keyof IInMemBufferEvents
Parameters
- event: U
- listener: IInMemBufferEvents[U]
Returns this
Inherited from TypedEmitter.prependOnceListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:13

rawListeners

rawListeners<U>(type): IInMemBufferEvents[U][]
Type Parameters
- U extends keyof IInMemBufferEvents
Parameters
- type: U
Returns IInMemBufferEvents[U][]
Inherited from TypedEmitter.rawListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:23

removeAllListeners

removeAllListeners(event?): this
Parameters
- Optional event: keyof IInMemBufferEvents
Returns this
Inherited from TypedEmitter.removeAllListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:15

removeListener

removeListener<U>(event, listener): this
Type Parameters
- U extends keyof IInMemBufferEvents
Parameters
- event: U
- listener: IInMemBufferEvents[U]
Returns this
Inherited from TypedEmitter.removeListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:14

setMaxListeners

setMaxListeners(n): this
Parameters
- n: number
Returns this
Inherited from TypedEmitter.setMaxListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:25

stats

stats(): {
    isEmpty: boolean;
    lock: boolean;
    size: number;
}
Returns {
    isEmpty: boolean;
    lock: boolean;
    size: number;
}
- isEmpty: boolean
- lock: boolean
- size: number
- Defined in src/structs/InMemBuffer.ts:90

`Static` defaultOptions

defaultOptions(): IInMemoryBufferOptions
Returns IInMemoryBufferOptions
- Defined in src/structs/InMemBuffer.ts:18