FuncType - v0.8.64
    Preparing search index...

    Function HKT

    • 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;
          toString(): string;
      }

      • Readonly_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
      • toString: function
        • toString(): string

          Returns string

    Index

    Properties

    isEither isList isOption isTry

    Methods

    ap flatMap flatten map sequence traverse

    Properties

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

    Type declaration

      • <E extends unknown, A extends unknown>(value: unknown): value is Either<E, 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>

    isList: <T extends unknown>(value: unknown) => value is List<T>

    Type declaration

      • <T extends unknown>(value: unknown): value is List<T>

      • Type guard to check if a value is a List

        Type Parameters

        • T extends unknown

        Parameters

        • value: unknown

        Returns value is List<T>

    isOption: <T extends unknown>(value: unknown) => value is Option<T>

    Type declaration

      • <T extends unknown>(value: unknown): value is Option<T>

      • Type guard to check if a value is an Option

        Type Parameters

        • T extends unknown

        Parameters

        • value: unknown

        Returns value is Option<T>

    isTry: <T extends unknown>(value: unknown) => value is Try<T>

    Type declaration

      • <T extends unknown>(value: unknown): value is Try<T>

      • Type guard to check if a value is a Try

        Type Parameters

        • T extends unknown

        Parameters

        • value: unknown

        Returns value is Try<T>

    Methods

    • Type Parameters

      • F = unknown
      • A = unknown
      • B = unknown

      Parameters

      • ff: unknown
      • fa: unknown

      Returns unknown

    • Type Parameters

      • F = unknown
      • A = unknown
      • B = unknown

      Parameters

      • fa: unknown
      • f: (a: A) => unknown

      Returns unknown

    • Type Parameters

      • F = unknown
      • A = unknown

      Parameters

      • ffa: unknown

      Returns unknown

    • Static methods for HKT operations

      Type Parameters

      • F = unknown
      • A = unknown
      • B = unknown

      Parameters

      • fa: unknown
      • f: (a: A) => B

      Returns unknown

    • Type Parameters

      • F = unknown
      • G = unknown
      • A = unknown

      Parameters

      • fga: unknown

      Returns unknown

    • Type Parameters

      • F = unknown
      • G = unknown
      • A = unknown
      • B = unknown

      Parameters

      • fa: unknown
      • f: (a: A) => unknown

      Returns unknown

    Settings

    Member Visibility

    On This Page

    Properties
    Methods