Package io.github.cdklabs.projen

Interface SampleFileOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SampleFileOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.801Z")
@Stability(Experimental)
public interface SampleFileOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options for the SampleFile object.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SampleFileOptions.Builder	builder()
default String	getContents()	(experimental) The contents of the file to write.
default String	getSourcePath()	(experimental) Absolute path to a file to copy the contents from (does not need to be a text file).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getContents

@Stability(Experimental)
@Nullable
default String getContents()

(experimental) The contents of the file to write.

getSourcePath

@Stability(Experimental)
@Nullable
default String getSourcePath()

(experimental) Absolute path to a file to copy the contents from (does not need to be a text file).

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 SampleFile(this, 'assets/icon.png', { source: path.join(__dirname, '..', 'sample-assets', 'icon.png') });
 

builder

@Stability(Experimental)
static SampleFileOptions.Builder builder()

Returns:

a SampleFileOptions.Builder of SampleFileOptions