Class None

A class representing an Option that does not contain a value. This is the "None" variant of the Option type, indicating the absence of a value.

Implements

IOption<never>

Index

Constructors

Methods

andThen doesNotHave has match orElse unwrapForce unwrapOrDefault unwrapOrElse unwrapOrUndefined

Constructors

constructor

new None(): None
Returns None

Methods

andThen

andThen<U>(_f: (value: never) => Option<NonNullable<U>>): Option<NonNullable<U>>
Returns this None instance, ignoring the provided function. Since there's no value to apply the function to, None is returned.
Type Parameters
- U
  The type of the value that would be returned by the function
Parameters
- _f: (value: never) => Option<NonNullable<U>>
Returns Option<NonNullable<U>>
This None instance
Implementation of IOption.andThen
- Defined in foundation/misc/Option.ts:229

doesNotHave

doesNotHave(): this is None
Type guard that always returns true for None instances.

Returns this is None
Always true, indicating this Option contains no value
Implementation of IOption.doesNotHave
- Defined in foundation/misc/Option.ts:316

has

has(): this is Some<never>
Type guard that always returns false for None instances.

Returns this is Some<never>
Always false, indicating this Option contains no value
Implementation of IOption.has
- Defined in foundation/misc/Option.ts:307

match

match<U>(
    obj: {
        None: () => U | NonNullable<U>;
        Some: (value: never) => U | NonNullable<U>;
    },
): U
| NonNullable<U>
Executes the None handler function since this Option contains no value.
Type Parameters
- U
  The return type of the match functions
Parameters
- obj: { None: () => U | NonNullable<U>; Some: (value: never) => U | NonNullable<U> }
  Object containing Some and None handler functions
Returns U | NonNullable<U>
The result of executing obj.None
Implementation of IOption.match
- Defined in foundation/misc/Option.ts:252

orElse

orElse<U>(f: () => Option<NonNullable<U>>): Option<NonNullable<U>>
Returns the result of the provided function since this Option has no value. This provides an alternative Option when the current one is None.
Type Parameters
- U
  The type of the alternative Option
Parameters
- f: () => Option<NonNullable<U>>
  Function that returns an alternative Option
Returns Option<NonNullable<U>>
The result of executing f()
Implementation of IOption.orElse
- Defined in foundation/misc/Option.ts:241

unwrapForce

unwrapForce(): never
Throws an error since this Option contains no value. This method should only be called when you're certain the Option contains a value.

Returns never
Never returns (always throws)

Throws
Always throws since None has no value
Implementation of IOption.unwrapForce
- Defined in foundation/misc/Option.ts:288

unwrapOrDefault

unwrapOrDefault<T>(value: NonNullable<T>): NonNullable<T>
Returns the provided default value since this Option contains no value.
Type Parameters
- T
  The type of the default value
Parameters
- value: NonNullable<T>
  The default value to return
Returns NonNullable<T>
The provided default value
Implementation of IOption.unwrapOrDefault
- Defined in foundation/misc/Option.ts:266

unwrapOrElse

unwrapOrElse<T>(f: () => NonNullable<T>): NonNullable<T>
Returns the result of the provided function since this Option contains no value.
Type Parameters
- T
  The type of the value returned by the function
Parameters
- f: () => NonNullable<T>
  Function that returns a default value
Returns NonNullable<T>
The result of executing f()
Implementation of IOption.unwrapOrElse
- Defined in foundation/misc/Option.ts:277

unwrapOrUndefined

unwrapOrUndefined(): never
Returns undefined since this Option contains no value. This provides interoperability with standard JavaScript nullable patterns.

Returns never
Always undefined
Implementation of IOption.unwrapOrUndefined
- Defined in foundation/misc/Option.ts:298