WeakLifetime.md

quickjs-emscripten • quickjs-emscripten-core • Readme | Exports

---

quickjs-emscripten / quickjs-emscripten-core / WeakLifetime

Class: WeakLifetime<T, TCopy, Owner>

A Lifetime that does not own its value. A WeakLifetime never calls its disposer function, but can be duped to produce regular lifetimes that do.

Used for function arguments.

Contents

• Extends
• Type parameters
• Constructors
  • new WeakLifetime(value, copier, disposer, owner)
• Properties
  • _alive
  • _constructorStack
  • _owner?
  • _value
  • copier?
  • disposer?
• Accessors
  • alive
  • dupable
  • owner
  • value
• Methods
  • [dispose]()
  • consume()
  • dispose()
  • dup()
  • map()
  • tap()

Extends

• Lifetime<T, TCopy, Owner>

Type parameters

• T

• TCopy = never

• Owner = never

Constructors

new WeakLifetime(value, copier, disposer, owner)

new WeakLifetime<T, TCopy, Owner>(value, copier?, disposer?, owner?): WeakLifetime<T, TCopy, Owner>

Parameters

• value: T

• copier?: (value) => TCopy

• disposer?: (value) => void

• owner?: Owner

Returns

WeakLifetime<T, TCopy, Owner>

Overrides

quickjs-emscripten-core.Lifetime.constructor

Source

packages/quickjs-emscripten-core/src/lifetime.ts:224

Properties

_alive

protected _alive: boolean = true

Inherited from

quickjs-emscripten-core.Lifetime._alive

Source

packages/quickjs-emscripten-core/src/lifetime.ts:72

---

_constructorStack

protected _constructorStack: undefined | string

Inherited from

quickjs-emscripten-core.Lifetime._constructorStack

Source

packages/quickjs-emscripten-core/src/lifetime.ts:73

---

_owner?

protected readonly _owner?: Owner

Inherited from

quickjs-emscripten-core.Lifetime._owner

Source

packages/quickjs-emscripten-core/src/lifetime.ts:87

---

_value

protected readonly _value: T

Inherited from

quickjs-emscripten-core.Lifetime._value

Source

packages/quickjs-emscripten-core/src/lifetime.ts:84

---

copier?

protected readonly copier?: (value) => TCopy

Parameters

• value: T | TCopy

Returns

TCopy

Inherited from

quickjs-emscripten-core.Lifetime.copier

Source

packages/quickjs-emscripten-core/src/lifetime.ts:85

---

disposer?

protected readonly disposer?: (value) => void

Parameters

• value: T | TCopy

Returns

void

Inherited from

quickjs-emscripten-core.Lifetime.disposer

Source

packages/quickjs-emscripten-core/src/lifetime.ts:86

Accessors

alive

get alive(): boolean

Returns

boolean

true if the object is alive

false after the object has been disposed

Source

packages/quickjs-emscripten-core/src/lifetime.ts:92

---

dupable

get dupable(): boolean

Returns

boolean

Source

packages/quickjs-emscripten-core/src/lifetime.ts:111

---

owner

get owner(): undefined | Owner

Returns

undefined | Owner

Source

packages/quickjs-emscripten-core/src/lifetime.ts:107

---

value

get value(): T

The value this Lifetime protects. You must never retain the value - it may become invalid, leading to memory errors.

Throws

If the lifetime has been disposed already.

Returns

T

Source

packages/quickjs-emscripten-core/src/lifetime.ts:102

Methods

[dispose]()

[dispose](): void

Just calls the standard .dispose() method of this class.

Returns

void

Inherited from

quickjs-emscripten-core.Lifetime.[dispose]

Source

packages/quickjs-emscripten-core/src/lifetime.ts:47

---

consume()

consume(map)

consume<O>(map): O

Call map with this lifetime, then dispose the lifetime.

Type parameters

• O

Parameters

• map: (lifetime) => O

Returns

O

the result of map(this).

Inherited from

quickjs-emscripten-core.Lifetime.consume

Source

packages/quickjs-emscripten-core/src/lifetime.ts:135

consume(map)

consume<O>(map): O

Type parameters

• O

Parameters

• map: (lifetime) => O

Returns

O

Inherited from

quickjs-emscripten-core.Lifetime.consume

Source

packages/quickjs-emscripten-core/src/lifetime.ts:138

---

dispose()

dispose(): void

Dispose of value and perform cleanup.

Returns

void

Overrides

quickjs-emscripten-core.Lifetime.dispose

Source

packages/quickjs-emscripten-core/src/lifetime.ts:234

---

dup()

dup(): Lifetime<TCopy, TCopy, Owner>

Create a new handle pointing to the same value.

Returns

Lifetime<TCopy, TCopy, Owner>

Inherited from

quickjs-emscripten-core.Lifetime.dup

Source

packages/quickjs-emscripten-core/src/lifetime.ts:118

---

map()

map(map)

map<O>(map): O

Call map with this lifetime, returning the result. Does not dispose the lifetime.

Type parameters

• O

Parameters

• map: (lifetime) => O

Returns

O

the result of map(this).

Inherited from

quickjs-emscripten-core.Lifetime.map

Source

packages/quickjs-emscripten-core/src/lifetime.ts:151

map(map)

map<O>(map): O

Type parameters

• O

Parameters

• map: (lifetime) => O

Returns

O

Inherited from

quickjs-emscripten-core.Lifetime.map

Source

packages/quickjs-emscripten-core/src/lifetime.ts:152

---

tap()

tap(fn)

tap(fn): WeakLifetime<T, TCopy, Owner>

Call fn with this lifetime, then return this. Does not dispose the lifetime. Useful for imperative operations within an expression, like when you're building up objects, or to add logging in the middle of a call chain.

Parameters

• fn: (lifetime) => void

Returns

WeakLifetime<T, TCopy, Owner>

this

Inherited from

quickjs-emscripten-core.Lifetime.tap

Source

packages/quickjs-emscripten-core/src/lifetime.ts:164

tap(fn)

tap(fn): QuickJSHandle

Parameters

• fn: (lifetime) => void

Returns

QuickJSHandle

Inherited from

quickjs-emscripten-core.Lifetime.tap

Source

packages/quickjs-emscripten-core/src/lifetime.ts:165

---

Generated using typedoc-plugin-markdown and TypeDoc