Class DockerNetworkCreator

Conveniently create a Docker network.

Hierarchy

DockerNetworkCreator

Index

Constructors

constructor

Properties

dockerode

Methods

Constructors

constructor

new DockerNetworkCreator(dockerode: Dockerode): DockerNetworkCreator

- Defined in packages/jbr/lib/docker/DockerNetworkCreator.ts:10
Parameters
- dockerode: Dockerode
Returns DockerNetworkCreator

Properties

Private Readonly dockerode

dockerode: Dockerode

Methods

create

create(options: NetworkCreateOptions): Promise<DockerNetworkHandler>

- Defined in packages/jbr/lib/docker/DockerNetworkCreator.ts:18
Create a network

Parameters
- options: NetworkCreateOptions
  
  Network options
Returns Promise<DockerNetworkHandler>

remove

remove(name: string): Promise<void>

- Defined in packages/jbr/lib/docker/DockerNetworkCreator.ts:26
Remove a network

Parameters
- name: string
  
  A network name
Returns Promise<void>

Generated using TypeDoc