Interface IWeakOption<B, T>

interface IWeakOption<B extends object, 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): T | undefined;
}

Type Parameters

B extends object
T

Implemented by

Index

Methods

has unwrapForce unwrapOrDefault unwrapOrElse unwrapOrUndefined

Methods

has

has(base: B): 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:56

unwrapForce

unwrapForce(base: B): 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:40

unwrapOrDefault

unwrapOrDefault(base: B, altValue: T): 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:22

unwrapOrElse

unwrapOrElse(base: B, f: (...vals: any) => T): 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
Returns T
The stored value or the result of the function
- Defined in foundation/misc/WeakOption.ts:31

unwrapOrUndefined

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