Function HKT

HKT(): {
    _tag: string;
    _type: string;
    ap: <F, A, B>(ff: unknown, fa: unknown) => unknown;
    flatMap: <F, A, B>(fa: unknown, f: (a: A) => unknown) => unknown;
    flatten: <F, A>(ffa: unknown) => unknown;
    map: <F, A, B>(fa: unknown, f: (a: A) => B) => unknown;
    sequence: <F, G, A>(fga: unknown) => unknown;
    traverse: <F, G, A, B>(fa: unknown, f: (a: A) => unknown) => unknown;
}
HKT provides utilities for working with higher-kinded types This allows writing generic code that works across different container types like Option, List, Either, etc.

Returns {
    _tag: string;
    _type: string;
    ap: <F, A, B>(ff: unknown, fa: unknown) => unknown;
    flatMap: <F, A, B>(fa: unknown, f: (a: A) => unknown) => unknown;
    flatten: <F, A>(ffa: unknown) => unknown;
    map: <F, A, B>(fa: unknown, f: (a: A) => B) => unknown;
    sequence: <F, G, A>(fga: unknown) => unknown;
    traverse: <F, G, A, B>(fa: unknown, f: (a: A) => unknown) => unknown;
}
- _tag: string
- _type: string
- ap: <F, A, B>(ff: unknown, fa: unknown) => unknown
  Applies a function inside a container to a value inside another container
- flatMap: <F, A, B>(fa: unknown, f: (a: A) => unknown) => unknown
  First applies the function to the value inside the container, then flattens the result
- flatten: <F, A>(ffa: unknown) => unknown
  Flattens a nested container (container of container) into a single container
- map: <F, A, B>(fa: unknown, f: (a: A) => B) => unknown
  Maps over a value inside a container, using the container's own map function
- sequence: <F, G, A>(fga: unknown) => unknown
  Sequences a container of containers into a container of container (e.g., Option<List> to List<Option >)
- traverse: <F, G, A, B>(fa: unknown, f: (a: A) => unknown) => unknown
  Transforms each element in a container and then sequences the results

Index

Properties

Methods

ap flatMap flatten map sequence traverse

Properties

isEither

isEither: <E extends unknown, A extends unknown>(
value: unknown,
) => value is Either<E, A> & Mappable<A> & FlatMappable<A>

Type Declaration

- <E extends unknown, A extends unknown>(
  value: unknown,
  ): value is Either<E, A> & Mappable<A> & FlatMappable<A>
- Type guard to check if a value is an Either
  Type Parameters
  - E extends unknown
  - A extends unknown
  Parameters
  - value: unknown
  Returns value is Either<E, A> & Mappable<A> & FlatMappable<A>

isList

isList: <T extends unknown>(
value: unknown,
) => value is List<T> & Mappable<T> & Flattenable & FlatMappable<T>

Type Declaration

- <T extends unknown>(
  value: unknown,
  ): value is List<T> & Mappable<T> & Flattenable & FlatMappable<T>
- Type guard to check if a value is a List
  Type Parameters
  - T extends unknown
  Parameters
  - value: unknown
  Returns value is List<T> & Mappable<T> & Flattenable & FlatMappable<T>

isOption

isOption: <T extends unknown>(
value: unknown,
) => value is Option<T> & Mappable<T> & FlatMappable<T>

Type Declaration

- <T extends unknown>(
  value: unknown,
  ): value is Option<T> & Mappable<T> & FlatMappable<T>
- Type guard to check if a value is an Option
  Type Parameters
  - T extends unknown
  Parameters
  - value: unknown
  Returns value is Option<T> & Mappable<T> & FlatMappable<T>

isTry

isTry: <T extends unknown>(
value: unknown,
) => value is Try<T> & Mappable<T> & FlatMappable<T>

Type Declaration

- <T extends unknown>(
  value: unknown,
  ): value is Try<T> & Mappable<T> & FlatMappable<T>
- Type guard to check if a value is a Try
  Type Parameters
  - T extends unknown
  Parameters
  - value: unknown
  Returns value is Try<T> & Mappable<T> & FlatMappable<T>

Methods

ap

ap<F = unknown, A = unknown, B = unknown>(ff: unknown, fa: unknown): unknown
Type Parameters
- F = unknown
- A = unknown
- B = unknown
Parameters
- ff: unknown
- fa: unknown
Returns unknown

flatMap

flatMap<F = unknown, A = unknown, B = unknown>(
fa: unknown,
f: (a: A) => unknown,
): unknown
Type Parameters
- F = unknown
- A = unknown
- B = unknown
Parameters
- fa: unknown
- f: (a: A) => unknown
Returns unknown

flatten

flatten<F = unknown, A = unknown>(ffa: unknown): unknown
Type Parameters
- F = unknown
- A = unknown
Parameters
- ffa: unknown
Returns unknown

map

map<F = unknown, A = unknown, B = unknown>(fa: unknown, f: (a: A) => B): unknown
Type Parameters
- F = unknown
- A = unknown
- B = unknown
Parameters
- fa: unknown
- f: (a: A) => B
Returns unknown

sequence

sequence<F = unknown, G = unknown, A = unknown>(fga: unknown): unknown
Type Parameters
- F = unknown
- G = unknown
- A = unknown
Parameters
- fga: unknown
Returns unknown

traverse

traverse<F = unknown, G = unknown, A = unknown, B = unknown>(
fa: unknown,
f: (a: A) => unknown,
): unknown
Type Parameters
- F = unknown
- G = unknown
- A = unknown
- B = unknown
Parameters
- fa: unknown
- f: (a: A) => unknown
Returns unknown

Function HKT

_tag: string

_type: string

ap: <F, A, B>(ff: unknown, fa: unknown) => unknown

flatMap: <F, A, B>(fa: unknown, f: (a: A) => unknown) => unknown

flatten: <F, A>(ffa: unknown) => unknown

map: <F, A, B>(fa: unknown, f: (a: A) => B) => unknown

sequence: <F, G, A>(fga: unknown) => unknown

traverse: <F, G, A, B>(fa: unknown, f: (a: A) => unknown) => unknown

Index

Properties

Methods

Properties

isEither

Type Declaration

Type Parameters

Parameters

Returns value is Either<E, A> & Mappable<A> & FlatMappable<A>

isList

Type Declaration

Type Parameters

Parameters

Returns value is List<T> & Mappable<T> & Flattenable & FlatMappable<T>

isOption

Type Declaration

Type Parameters

Parameters

Returns value is Option<T> & Mappable<T> & FlatMappable<T>

isTry

Type Declaration

Type Parameters

Parameters

Returns value is Try<T> & Mappable<T> & FlatMappable<T>

Methods

ap

Type Parameters

Parameters

Returns unknown

flatMap

Type Parameters

Parameters

Returns unknown

flatten

Type Parameters

Parameters

Returns unknown

map

Type Parameters

Parameters

Returns unknown

sequence

Type Parameters

Parameters

Returns unknown

traverse

Type Parameters

Parameters

Returns unknown

Settings

On This Page