Class ValueEmbedder<T>

ValueEmbedder is the writeable version of optional, it basically is a wrapper around a construct which has a state and can be written to.

For the readonly version see Optional

Type Parameters

Hierarchy (View Summary)

Optional<T>
- ValueEmbedder
  - ElementAttribute

Implements

IValueHolder<T>

Index

Constructors

constructor

new ValueEmbedder<T>(rootElem: any, valueKey?: string): ValueEmbedder<T>
Type Parameters
- T
Parameters
- rootElem: any
- valueKey: string = "value"
Returns ValueEmbedder<T>
Overrides Optional.constructor
- Defined in Monad.ts:366

Properties

`Static`absent

absent: Optional<unknown> = ...

Accessors

value

get value(): T
Returns T
Implementation of IValueHolder.value
Overrides Optional.value
- Defined in Monad.ts:372
set value(newVal: T): void
Parameters
- newVal: T
Returns void
Implementation of IValueHolder.value
Overrides Optional.value
- Defined in Monad.ts:376

Methods

flatMap

flatMap<R>(fn?: (data: T) => R): Optional<any>
Type Parameters
- R
Parameters
- Optionalfn: (data: T) => R
Returns Optional<any>
Inherited from Optional.flatMap
- Defined in Monad.ts:178

get

get<R>(defaultVal?: any): Optional<R>
convenience function to flatmap the internal value and replace it with a default in case of being absent
Type Parameters
- R
Parameters
- defaultVal: any = Optional.absent
Returns Optional<R>
Inherited from Optional.get
- Defined in Monad.ts:249

getIf

getIf<R>(...key: string[]): Optional<R>
Type Parameters
- R
Parameters
- ...key: string[]
Returns Optional<R>
Inherited from Optional.getIf
- Defined in Monad.ts:191

getIfPresent

getIfPresent<R>(key: string): Optional<R>
additional syntactic sugar which is not part of the usual optional implementation but makes life easier, if you want to sacrifice typesafety and refactoring capabilities in typescript
Type Parameters
- R
Parameters
- key: string
Returns Optional<R>
Inherited from Optional.getIfPresent
- Defined in Monad.ts:299

ifPresentLazy

ifPresentLazy(presentRunnable?: (val?: Optional<T>) => void): Optional<T>
Parameters
- presentRunnable: (val?: Optional<T>) => void = ...
Returns Optional<T>
Inherited from Optional.ifPresentLazy
- Defined in Monad.ts:143

isAbsent

isAbsent(): boolean
Returns boolean
Inherited from Optional.isAbsent
- Defined in Monad.ts:128

isPresent

isPresent(presentRunnable?: (val?: Optional<T>) => void): boolean
any value present
Parameters
- OptionalpresentRunnable: (val?: Optional<T>) => void
Returns boolean
Inherited from Optional.isPresent
- Defined in Monad.ts:135

map

map<R>(fn?: (data: T | null | undefined) => R): Monad<R>
Type Parameters
- R
Parameters
- Optionalfn: (data: T | null | undefined) => R
Returns Monad<R>
Inherited from Optional.map
- Defined in Monad.ts:84

match

match(fn: (item: T) => boolean): boolean
simple match, if the first order function call returns true then there is a match, if the value is not present it never matches
Parameters
- fn: (item: T) => boolean
  the first order function performing the match
Returns boolean
Inherited from Optional.match
- Defined in Monad.ts:235

orElse

orElse(elseValue: any): Optional<any>
Parameters
- elseValue: any
Returns Optional<any>
Overrides Optional.orElse
- Defined in Monad.ts:383

orElseLazy

orElseLazy(func: () => any): Optional<any>
lazy, passes a function which then is lazily evaluated instead of a direct value
Parameters
- func: () => any
Returns Optional<any>
Overrides Optional.orElseLazy
- Defined in Monad.ts:389

resolve

resolve<V>(resolver: (item: T) => V): Optional<V>
elvis like typesafe functional save resolver a typesafe option for getIfPresent

usage myOptional.resolve(value => value.subAttr.subAttr2).orElseLazy(....) if this is resolvable without any errors an Optional with the value is returned if not, then an Optional absent is returned, also if you return Optional absent it is flatmapped into absent
Type Parameters
- V
Parameters
- resolver: (item: T) => V
  the resolver function, can throw any arbitrary errors, int the error case the resolution goes towards absent
Returns Optional<V>
Inherited from Optional.resolve
- Defined in Monad.ts:318

toJson

toJson(): string
Returns string
Inherited from Optional.toJson
- Defined in Monad.ts:257

`Static`fromNullable

fromNullable<V extends Optional<T>, T>(value?: any, valueKey?: string): V
Type Parameters
- V extends Optional<T>
- T
Parameters
- Optionalvalue: any
- valueKey: string = "value"
Returns V
Overrides Optional.fromNullable
- Defined in Monad.ts:410

Class ValueEmbedder<T>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ValueEmbedder<T>

Properties

Staticabsent

Accessors

value

Returns T

Parameters

Returns void

Methods

flatMap

Type Parameters

Parameters

Returns Optional<any>

get

Type Parameters

Parameters

Returns Optional<R>

getIf

Type Parameters

Parameters

Returns Optional<R>

getIfPresent

Type Parameters

Parameters

Returns Optional<R>

ifPresentLazy

Parameters

Returns Optional<T>

isAbsent

Returns boolean

isPresent

Parameters

Returns boolean

map

Type Parameters

Parameters

Returns Monad<R>

match

Parameters

Returns boolean

orElse

Parameters

Returns Optional<any>

orElseLazy

Parameters

Returns Optional<any>

resolve

Type Parameters

Parameters

Returns Optional<V>

toJson

Returns string

StaticfromNullable

Type Parameters

Parameters

Returns V

Settings

On This Page

`Static`absent

`Static`fromNullable