Interface IWeakOption<B, T>

interface IWeakOption<B, T> {
    has(base: B): boolean;
    unwrapForce(base: B): T;
    unwrapOrDefault(base: B, altValue: T): T;
    unwrapOrElse(base: B, f: ((...vals: any) => T)): T;
    unwrapOrUndefined(base: B): undefined | T;
}

Type Parameters

B extends object
T

Implemented by

Index

Methods

has unwrapForce unwrapOrDefault unwrapOrElse unwrapOrUndefined

Methods

has

has(base): boolean
Checks if a value exists for the given base object.
Parameters
- base: B
  The base object used as a key
Returns boolean
True if the value exists, false otherwise
- Defined in foundation/misc/WeakOption.ts:55

unwrapForce

unwrapForce(base): T
Forcefully unwraps the value, throwing an error if it doesn't exist.
Parameters
- base: B
  The base object used as a key
Returns T
The stored value

Throws
When the value doesn't exist
- Defined in foundation/misc/WeakOption.ts:39

unwrapOrDefault

unwrapOrDefault(base, altValue): T
Unwraps the value or returns a default value if it doesn't exist.
Parameters
- base: B
  The base object used as a key
- altValue: T
  The alternative value to return if the value doesn't exist
Returns T
The stored value or the alternative value
- Defined in foundation/misc/WeakOption.ts:21

unwrapOrElse

unwrapOrElse(base, f): T
Unwraps the value or executes a function to get an alternative value.
Parameters
- base: B
  The base object used as a key
- f: ((...vals: any) => T)
  Function to execute if the value doesn't exist
  - - (...vals): T
    - Parameters
      Rest...vals: any
      Returns T
Returns T
The stored value or the result of the function
- Defined in foundation/misc/WeakOption.ts:30

unwrapOrUndefined

unwrapOrUndefined(base): undefined | T
Unwraps the value or returns undefined if it doesn't exist.
Parameters
- base: B
  The base object used as a key
Returns undefined | T
The stored value or undefined
- Defined in foundation/misc/WeakOption.ts:47