Class Some<A>

Type parameters

A

Hierarchy

Some

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Some(value: A): Some

- Defined in node_modules/fp-ts/lib/Option.d.ts:75
Parameters
- value: A
Returns Some

Properties

_A

_A: A

_URI

_URI: URI

_tag

_tag: "Some"

value

value: A

Methods

alt

alt(fa: Option<A>): Option<A>

- Defined in node_modules/fp-ts/lib/Option.d.ts:95
Parameters
- fa: Option<A>
Returns Option<A>

ap

ap<B>(fab: Option<function>): Option<B>

- Defined in node_modules/fp-ts/lib/Option.d.ts:80
Type parameters
- B
Parameters
- fab: Option<function>
Returns Option<B>

ap_

ap_<B, C>(this: Option<function>, fb: Option<B>): Option<C>

- Defined in node_modules/fp-ts/lib/Option.d.ts:81
Type parameters
- B
- C
Parameters
- this: Option<function>
- fb: Option<B>
Returns Option<C>

chain

chain<B>(f: function): Option<B>

- Defined in node_modules/fp-ts/lib/Option.d.ts:82
Type parameters
- B
Parameters
- f: function
  - - (a: A): Option<B>
    - Parameters
      - a: A
      Returns Option<B>
Returns Option<B>

concat

concat(S: Semigroup<A>): function

- Defined in node_modules/fp-ts/lib/Option.d.ts:100
Parameters
- S: Semigroup<A>
Returns function
- - (fy: Option<A>): Option<A>
  - Parameters
    - fy: Option<A>
    Returns Option<A>

contains

contains(S: Setoid<A>, a: A): boolean

- Defined in node_modules/fp-ts/lib/Option.d.ts:107
Returns true if the option has an element that is equal (as determined by S) to a, false otherwise

Parameters
- S: Setoid<A>
- a: A
Returns boolean

equals

equals(S: Setoid<A>): function

- Defined in node_modules/fp-ts/lib/Option.d.ts:101
Parameters
- S: Setoid<A>
Returns function
- - (fy: Option<A>): boolean
  - Parameters
    - fy: Option<A>
    Returns boolean

exists

exists(p: function): boolean

- Defined in node_modules/fp-ts/lib/Option.d.ts:113
Returns true if this option is non empty and the predicate p returns true when applied to this Option's value

Parameters
- p: function
  - - (a: A): boolean
    - Parameters
      - a: A
      Returns boolean
Returns boolean

extend

extend<B>(f: function): Option<B>

- Defined in node_modules/fp-ts/lib/Option.d.ts:96
Type parameters
- B
Parameters
- f: function
  - - (ea: Option<A>): B
    - Parameters
      - ea: Option<A>
      Returns B
Returns Option<B>

filter

filter(p: Predicate<A>): Option<A>

- Defined in node_modules/fp-ts/lib/Option.d.ts:115
Returns this option if it is non empty and the predicate p return true when applied to this Option's value. Otherwise returns None

Parameters
- p: Predicate<A>
Returns Option<A>

fold

fold<B>(n: Lazy<B>, s: function): B

- Defined in node_modules/fp-ts/lib/Option.d.ts:97
Type parameters
- B
Parameters
- n: Lazy<B>
- s: function
  - - (a: A): B
    - Parameters
      - a: A
      Returns B
Returns B

getOrElse

getOrElse(f: Lazy<A>): A

- Defined in node_modules/fp-ts/lib/Option.d.ts:98
Parameters
- f: Lazy<A>
Returns A

getOrElseValue

getOrElseValue(value: A): A

- Defined in node_modules/fp-ts/lib/Option.d.ts:99
Parameters
- value: A
Returns A

inspect

inspect(): string

- Defined in node_modules/fp-ts/lib/Option.d.ts:104
Returns string

isNone

isNone(): boolean

- Defined in node_modules/fp-ts/lib/Option.d.ts:109
Returns true if the option is None, false otherwise

