Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface KptFunc

Hierarchy

  • KptFunc

Callable

  • KptFunc(configs: Configs): Promise<void>
  • A function consumes and optionally mutates Kubernetes configurations using the given Configs object.

    The function should:

    • Throw errors when encountering operational issues such as IO exceptions.
    • Avoid writing to stdout (e.g. using process.stdout) as it is used for chaining functions. Use stderr instead.

    Parameters

    Returns Promise<void>

Index

Properties

Properties

usage

usage: string

Usage message describing what the function does, how to use it, and how to configure it.

Generated using TypeDoc