pot | @pagopa/ts-commons

Index

Type aliases

Variables

Functions

Type aliases

Pot

Pot<T, E>: None | NoneLoading | NoneUpdating<T> | NoneError<E> | Some<T> | SomeLoading<T> | SomeUpdating<T> | SomeError<T, E>

Type parameters

T
E

PotErrorType

PotErrorType<T>: T extends NoneError<infer E0> ? E0 : T extends SomeError<any, infer E1> ? E1 : never

Type parameters

T

PotType

PotType<T>: T extends Some<infer A0> ? A0 : T extends SomeLoading<infer A1> ? A1 : T extends SomeError<infer A2, any> ? A2 : never

Type parameters

T

Variables

Const none

none: None = ...

Const noneLoading

noneLoading: NoneLoading = ...

Functions

Const filter

filter<A, E>(p: Pot<A, E>, f: (v: A) => boolean): Pot<A, E>

- Defined in src/pot.ts:235
Type parameters
- A
- E = unknown
Parameters
- p: Pot<A, E>
- f: (v: A) => boolean
  - - (v: A): boolean
    - Parameters
      - v: A
      Returns boolean
Returns Pot<A, E>

Const fold

fold<A, E, O>(p: Pot<A, E>, foldNone: () => O, foldNoneLoading: () => O, foldNoneUpdating: (newValue: A) => O, foldNoneError: (error: E) => O, foldSome: (value: A) => O, foldSomeLoading: (value: A) => O, foldSomeUpdating: (value: A, newValue: A) => O, foldSomeError: (value: A, error: E) => O): O

- Defined in src/pot.ts:188
Type parameters
- A
- E
- O
Parameters
- p: Pot<A, E>
- foldNone: () => O
  - - (): O
    - Returns O
- foldNoneLoading: () => O
  - - (): O
    - Returns O
- foldNoneUpdating: (newValue: A) => O
  - - (newValue: A): O
    - Parameters
      - newValue: A
      Returns O
- foldNoneError: (error: E) => O
  - - (error: E): O
    - Parameters
      - error: E
      Returns O
- foldSome: (value: A) => O
  - - (value: A): O
    - Parameters
      - value: A
      Returns O
- foldSomeLoading: (value: A) => O
  - - (value: A): O
    - Parameters
      - value: A
      Returns O
- foldSomeUpdating: (value: A, newValue: A) => O
  - - (value: A, newValue: A): O
    - Parameters
      - value: A
      - newValue: A
      Returns O
- foldSomeError: (value: A, error: E) => O
  - - (value: A, error: E): O
    - Parameters
      - value: A
      - error: E
      Returns O
Returns O

Const getOrElse

getOrElse<A>(p: Pot<A, any>, o: A): A

- Defined in src/pot.ts:259
Type parameters
- A
Parameters
- p: Pot<A, any>
- o: A
Returns A

Const getOrElseWithUpdating

getOrElseWithUpdating<A>(p: Pot<A, any>, o: A): A

- Defined in src/pot.ts:262
Type parameters
- A
Parameters
- p: Pot<A, any>
- o: A
Returns A

Const isError

isError<A, E>(p: Pot<A, E>): p is NoneError<E> | SomeError<A, E>

- Defined in src/pot.ts:168
Type parameters
- A
- E = unknown
Parameters
- p: Pot<A, E>
Returns p is NoneError<E> | SomeError<A, E>

Const isLoading

isLoading<A>(p: Pot<A, any>): p is NoneLoading | SomeLoading<A>

- Defined in src/pot.ts:158
Type parameters
- A
Parameters
- p: Pot<A, any>
Returns p is NoneLoading | SomeLoading<A>

Const isNone

isNone<A, E>(p: Pot<A, E>): p is None | NoneLoading | NoneUpdating<A> | NoneError<E>

- Defined in src/pot.ts:150
Type parameters
- A
- E = unknown
Parameters
- p: Pot<A, E>
Returns p is None | NoneLoading | NoneUpdating<A> | NoneError<E>

Const isPot

isPot(value: any): value is Pot<any, any>

- Defined in src/pot.ts:287
Parameters
- value: any
Returns value is Pot<any, any>

Const isSome

isSome<A, E>(p: Pot<A, E>): p is Some<A> | SomeLoading<A> | SomeUpdating<A> | SomeError<A, E>

