Class Secret

Class representing a secret

Hierarchy

Secret

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

- Defined in secret.ts:11
Create a secret

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

Properties

data

data: Object

id

id: String

modem

modem: Modem

Methods

remove

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

- Defined in secret.ts:59
Remove a secret https://docs.docker.com/engine/api/v1.25/#operation/SecretDelete

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

Promise return the result

status

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

- Defined in secret.ts:30
Get low-level information on a secret https://docs.docker.com/engine/api/v1.25/#operation/SecretInspect The reason why this module isn't called inspect is because that interferes with the inspect utility of node.

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

Promise return the secret

Generated using TypeDoc