@zuke/kustomize

← API reference

`@zuke/kustomize` — typed `KustomizeTasks` wrappers for the

Symbols

# KustomizeBuildSettings class
class KustomizeBuildSettings extends KustomizeSettings

Settings for kustomize build.

MemberSignatureDoc
dir dir(path: PathLike): this The kustomization directory to build (defaults to the current directory).
output output(path: PathLike): this Write the rendered output to a file or directory (--output).
enableHelm enableHelm(): this Enable the Helm chart inflator (--enable-helm).
loadRestrictor loadRestrictor(mode: string): this Set the file-load restrictor, e.g. LoadRestrictionsNone (--load-restrictor).
# KustomizeEditSetImageSettings class
class KustomizeEditSetImageSettings extends KustomizeSettings

Settings for kustomize edit set image.

MemberSignatureDoc
image image(name: string, reference: string): this Set an image override, e.g. ("api", "api:1.4")api=api:1.4; repeatable, at least one is required.
# KustomizeSettings class
class KustomizeSettings extends ToolSettings

Base for all kustomize subcommand settings: the binary is kustomize.

# KustomizeTasks const
const KustomizeTasks: KustomizeTasksApi

Typed task functions for the kustomize CLI.

# KustomizeTasksApi interface
interface KustomizeTasksApi

The shape of KustomizeTasks.

MemberSignatureDoc
build build(configure?: Configure<KustomizeBuildSettings>): Promise<CommandOutput> Render a kustomization: kustomize build.
editSetImage editSetImage(configure?: Configure<KustomizeEditSetImageSettings>): Promise<CommandOutput> Update image overrides: kustomize edit set image.