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

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

## ContractCaseBoundaryConfig interface

Configure a ContractCase run. See the \[configuration documentation\](https://case.contract-testing.io/docs/reference/configuring) for more details.

**Signature:**

```typescript
export interface ContractCaseBoundaryConfig
```

## Properties

| Property                                                                                  | Modifiers             | Type                                                                                          | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| ----------------------------------------------------------------------------------------- | --------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [baseUrlUnderTest?](./case-boundary.contractcaseboundaryconfig.baseurlundertest.md)       | <code>readonly</code> | string                                                                                        | _(Optional)_ The base URL for your real server, if you are testing an http server.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| [brokerBaseUrl?](./case-boundary.contractcaseboundaryconfig.brokerbaseurl.md)             | <code>readonly</code> | string                                                                                        | _(Optional)_ The base URL for the contract broker                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| [brokerBasicAuth?](./case-boundary.contractcaseboundaryconfig.brokerbasicauth.md)         | <code>readonly</code> | [UserNamePassword](./case-boundary.usernamepassword.md)                                       | <p>_(Optional)_ The basic authentication username and password to access the contract broker.</p><p>If this is specified along with brokerCiAccessToken, the basic auth is ignored.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| [brokerCiAccessToken?](./case-boundary.contractcaseboundaryconfig.brokerciaccesstoken.md) | <code>readonly</code> | string                                                                                        | <p>_(Optional)_ The access token to use for the contract broker. Must have CI scope.</p><p>If this is specified along with brokerBasicAuth, the basic auth is ignored.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| [consumerName?](./case-boundary.contractcaseboundaryconfig.consumername.md)               | <code>readonly</code> | string                                                                                        | _(Optional)_ The name of the consumer for this contract.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| [contractDir?](./case-boundary.contractcaseboundaryconfig.contractdir.md)                 | <code>readonly</code> | string                                                                                        | _(Optional)_ The directory where the contract will be written. If you provide this, ContractCase will generate the filename for you (unless <code>contractFilename</code> is specified, in which case this setting is ignored)                                                                                                                                                                                                                                                                                                                                                                                              |
| [contractFilename?](./case-boundary.contractcaseboundaryconfig.contractfilename.md)       | <code>readonly</code> | string                                                                                        | _(Optional)_ The filename where the contract will be written. If you provide this, <code>contractDir</code> is ignored                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| [logLevel?](./case-boundary.contractcaseboundaryconfig.loglevel.md)                       | <code>readonly</code> | string                                                                                        | <p>_(Optional)_ logLevel - one of:</p><p><code>&quot;none&quot;</code> - Print no logs (note, results may still be printed - see <code>printResults</code>)</p><p><code>&quot;error&quot;</code> - Something has gone wrong during the execution of the test framework</p><p><code>&quot;warn&quot;</code> - It seems likely that there is a misconfiguration</p><p><code>&quot;debug&quot;</code> - Information to help users find out what is happening during their tests</p><p><code>&quot;maintainerDebug&quot; &#124; &quot;deepMaintainerDebug&quot;</code> - debugging information for ContractCase maintainers</p> |
| [printResults?](./case-boundary.contractcaseboundaryconfig.printresults.md)               | <code>readonly</code> | boolean                                                                                       | _(Optional)_ Whether results should be printed on standard out                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| [providerName?](./case-boundary.contractcaseboundaryconfig.providername.md)               | <code>readonly</code> | string                                                                                        | _(Optional)_ The name of the provider for this contract.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| [publish?](./case-boundary.contractcaseboundaryconfig.publish.md)                         | <code>readonly</code> | string \| undefined                                                                           | <p>_(Optional)_ Whether to publish contracts or verification results to the broker</p><p><code>&quot;ONLY_IN_CI&quot;</code> - only when in in CI according to https://github.com/watson/ci-info\#supported-ci-tools <code>&quot;NEVER&quot;</code> or <code>false</code> - never publish <code>&quot;ALWAYS&quot;</code> or <code>true</code> - always publish (not recommended)</p><p>Default: <code>&quot;ONLY_IN_CI&quot;</code></p>                                                                                                                                                                                    |
| [stateHandlers?](./case-boundary.contractcaseboundaryconfig.statehandlers.md)             | <code>readonly</code> | Record&lt;string, [BoundaryStateHandler](./case-boundary.boundarystatehandler.md)<!-- -->&gt; | _(Optional)_ State setup and teardown handlers for any states this test requires (see \[writing state handlers\](https://case.contract-testing.io/docs/reference/state-handlers/)) for more details                                                                                                                                                                                                                                                                                                                                                                                                                         |
| [testRunId?](./case-boundary.contractcaseboundaryconfig.testrunid.md)                     | <code>readonly</code> | string                                                                                        | _(Optional)_ Unique ID for this segment of the test run - it must be unique within a run, but need not be unique between test runs. This is an internal implementation detail, and authors of DSL layers shouldn't expose it to clients.                                                                                                                                                                                                                                                                                                                                                                                    |
| [throwOnFail?](./case-boundary.contractcaseboundaryconfig.throwonfail.md)                 | <code>readonly</code> | boolean                                                                                       | <p>_(Optional)_ Whether or not the test should throw an error if the matching fails.</p><p>Note that any configuration errors will still fail the suite regardless of this setting. This includes exceptions thrown during trigger functions, but does not include exceptions thrown by testResponse functions.</p><p>Default: <code>true</code> in contract definition, <code>false</code> in contract verification</p>                                                                                                                                                                                                    |
| [triggerAndTest?](./case-boundary.contractcaseboundaryconfig.triggerandtest.md)           | <code>readonly</code> | [ITriggerFunction](./case-boundary.itriggerfunction.md)                                       | _(Optional)_ Call the native trigger and test function (if any) for this interaction pair.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| [triggerAndTests?](./case-boundary.contractcaseboundaryconfig.triggerandtests.md)         | <code>readonly</code> | Record&lt;string, [ITriggerFunction](./case-boundary.itriggerfunction.md)<!-- -->&gt;         | <p>_(Optional)_ A Map of native trigger and test functions (if any) for several interaction pairs. Most useful during verification, but also valid during definition</p><p>Keyed by <code>${requestName}::${responseName}</code></p>                                                                                                                                                                                                                                                                                                                                                                                        |
