Class Watcher

Readonlyid

Readonlyrequest

cancel

• cancel(): Promise<void>

  Cancels the watcher.

  Returns Promise<void>

lastRevision

• lastRevision(): bigint | null

  lastRevision returns the lossless bigint latest/resume revision for this watcher. After observing a cluster header at revision N, this is N + 1. This will be null until the watcher has a resume revision.

  Returns bigint | null

on

• on(event: "connecting", handler: (req: IWatchRequest) => void): this

  connecting is fired when we send a request to etcd to queue this watcher.

  Parameters

  • event: "connecting"
  • handler: (req: IWatchRequest) => void

  Returns this

• on(event: "connected", handler: (res: IWatchResponse) => void): this

  connected is fired after etcd acknowledges the watcher is connected. When this event is fired, id will already be populated.

  Parameters

  • event: "connected"
  • handler: (res: IWatchResponse) => void

  Returns this

• on(event: "data", handler: (res: IWatchResponse) => void): this

  data is fired when etcd reports an update on one of the keys being watched.

  Parameters

  • event: "data"
  • handler: (res: IWatchResponse) => void

  Returns this

• on(event: "put", handler: (kv: IKeyValue, previous?: IKeyValue) => void): this

  put is fired, in addition to data, when a key is created or updated in etcd.

  Parameters

  • event: "put"
  • handler: (kv: IKeyValue, previous?: IKeyValue) => void

  Returns this

• on(
      event: "delete",
      handler: (kv: IKeyValue, previous?: IKeyValue) => void,
  ): this

  delete is fired, in addition to data, when a key is deleted from etcd.

  Parameters

  • event: "delete"
  • handler: (kv: IKeyValue, previous?: IKeyValue) => void

  Returns this

• on(event: "end", handler: () => void): this

  end is fired after the watcher is closed normally. Like Node.js streams, end is NOT fired if error is fired.

  Parameters

  • event: "end"
  • handler: () => void

  Returns this

• on(event: "disconnected", handler: (res: EtcdError) => void): this

  disconnected is fired if the watcher is disconnected from etcd. The watcher will automatically attempt to reconnect when this occurs. When this event is fired, id will still be populated if it was previously.

  Parameters

  • event: "disconnected"
  • handler: (res: EtcdError) => void

  Returns this

• on(event: "error", handler: (err: EtcdError) => void): this

  error is fired if a non-recoverable error occurs that prevents the watcher from functioning. This generally occurs if etcd unexpectedly canceled our lease, which can occur if (for example) we don't have permission to read the watched key or range. When this event is fired, id will still be populated if it was previously.

  Parameters

  • event: "error"
  • handler: (err: EtcdError) => void

  Returns this