Class ResourceWatcher

Define the Kubernetes resources to watch.

Hierarchy

ResourceWatcher

Index

Constructors

constructor

Properties

#meta

Methods

Constructors

constructor

new ResourceWatcher(__namedParameters: Watch): ResourceWatcher

- Defined in src/operator/resource-watcher.ts:21
Parameters
- __namedParameters: Watch
  
  Metadata of the resources to watch.
Returns ResourceWatcher

Properties

Private #meta

#meta: Watch

Methods

added

added(operator: Operator, object: Resource): Promise<void>

- Defined in src/operator/resource-watcher.ts:88
Hook called whenever an ADDED event is received.

Parameters
- operator: Operator
  
  Operator owning the ResourceWatcher.
- object: Resource
  
  Added Kubernetes Resource.
Returns Promise<void>

deleted

deleted(operator: Operator, object: Resource): Promise<void>

- Defined in src/operator/resource-watcher.ts:106
Hook called whenever a DELETED event is received.

Parameters
- operator: Operator
  
  Operator owning the ResourceWatcher.
- object: Resource
  
  Deleted Kubernetes Resource.
Returns Promise<void>

errored

errored(operator: Operator, error: Error): Promise<void>

- Defined in src/operator/resource-watcher.ts:115
Hook called whenever an error has been received.

Parameters
- operator: Operator
  
  Operator owning the ResourceWatcher.
- error: Error
  
  The error that was thrown.
Returns Promise<void>

modified

modified(operator: Operator, object: Resource): Promise<void>

- Defined in src/operator/resource-watcher.ts:97
Hook called whenever a MODIFIED event is received.

Parameters
- operator: Operator
  
  Operator owning the ResourceWatcher.
- object: Resource
  
  Modified Kubernetes Resource.
Returns Promise<void>

watch

watch(operator: Operator): Promise<CancelScope>

- Defined in src/operator/resource-watcher.ts:41
Start watching the described resources.

Parameters
- operator: Operator
  
  Operator owning the ResourceWatcher.
Returns Promise<CancelScope>

a CancelScope for the watcher.

Generated using TypeDoc