projen 0.52.21 → 0.52.25

package/lib/docker-compose.d.ts

@@ -1,103 +1,73 @@
 import { Component } from "./component";
 import { Project } from "./project";
 /**
- * (experimental) Props for DockerCompose.
- *
- * @experimental
+ * Props for DockerCompose.
  */
 export interface DockerComposeProps {
     /**
-     * (experimental) A name to add to the docker-compose.yml filename.
-     *
+     * A name to add to the docker-compose.yml filename.
+     * @example 'myname' yields 'docker-compose.myname.yml'
      * @default - no name is added
-     * @experimental
-     * @example
-     *
-     * 'myname' yields 'docker-compose.myname.yml'
      */
     readonly nameSuffix?: string;
     /**
-     * (experimental) Docker Compose schema version do be used.
-     *
+     * Docker Compose schema version do be used
      * @default 3.3
-     * @experimental
      */
     readonly schemaVersion?: string;
     /**
-     * (experimental) Service descriptions.
-     *
-     * @experimental
+     * Service descriptions.
      */
     readonly services?: Record<string, DockerComposeServiceDescription>;
 }
 /**
- * (experimental) Options for port mappings.
- *
- * @experimental
+ * Options for port mappings.
  */
 export interface DockerComposePortMappingOptions {
     /**
-     * (experimental) Port mapping protocol.
-     *
+     * Port mapping protocol.
      * @default DockerComposeProtocol.TCP
-     * @experimental
      */
     readonly protocol?: DockerComposeProtocol;
 }
 /**
- * (experimental) Create a docker-compose YAML file.
- *
- * @experimental
+ * Create a docker-compose YAML file.
  */
 export declare class DockerCompose extends Component {
     /**
-     * (experimental) Depends on a service name.
-     *
-     * @experimental
+     * Depends on a service name.
      */
     static serviceName(serviceName: string): IDockerComposeServiceName;
     /**
-     * (experimental) Create a port mapping.
-     *
-     * @param publishedPort Published port number.
-     * @param targetPort Container's port number.
-     * @param options Port mapping options.
-     * @experimental
+     * Create a port mapping.
+     * @param publishedPort Published port number
+     * @param targetPort Container's port number
+     * @param options Port mapping options
      */
     static portMapping(publishedPort: number, targetPort: number, options?: DockerComposePortMappingOptions): DockerComposeServicePort;
     /**
-     * (experimental) Create a bind volume that binds a host path to the target path in the container.
-     *
-     * @param sourcePath Host path name.
-     * @param targetPath Target path name.
-     * @experimental
+     * Create a bind volume that binds a host path to the target path in the container.
+     * @param sourcePath Host path name
+     * @param targetPath Target path name
      */
     static bindVolume(sourcePath: string, targetPath: string): IDockerComposeVolumeBinding;
     /**
-     * (experimental) Create a named volume and mount it to the target path.
-     *
-     * If you use this
+     * Create a named volume and mount it to the target path. If you use this
      * named volume in several services, the volume will be shared. In this
      * case, the volume configuration of the first-provided options are used.
      *
-     * @param volumeName Name of the volume.
-     * @param targetPath Target path.
-     * @param options volume configuration (default: docker compose defaults).
-     * @experimental
+     * @param volumeName Name of the volume
+     * @param targetPath Target path
+     * @param options volume configuration (default: docker compose defaults)
      */
     static namedVolume(volumeName: string, targetPath: string, options?: DockerComposeVolumeConfig): IDockerComposeVolumeBinding;
     private readonly services;
     private readonly version;
-    /**
-     * @experimental
-     */
     constructor(project: Project, props?: DockerComposeProps);
     /**
-     * (experimental) Add a service to the docker-compose file.
-     *
-     * @param serviceName name of the service.
-     * @param description a service description.
-     * @experimental
+     * Add a service to the docker-compose file.
+     * @param serviceName name of the service
+     * @param description a service description
      */
     addService(serviceName: string, description: DockerComposeServiceDescription): DockerComposeService;
     /**
@@ -106,329 +76,233 @@ export declare class DockerCompose extends Component {
     _synthesizeDockerCompose(): object;
 }
 /**
- * (experimental) An interface providing the name of a docker compose service.
- *
- * @experimental
+ * An interface providing the name of a docker compose service.
  */
 export interface IDockerComposeServiceName {
     /**
-     * (experimental) The name of the docker compose service.
-     *
-     * @experimental
+     * The name of the docker compose service.
      */
     readonly serviceName: string;
 }
 /**
- * (experimental) Description of a docker-compose.yml service.
- *
- * @experimental
+ * Description of a docker-compose.yml service.
  */
 export interface DockerComposeServiceDescription {
     /**
-     * (experimental) Use a docker image.
-     *
+     * Use a docker image.
      * Note: You must specify either `build` or `image` key.
-     *
      * @see imageBuild
-     * @experimental
      */
     readonly image?: string;
     /**
-     * (experimental) Build a docker image.
-     *
+     * Build a docker image.
      * Note: You must specify either `imageBuild` or `image` key.
-     *
      * @see image
-     * @experimental
      */
     readonly imageBuild?: DockerComposeBuild;
     /**
-     * (experimental) Provide a command to the docker container.
-     *
+     * Provide a command to the docker container.
      * @default - use the container's default command
-     * @experimental
      */
     readonly command?: string[];
     /**
-     * (experimental) Names of other services this service depends on.
-     *
+     * Names of other services this service depends on.
      * @default - no dependencies
-     * @experimental
      */
     readonly dependsOn?: IDockerComposeServiceName[];
     /**
-     * (experimental) Mount some volumes into the service.
-     *
+     * Mount some volumes into the service.
      * Use one of the following to create volumes:
-     *
+     * @see DockerCompose.bindVolume() to mount a host path
      * @see DockerCompose.namedVolume() to create & mount a named volume
-     * @experimental
      */
     readonly volumes?: IDockerComposeVolumeBinding[];
     /**
-     * (experimental) Map some ports.
-     *
+     * Map some ports.
      * @default - no ports are mapped
-     * @experimental
      */
     readonly ports?: DockerComposeServicePort[];
     /**
-     * (experimental) Add environment variables.
-     *
+     * Add environment variables.
      * @default - no environment variables are provided
-     * @experimental
      */
     readonly environment?: Record<string, string>;
 }
 /**
- * (experimental) A docker-compose service.
- *
- * @experimental
+ * A docker-compose service.
  */
 export declare class DockerComposeService implements IDockerComposeServiceName {
     /**
-     * (experimental) Name of the service.
-     *
-     * @experimental
+     * Name of the service.
      */
     readonly serviceName: string;
     /**
-     * (experimental) Docker image.
-     *
-     * @experimental
+     * Docker image.
      */
     readonly image?: string;
     /**
-     * (experimental) Docker image build instructions.
-     *
-     * @experimental
+     * Docker image build instructions.
      */
     readonly imageBuild?: DockerComposeBuild;
     /**
-     * (experimental) Command to run in the container.
-     *
-     * @experimental
+     * Command to run in the container.
      */
     readonly command?: string[];
     /**
-     * (experimental) Other services that this service depends on.
-     *
-     * @experimental
+     * Other services that this service depends on.
      */
     readonly dependsOn: IDockerComposeServiceName[];
     /**
-     * (experimental) Volumes mounted in the container.
-     *
-     * @experimental
+     * Volumes mounted in the container.
      */
     readonly volumes: IDockerComposeVolumeBinding[];
     /**
-     * (experimental) Published ports.
-     *
-     * @experimental
+     * Published ports.
      */
     readonly ports: DockerComposeServicePort[];
     /**
-     * (experimental) Environment variables.
-     *
-     * @experimental
+     * Environment variables.
      */
     readonly environment: Record<string, string>;
-    /**
-     * @experimental
-     */
     constructor(serviceName: string, serviceDescription: DockerComposeServiceDescription);
     /**
-     * (experimental) Add a port mapping.
-     *
-     * @param publishedPort Published port number.
-     * @param targetPort Container's port number.
-     * @param options Port mapping options.
-     * @experimental
+     * Add a port mapping
+     * @param publishedPort Published port number
+     * @param targetPort Container's port number
+     * @param options Port mapping options
      */
     addPort(publishedPort: number, targetPort: number, options?: DockerComposePortMappingOptions): void;
     /**
-     * (experimental) Add an environment variable.
-     *
-     * @param name environment variable name.
-     * @param value value of the environment variable.
-     * @experimental
+     * Add an environment variable
+     * @param name environment variable name
+     * @param value value of the environment variable
      */
     addEnvironment(name: string, value: string): void;
     /**
-     * (experimental) Make the service depend on another service.
-     *
-     * @experimental
+     * Make the service depend on another service.
+     * @param serviceName
      */
     addDependsOn(serviceName: IDockerComposeServiceName): void;
     /**
-     * (experimental) Add a volume to the service.
-     *
-     * @experimental
+     * Add a volume to the service.
+     * @param volume
      */
     addVolume(volume: IDockerComposeVolumeBinding): void;
 }
 /**
- * (experimental) A service port mapping.
- *
- * @experimental
+ * A service port mapping
  */
 export interface DockerComposeServicePort {
     /**
-     * (experimental) Published port number.
-     *
-     * @experimental
+     * Published port number
      */
     readonly published: number;
     /**
-     * (experimental) Target port number.
-     *
-     * @experimental
+     * Target port number
      */
     readonly target: number;
     /**
-     * (experimental) Network protocol.
-     *
-     * @experimental
+     * Network protocol
      */
     readonly protocol: DockerComposeProtocol;
     /**
-     * (experimental) Port mapping mode.
-     *
-     * @experimental
+     * Port mapping mode.
      */
     readonly mode: string;
 }
 /**
- * (experimental) Network protocol for port mapping.
- *
- * @experimental
+ * Network protocol for port mapping
  */
 export declare enum DockerComposeProtocol {
     /**
-     * (experimental) TCP protocol.
-     *
-     * @experimental
+     * TCP protocol
      */
     TCP = "tcp",
     /**
-     * (experimental) UDP protocol.
-     *
-     * @experimental
+     * UDP protocol
      */
     UDP = "udp"
 }
 /**
- * (experimental) Build arguments for creating a docker image.
- *
- * @experimental
+ * Build arguments for creating a docker image.
  */
 export interface DockerComposeBuild {
     /**
-     * (experimental) Docker build context directory.
-     *
-     * @experimental
+     * Docker build context directory.
      */
     readonly context: string;
     /**
-     * (experimental) A dockerfile to build from.
-     *
+     * A dockerfile to build from.
      * @default "Dockerfile"
-     * @experimental
      */
     readonly dockerfile?: string;
     /**
-     * (experimental) Build args.
-     *
+     * Build args.
      * @default - none are provided
-     * @experimental
      */
     readonly args?: Record<string, string>;
 }
 /**
- * (experimental) Volume configuration.
- *
- * @experimental
+ * Volume configuration
  */
 export interface DockerComposeVolumeConfig {
     /**
-     * (experimental) Driver to use for the volume.
-     *
+     * Driver to use for the volume
      * @default - value is not provided
-     * @experimental
      */
     readonly driver?: string;
     /**
-     * (experimental) Options to provide to the driver.
-     *
-     * @experimental
+     * Options to provide to the driver.
      */
     readonly driverOpts?: Record<string, string>;
     /**
-     * (experimental) Set to true to indicate that the volume is externally created.
-     *
+     * Set to true to indicate that the volume is externally created.
      * @default - unset, indicating that docker-compose creates the volume
-     * @experimental
      */
     readonly external?: boolean;
     /**
-     * (experimental) Name of the volume for when the volume name isn't going to work in YAML.
-     *
+     * Name of the volume for when the volume name isn't going to work in YAML.
      * @default - unset, indicating that docker-compose creates volumes as usual
-     * @experimental
      */
     readonly name?: string;
 }
 /**
- * (experimental) Volume binding information.
- *
- * @experimental
+ * Volume binding information.
  */
 export interface IDockerComposeVolumeBinding {
     /**
-     * (experimental) Binds the requested volume to the docker-compose volume configuration and provide mounting instructions for synthesis.
-     *
-     * @param volumeConfig the volume configuration.
+     * Binds the requested volume to the docker-compose volume configuration and
+     * provide mounting instructions for synthesis.
+     * @param volumeConfig the volume configuration
      * @returns mounting instructions for the service.
-     * @experimental
      */
     bind(volumeConfig: IDockerComposeVolumeConfig): DockerComposeVolumeMount;
 }
 /**
- * (experimental) Storage for volume configuration.
- *
- * @experimental
+ * Storage for volume configuration.
  */
 export interface IDockerComposeVolumeConfig {
     /**
-     * (experimental) Add volume configuration to the repository.
-     *
-     * @experimental
+     * Add volume configuration to the repository.
+     * @param volumeName
+     * @param configuration
      */
     addVolumeConfiguration(volumeName: string, configuration: DockerComposeVolumeConfig): void;
 }
 /**
- * (experimental) Service volume mounting information.
- *
- * @experimental
+ * Service volume mounting information.
  */
 export interface DockerComposeVolumeMount {
     /**
-     * (experimental) Type of volume.
-     *
-     * @experimental
+     * Type of volume.
      */
     readonly type: string;
     /**
-     * (experimental) Volume source.
-     *
-     * @experimental
+     * Volume source
      */
     readonly source: string;
     /**
-     * (experimental) Volume target.
-     *
-     * @experimental
+     * Volume target
      */
     readonly target: string;
 }