Options
All
  • Public
  • Public/Protected
  • All
Menu

logic-branch-helpers

Index

Functions

Classes

Functions

todo

  • todo(message: string): never

  • Mark a section of code that is not yet complete.

    A block of code that calls this function should eventually be adjusted to not call this function, and implement the TODO behavior instead.

    Throws a TodoError.

    Parameters

    • message: string

      The TODO message of the raised error.

    Returns never

unimplemented

  • unimplemented(message?: string): never

  • Mark a section of code that is not implemented.

    A block of code that calls this function can be considered a bug, or intended behavior of a block of code that is required but intentionally not implemented.

    This is similar to todo, but does not promise that there will eventually be an implementation.

    Throws an UnimplementedError.

    Parameters

    • Optional message: string

      An optional message.

    Returns never

unreachable

  • unreachable(message?: string): never

  • Mark a section of code as unreachable.

    Reaching a block of code that calls unreachable is considered unexpected behavior. In other words, there is a bug if this function is run.

    Throws an UnreachableError.

    Parameters

    • Optional message: string

      An optional message.

    Returns never

Generated using TypeDoc