- Defined in src/pot.ts:142
Type parameters
- A
- E = unknown
Parameters
- p: Pot<A, E>
Returns p is Some<A> | SomeLoading<A> | SomeUpdating<A> | SomeError<A, E>

Const isUpdating

isUpdating<A>(p: Pot<A, any>): p is NoneUpdating<A> | SomeUpdating<A>

- Defined in src/pot.ts:163
Type parameters
- A
Parameters
- p: Pot<A, any>
Returns p is NoneUpdating<A> | SomeUpdating<A>

Const map

map<A, B, E>(p: Pot<A, E>, f: (_: A) => B): Pot<B, E>

- Defined in src/pot.ts:219
Type parameters
- A
- B
- E = unknown
Parameters
- p: Pot<A, E>
- f: (_: A) => B
  - - (_: A): B
    - Parameters
      - _: A
      Returns B
Returns Pot<B, E>

Const mapNullable

mapNullable<A, B, E>(p: Pot<A, E>, f: (_: A) => undefined | null | B): Pot<B, E>

- Defined in src/pot.ts:251
Type parameters
- A
- B
- E = unknown
Parameters
- p: Pot<A, E>
- f: (_: A) => undefined | null | B
  - - (_: A): undefined | null | B
    - Parameters
      - _: A
      Returns undefined | null | B
Returns Pot<B, E>

Const noneError

noneError<E>(error: E): NoneError<E>

- Defined in src/pot.ts:53
Type parameters
- E
Parameters
- error: E
Returns NoneError<E>

Const noneUpdating

noneUpdating<T>(newValue: T): NoneUpdating<T>

- Defined in src/pot.ts:40
Type parameters
- T
Parameters
- newValue: T
Returns NoneUpdating<T>

Const orElse

orElse<A, E>(p: Pot<A, E>, o: Pot<A, E>): Pot<A, E>

- Defined in src/pot.ts:265
Type parameters
- A
- E = unknown
Parameters
- p: Pot<A, E>
- o: Pot<A, E>
Returns Pot<A, E>

Const some

some<T>(value: T): Some<T>

- Defined in src/pot.ts:66
Type parameters
- T
Parameters
- value: T
Returns Some<T>

Const someError

someError<T, E>(value: T, error: E): SomeError<T, E>

- Defined in src/pot.ts:108
Type parameters
- T
- E
Parameters
- value: T
- error: E
Returns SomeError<T, E>

Const someLoading

someLoading<T>(value: T): SomeLoading<T>

- Defined in src/pot.ts:79
Type parameters
- T
Parameters
- value: T
Returns SomeLoading<T>

Const someUpdating

someUpdating<T>(value: T, newValue: T): SomeUpdating<T>

- Defined in src/pot.ts:93
Type parameters
- T
Parameters
- value: T
- newValue: T
Returns SomeUpdating<T>

Const toError

toError<T, E>(p: Pot<T, E>, error: E): NoneError<E> | SomeError<T, E>

- Defined in src/pot.ts:182
Type parameters
- T
- E = unknown
Parameters
- p: Pot<T, E>
- error: E
Returns NoneError<E> | SomeError<T, E>

Const toLoading

toLoading<T>(p: Pot<T, any>): NoneLoading | SomeLoading<T>

- Defined in src/pot.ts:173
Type parameters
- T
Parameters
- p: Pot<T, any>
Returns NoneLoading | SomeLoading<T>

Const toOption

toOption<A>(p: Pot<A, any>): Option<A>

- Defined in src/pot.ts:271
Type parameters
- A
Parameters
- p: Pot<A, any>
Returns Option<A>

Const toSomeLoading

toSomeLoading<T>(p: Some<T> | SomeError<T, any>): SomeLoading<T>

- Defined in src/pot.ts:138
Type parameters
- T
Parameters
- p: Some<T> | SomeError<T, any>
Returns SomeLoading<T>

Const toUndefined

toUndefined<A>(p: Pot<A, any>): undefined | A

- Defined in src/pot.ts:268
Type parameters
- A
Parameters
- p: Pot<A, any>
Returns undefined | A

Const toUpdating

toUpdating<T>(p: Pot<T, any>, newValue: T): SomeUpdating<T> | NoneUpdating<T>

- Defined in src/pot.ts:176
Type parameters
- T
Parameters
- p: Pot<T, any>
- newValue: T
Returns SomeUpdating<T> | NoneUpdating<T>

Generated using TypeDoc