Class Plugin

Class reprensenting a plugin

Hierarchy

Plugin

Index

Constructors

constructor

Properties

id
modem

Methods

Constructors

constructor

new Plugin(modem: any, id?: any): Plugin

- Defined in plugin.ts:9
Creates a new plugin

Parameters
- modem: any
  
  Modem to connect to the remote service
- Optional id: any
  
  Id of the plugin (optional)
Returns Plugin

Properties

id

id: any

modem

modem: any

Methods

___processArguments

___processArguments(opts: any, id?: any): Array<any>

- Defined in plugin.ts:309
Parameters
- opts: any
- Optional id: any
Returns Array<any>

create

create(opts: any): Promise<Object>

- Defined in plugin.ts:86
Create a plugin https://docs.docker.com/engine/api/v1.25/#operation/PluginCreate

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

Promise return the new plugin

disable

disable(opts: any, id: any): Promise<Object>

- Defined in plugin.ts:287
Disable a plugin https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/disable-a-plugin

Parameters
- opts: any
  
  Query params in the request (optional)
- id: any
  
  ID of the plugin, if it's not set, use the id of the object (optional)
Returns Promise<Object>

Promise return the plugin

enable

enable(opts: any, id: any): Promise<Object>

- Defined in plugin.ts:258
Enable a plugin https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/enable-a-plugin

Parameters
- opts: any
  
  Query params in the request (optional)
- id: any
  
  ID of the plugin, if it's not set, use the id of the object (optional)
Returns Promise<Object>

Promise return the plugin

install

install(opts: any): Promise<Object>

- Defined in plugin.ts:112
install a plugin https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/install-a-plugin

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

Promise return the new plugin

list

list(opts: any): Promise<Object>

- Defined in plugin.ts:27
Get the list of plugins https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/list-plugins

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

Promise returning the result as a list of plugins

push

push(opts: any, id: any): Promise<Object>

- Defined in plugin.ts:198
push a plugin https://docs.docker.com/engine/api/v1.26/#operation/PluginPush

Parameters
- opts: any
  
  Query params in the request (optional)
- id: any
  
  ID of the plugin, if it's not set, use the id of the object (optional)
Returns Promise<Object>

Promise return the plugin

remove

remove(opts: any, id: any): Promise<Object>

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

Parameters
- opts: any
  
  Query params in the request (optional)
- id: any
  
  ID of the plugin to inspect, if it's not set, use the id of the object (optional)
Returns Promise<Object>

Promise return the result

set

set(opts: any, id: any): Promise<Object>

- Defined in plugin.ts:228
Set a plugin configuration https://docs.docker.com/engine/api/v1.25/#operation/PluginSet

Parameters
- opts: any
  
  Query params in the request (optional)
- id: any
  
  ID of the plugin, if it's not set, use the id of the object (optional)
Returns Promise<Object>

Promise return the plugin

status

status(opts: any, id: any): Promise<Object>

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

Parameters
- opts: any
  
  Query params in the request (optional)
- id: any
  
  ID of the plugin to inspect, if it's not set, use the id of the object (optional)
Returns Promise<Object>

Promise return the plugin

upgrade

upgrade(opts: any): Promise<Object>

- Defined in plugin.ts:56
upgrade a plugin https://docs.docker.com/engine/api/v1.26/#operation/PluginUpgrade

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

Promise return the new plugin

Generated using TypeDoc