<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@contract-case/case-boundary](./case-boundary.md)

## case-boundary package

This is the \[JSii\](https://aws.github.io/jsii/user-guides/lib-author/toolchain/jsii/) layer that is the exported interface for ContractCase.

Don't depend on this directly unless you are writing a custom wrapper for ContractCase.

## Classes

| Class                                                                           | Description                                                                                                                  |
| ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| [BoundaryContractDefiner](./case-boundary.boundarycontractdefiner.md)           | A BoundaryContractDefiner allows defining contracts                                                                          |
| [BoundaryContractVerifier](./case-boundary.boundarycontractverifier.md)         | A BoundaryContractDefiner allows verifying contracts                                                                         |
| [BoundaryCrashMessage](./case-boundary.boundarycrashmessage.md)                 | Contains constants for the crash messages                                                                                    |
| [BoundaryFailure](./case-boundary.boundaryfailure.md)                           | This indicates a failure. Use <code>BoundaryFailureKindConstants</code> to determine what type of failure it is.             |
| [BoundaryFailureKindConstants](./case-boundary.boundaryfailurekindconstants.md) | Constants to use for determining what kind of failure you have                                                               |
| [BoundaryResultTypeConstants](./case-boundary.boundaryresulttypeconstants.md)   | Use these constants to determine what type of result a BoundaryResult is.                                                    |
| [BoundarySuccess](./case-boundary.boundarysuccess.md)                           | This indicates that the result was successful                                                                                |
| [BoundarySuccessWithAny](./case-boundary.boundarysuccesswithany.md)             | <p>This indicates a success with any arbitrary payload</p><p>The calling method usually expects only one type of payload</p> |
| [BoundarySuccessWithMap](./case-boundary.boundarysuccesswithmap.md)             | This indicates a success returning a map of strings to arbitrary payloads                                                    |
| [ConfigLogLevelConstants](./case-boundary.configloglevelconstants.md)           | Convenience class to hold the values for LogLevel so that DSL layers don't need to know the actual value                     |
| [ConfigPublishConstants](./case-boundary.configpublishconstants.md)             | Convenience class to hold the values for the publish setting so that clients don't need to know the strings                  |

## Abstract Classes

| Abstract Class                                                  | Description                                                                                                                                                                                                                                                                                    |
| --------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [BoundaryResult](./case-boundary.boundaryresult.md)             | Supertype for all methods that return results. Use one of <code>BoundarySuccess</code>, <code>BoundaryFailure</code>, or one of the specialised <code>BoundarySuccessWith\*</code> return types as appropriate. See the documentation for the method you're implementing for more information. |
| [BoundaryStateHandler](./case-boundary.boundarystatehandler.md) | An interface for a state handler that only has setup                                                                                                                                                                                                                                           |

## Interfaces

| Interface                                                                   | Description                                                                                                                                                                                                                             |
| --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [BoundaryMockDefinition](./case-boundary.boundarymockdefinition.md)         | This interface describes a Mock Definition, when viewing through jsii                                                                                                                                                                   |
| [ContractCaseBoundaryConfig](./case-boundary.contractcaseboundaryconfig.md) | Configure a ContractCase run. See the \[configuration documentation\](https://case.contract-testing.io/docs/reference/configuring) for more details.                                                                                    |
| [ICombinedPrinter](./case-boundary.icombinedprinter.md)                     | A convenience interface that combines result printing and log printing                                                                                                                                                                  |
| [IInvokeCoreTest](./case-boundary.iinvokecoretest.md)                       | Interface to tell ContractCase to run the test indicated in a call to an IRunTestCallback                                                                                                                                               |
| [ILogPrinter](./case-boundary.ilogprinter.md)                               | Implement this interface to give ContractCase a way to print logs in your target language. Most platforms will want to print to standard out, but some might need to log to a file or otherwise collate the logs.                       |
| [IResultPrinter](./case-boundary.iresultprinter.md)                         | Interface for printing results                                                                                                                                                                                                          |
| [IRunTestCallback](./case-boundary.iruntestcallback.md)                     | This interface allows the DSL layer to invoke the test. If your test runner supports programmatically running different tests, then use this interface to tell a BoundaryContractVerifier how to call back to your DSL with a test name |
| [ITriggerFunction](./case-boundary.itriggerfunction.md)                     | Interface called by ContractCase to invoke user's test code.                                                                                                                                                                            |
| [PrintableMatchError](./case-boundary.printablematcherror.md)               | Data class to hold data to print a message error during matching                                                                                                                                                                        |
| [PrintableMessageError](./case-boundary.printablemessageerror.md)           | Data class to hold data to print a message error                                                                                                                                                                                        |
| [PrintableTestTitle](./case-boundary.printabletesttitle.md)                 | Data class to hold data for a test title print line                                                                                                                                                                                     |
| [UserNamePassword](./case-boundary.usernamepassword.md)                     | Describes a username and password                                                                                                                                                                                                       |

## Type Aliases

| Type Alias                                                                | Description                                                  |
| ------------------------------------------------------------------------- | ------------------------------------------------------------ |
| [BoundaryAnyMatcher](./case-boundary.boundaryanymatcher.md)               | This type is used for any matcher, when viewing through jsii |
| [BoundaryAnyMockDescriptor](./case-boundary.boundaryanymockdescriptor.md) | This type is used for any matcher, when viewing through jsii |
| [BoundaryAnyState](./case-boundary.boundaryanystate.md)                   | This type is used for any matcher, when viewing through jsii |
