io.github.cdklabs.projen

Interface SampleDirOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SampleDirOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.435Z")
 @Stability(value=Experimental)
public interface SampleDirOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) SampleDir options.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SampleDirOptions.Builder A builder for SampleDirOptions
static class	SampleDirOptions.Jsii$Proxy An implementation for SampleDirOptions

Method Summary

Modifier and Type	Method and Description
static SampleDirOptions.Builder	builder()
default Map<String,String>	getFiles() (experimental) The files to render into the directory.
default String	getSourceDir() (experimental) Absolute path to a directory to copy files from (does not need to be text files).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getFiles

@Stability(value=Experimental)
 @Nullable
default Map<String,String> getFiles()

(experimental) The files to render into the directory.

These files get added after any files from source if that option is specified (replacing if names overlap).

getSourceDir

@Stability(value=Experimental)
 @Nullable
default String getSourceDir()

(experimental) Absolute path to a directory to copy files from (does not need to be text files).

If your project is typescript-based and has configured testdir to be a subdirectory of src, sample files should outside of the src directory otherwise they may not be copied. For example:

 new SampleDir(this, 'public', { source: path.join(__dirname, '..', 'sample-assets') });
 

builder

@Stability(value=Experimental)
static SampleDirOptions.Builder builder()

Returns:

a SampleDirOptions.Builder of SampleDirOptions