Package io.github.cdklabs.projen

Class Testing

  • All Implemented Interfaces:
    software.amazon.jsii.JsiiSerializable
    @Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.813Z")
@Stability(Experimental)
public class Testing
extends software.amazon.jsii.JsiiObject
    (experimental) A Testing static class with a .synth helper for getting a snapshots of construct outputs. Useful for snapshot testing with Jest.

    Example: 

     `expect(Testing.synth(someProject)).toMatchSnapshot()`

    • Nested Class Summary

      • Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

        software.amazon.jsii.JsiiObject.InitializationMode

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected Testing​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)  
      protected Testing​(software.amazon.jsii.JsiiObjectRef objRef)  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Map<String,​Object> synth​(Project project)
      (experimental) Produces a simple JS object that represents the contents of the projects with field names being file paths.
      static Map<String,​Object> synth​(Project project, SnapshotOptions options)
      (experimental) Produces a simple JS object that represents the contents of the projects with field names being file paths.

      • Methods inherited from class software.amazon.jsii.JsiiObject

        jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

      • Methods inherited from interface software.amazon.jsii.JsiiSerializable

        $jsii$toJson

    • Constructor Detail

      • Testing

        protected Testing​(software.amazon.jsii.JsiiObjectRef objRef)

      • Testing

        protected Testing​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • Method Detail

      • synth

        @Stability(Experimental)
@NotNull
public static Map<String,​Object> synth​(@NotNull
                                             Project project,
                                             @Nullable
                                             SnapshotOptions options)
        (experimental) Produces a simple JS object that represents the contents of the projects with field names being file paths.

        Parameters:
        project - the project to produce a snapshot for. This parameter is required.
        options -
        Returns:
        : any }

      • synth

        @Stability(Experimental)
@NotNull
public static Map<String,​Object> synth​(@NotNull
                                             Project project)
        (experimental) Produces a simple JS object that represents the contents of the projects with field names being file paths.

        Parameters:
        project - the project to produce a snapshot for. This parameter is required.
        Returns:
        : any }