Class PoolUser<V>

A use of a pool resource

Has two events, disposed and released.

Type Parameters

V

Hierarchy (View Summary)

SimpleEventEmitter<PoolUserEventMap<V>>
- PoolUser

Index

Accessors

data elapsed isDisposed isExpired isValid

Constructors

Methods

_dispose addEventListener dispose fireEvent keepAlive release removeEventListener toString

Properties

Accessors

data

get data(): V
Returns V
- Defined in flow/src/pool.ts:140

elapsed

get elapsed(): number
Returns elapsed time since last 'update'

Returns number
- Defined in flow/src/pool.ts:159

isDisposed

get isDisposed(): boolean
Returns true if instance is disposed

Returns boolean
Overrides SimpleEventEmitter.isDisposed
- Defined in flow/src/pool.ts:166

isExpired

get isExpired(): boolean
Returns true if this instance has expired. Expiry counts if elapsed time is greater than userExpireAfterMs

Returns boolean
- Defined in flow/src/pool.ts:149

isValid

get isValid(): boolean
Returns true if instance is neither disposed nor expired

Returns boolean
- Defined in flow/src/pool.ts:173

Constructors

constructor

new PoolUser<V>(key: string, resource: Resource<V>): PoolUser<V>
Constructor
Type Parameters
- V
Parameters
- key: string
  User key
- resource: Resource<V>
  Resource being used
Returns PoolUser<V>
Overrides SimpleEventEmitter.constructor
- Defined in flow/src/pool.ts:82

Methods

_dispose

_dispose(reason: string, data: V): void
Internal
Parameters
- reason: string
- data: V
Returns void
- Defined in flow/src/pool.ts:115

addEventListener

addEventListener<K extends keyof PoolUserEventMap<V>>(
    name: K,
    listener: (
        event: PoolUserEventMap<V>[K],
        sender: SimpleEventEmitter<PoolUserEventMap<V>>,
    ) => void,
): void
Adds event listener.
Type Parameters
- K extends keyof PoolUserEventMap<V>
  Events
Parameters
- name: K
  Event name
- listener: (
  event: PoolUserEventMap<V>[K],
  sender: SimpleEventEmitter<PoolUserEventMap<V>>,
  ) => void
  Event handler
Returns void
Throws
Error if emitter is disposed
Inherited from SimpleEventEmitter.addEventListener
- Defined in events/src/simple-event-emitter.ts:39

dispose

dispose(): void
Returns void
Inherited from SimpleEventEmitter.dispose
- Defined in events/src/simple-event-emitter.ts:8

`Protected`fireEvent

fireEvent<K extends keyof PoolUserEventMap<V>>(
type: K,
args: PoolUserEventMap<V>[K],
): void
Fire event
Type Parameters
- K extends keyof PoolUserEventMap<V>
Parameters
- type: K
  Type of event
- args: PoolUserEventMap<V>[K]
  Arguments for event
Returns void
Inherited from SimpleEventEmitter.fireEvent
- Defined in events/src/simple-event-emitter.ts:23

keepAlive

keepAlive(): void
Resets countdown for instance expiry. Throws an error if instance is disposed.

Returns void
- Defined in flow/src/pool.ts:105

release

release(reason: string): void
Release this instance
Parameters
- reason: string
Returns void
- Defined in flow/src/pool.ts:130

removeEventListener

removeEventListener<K extends keyof PoolUserEventMap<V>>(
    type: K,
    listener: (
        event: PoolUserEventMap<V>[K],
        sender: SimpleEventEmitter<PoolUserEventMap<V>>,
    ) => void,
): void
Remove event listener
Type Parameters
- K extends keyof PoolUserEventMap<V>
Parameters
- type: K
- listener: (
  event: PoolUserEventMap<V>[K],
  sender: SimpleEventEmitter<PoolUserEventMap<V>>,
  ) => void
Returns void
Inherited from SimpleEventEmitter.removeEventListener
- Defined in events/src/simple-event-emitter.ts:55

toString

toString(): string
Returns a human readable debug string

Returns string
- Defined in flow/src/pool.ts:95

Properties

`Readonly`key

key: string

User key

`Readonly`resource

resource: Resource<V>

Resource being used