Returns boolean

isSome

isSome(): boolean

- Defined in node_modules/fp-ts/lib/Option.d.ts:111
Returns true if the option is an instance of Some, false otherwise

Returns boolean

map

map<B>(f: function): Option<B>

- Defined in node_modules/fp-ts/lib/Option.d.ts:77
Type parameters
- B
Parameters
- f: function
  - - (a: A): B
    - Parameters
      - a: A
      Returns B
Returns Option<B>

mapNullable

mapNullable<B>(f: function): Option<B>

- Defined in node_modules/fp-ts/lib/Option.d.ts:79
Maps f over this Option's value. If the value returned from f is null or undefined, returns None

Type parameters
- B
Parameters
- f: function
  - - (a: A): B | null | undefined
    - Parameters
      - a: A
      Returns B | null | undefined
Returns Option<B>

partitionMap

partitionMap<L, R>(f: function): object

- Defined in node_modules/fp-ts/lib/Option.d.ts:87
Type parameters
- L
- R
Parameters
- f: function
  - - (a: A): Either<L, R>
    - Parameters
      - a: A
      Returns Either<L, R>
Returns object

reduce

reduce<B>(f: function, b: B): B

- Defined in node_modules/fp-ts/lib/Option.d.ts:83
Type parameters
- B
Parameters
- f: function
  - - (b: B, a: A): B
    - Parameters
      - b: B
      - a: A
      Returns B
- b: B
Returns B

toNullable

toNullable(): A | null

- Defined in node_modules/fp-ts/lib/Option.d.ts:102
Returns A | null

toString

toString(): string

- Defined in node_modules/fp-ts/lib/Option.d.ts:105
Returns string

toUndefined

toUndefined(): A | undefined

- Defined in node_modules/fp-ts/lib/Option.d.ts:103
Returns A | undefined

traverse

traverse<F>(F: Applicative<F>): function
traverse<F>(F: Applicative<F>): function
traverse<F>(F: Applicative<F>): function

- Defined in node_modules/fp-ts/lib/Option.d.ts:84
Type parameters
- F: HKT2S
Parameters
- F: Applicative<F>
Returns function
- - <L, B>(f: function): HKT2As<F, L, Option<B>>
  - Type parameters
    - L
    - B
    Parameters
    - f: function
      - (a: A): HKT2As<F, L, B>
        
        Parameters
        
        a: A
        
        Returns HKT2As<F, L, B>
    Returns HKT2As<F, L, Option<B>>
- Defined in node_modules/fp-ts/lib/Option.d.ts:85
Type parameters
- F: HKTS
Parameters
- F: Applicative<F>
Returns function
- - <B>(f: function): HKTAs<F, Option<B>>
  - Type parameters
    - B
    Parameters
    - f: function
      - (a: A): HKTAs<F, B>
        
        Parameters
        
        a: A
        
        Returns HKTAs<F, B>
    Returns HKTAs<F, Option<B>>
- Defined in node_modules/fp-ts/lib/Option.d.ts:86
Type parameters
- F
Parameters
- F: Applicative<F>
Returns function
- - <B>(f: function): HKT<F, Option<B>>
  - Type parameters
    - B
    Parameters
    - f: function
      - (a: A): HKT<F, B>
        
        Parameters
        
        a: A
        
        Returns HKT<F, B>
    Returns HKT<F, Option<B>>

wilt

wilt<M>(M: Applicative<M>): function

- Defined in node_modules/fp-ts/lib/Option.d.ts:91
Type parameters
- M
Parameters
- M: Applicative<M>
Returns function
- - <L, R>(f: function): HKT<M, object>
  - Type parameters
    - L
    - R
    Parameters
    - f: function
      - (a: A): HKT<M, Either<L, R>>
        
        Parameters
        
        a: A
        
        Returns HKT<M, Either<L, R>>
    Returns HKT<M, object>

Generated using TypeDoc