Class Service

Class representing a service

Hierarchy

Service

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Service(modem: Modem, id: String): Service

- Defined in service.ts:11
Create a service

Parameters
- modem: Modem
  
  Modem to connect to the remote service
- id: String
  
  Id of the service (optional)
Returns Service

Properties

data

data: Object

id

id: String

modem

modem: Modem

Methods

logs

logs(opts?: Object): Promise<String>

- Defined in service.ts:112
Logs of a service https://docs.docker.com/engine/api/v1.27/#operation/ServiceLogs

Parameters
- Optional opts: Object
  
  Query params in the request (optional)
Returns Promise<String>

Promise return the result

remove

remove(opts?: Object): Promise<String>

- Defined in service.ts:86
Remove a service https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/remove-a-service

Parameters
- Optional opts: Object
  
  Query params in the request (optional)
Returns Promise<String>

Promise return the result

status

status(opts?: Object): Promise<Service>

- Defined in service.ts:58
Get low-level information on a service https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/inspect-one-or-more-services The reason why this module isn't called inspect is because that interferes with the inspect utility of service.

Parameters
- Optional opts: Object
  
  Query params in the request (optional)
Returns Promise<Service>

Promise return the service

update

update(opts?: Object): Promise<Service>

- Defined in service.ts:29
Update a service https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/update-a-service

Parameters
- Optional opts: Object
  
  Query params in the request (optional)
Returns Promise<Service>

Promise return the new service

Generated using TypeDoc