Optional | /plugins/optional.ts | mandarinets@v2.3.2

class Optional

import { Optional } from "https://deno.land/x/mandarinets@v2.3.2/plugins/optional.ts";

The optional class is used to avoid repetitive validation with If's. If an object is present, you can verify this with Optional.isPresent() If An object is not present but you would like to get a default value, you can do this with Optional.orElseGet(defaultValue); This classs allows you to avoid null exceptions.

Constructors

new

Optional()

Type Parameters

Properties

private

value: T | null

"Optionable" object.

Methods

get(): T

Gets the value of the Optional only if it is present. If value is not present, an exception will be thrown.

ifPresent(): boolean

Returns a boolean value of whether the optional value is present.

orElseGet(value: Optional<T> | T): T

Returns the value present in the Optional instance. if @param value is an Optional, it will invoke "get", otherwise it will return the whole value. If not value is present, it will return undefined.

orElseThrows(exception: Error)

Tries to get the value in Optional. If value is not present, it will throw an exception.

toString(): String

Static Properties

private

readonly

EMPTY: Optional<any>

Default empty optional

Static Methods

empty<T>(): Optional<T>

Returns a empty optional

of<T>(value: T): Optional<T>

Creates a new optional from a value which will be the optional's object.

ofNullable<T>(value: T): Optional<T>

Creates a Optional instance. if @param value is provided but it is either null or undefined, then it creates an empty instance of Optional.