# Module: vertx-consul-js/watch

### Classes

Watch

### Methods

#### (static) Watch.events(event, vertx, options) → {Watch}

Creates `Watch` to monitoring the custom user events. This maps to the /v1/event/list API internally.

##### Parameters:

Name | Type | Description
--- | --- | ---
`event` | string | the event name
`vertx` | Vertx | the `Vertx` instance
`options` | Object | the options to create underlying Consul client

Source:
  - vertx-consul-js/watch.js, line 201

##### Returns:

the `Watch` instance

Type
  Watch

#### (static) Watch.key(key, vertx, options) → {Watch}

Creates `Watch` to monitoring a specific key in the KV store. This maps to the /v1/kv/ API internally.

##### Parameters:

Name | Type | Description
--- | --- | ---
`key` | string | the key
`vertx` | Vertx | the `Vertx` instance
`options` | Object | the options to create underlying Consul client

Source:
  - vertx-consul-js/watch.js, line 126

##### Returns:

the `Watch` instance

Type
  Watch

#### (static) Watch.keyPrefix(keyPrefix, vertx, options) → {Watch}

Creates `Watch` to monitoring a prefix of keys in the KV store. This maps to the /v1/kv/ API internally.

##### Parameters:

Name | Type | Description
--- | --- | ---
`keyPrefix` | string | the key
`vertx` | Vertx | the `Vertx` instance
`options` | Object | the options to create underlying Consul client

Source:
  - vertx-consul-js/watch.js, line 145

##### Returns:

the `Watch` instance

Type
  Watch

#### (static) Watch.nodes(vertx, options) → {Watch}

Creates `Watch` to monitoring the list of available nodes. This maps to the /v1/catalog/nodes API internally.

##### Parameters:

Name | Type | Description
--- | --- | ---
`vertx` | Vertx | the `Vertx` instance
`options` | Object | the options to create underlying Consul client

Source:
  - vertx-consul-js/watch.js, line 219

##### Returns:

the `Watch` instance

Type
  Watch

#### (static) Watch.service(service, vertx, options) → {Watch}

Creates `Watch` to monitoring the nodes providing the service. This maps to the /v1/health/service/<service> API internally.

##### Parameters:

Name | Type | Description
--- | --- | ---
`service` | string | the service name
`vertx` | Vertx | the `Vertx` instance
`options` | Object | the options to create underlying Consul client

Source:
  - vertx-consul-js/watch.js, line 182

##### Returns:

the `Watch` instance

Type
  Watch

#### (static) Watch.services(vertx, options) → {Watch}

Creates `Watch` to monitoring the list of available services. This maps to the /v1/catalog/services API internally.

##### Parameters:

Name | Type | Description
--- | --- | ---
`vertx` | Vertx | the `Vertx` instance
`options` | Object | the options to create underlying Consul client

Source:
  - vertx-consul-js/watch.js, line 163

##### Returns:

the `Watch` instance

Type
  Watch