Skip to content

Commit 671ff04

Browse files
TimothyJonesTimothyJones
committed
docs: Correct package names in documentation
1 parent 2759758 commit 671ff04

67 files changed

Lines changed: 3028 additions & 3028 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎packages/case-definition-dsl/api-extractor/case-definition-dsl.api.json‎

Lines changed: 2619 additions & 2619 deletions
Large diffs are not rendered by default.

‎packages/case-definition-dsl/api-extractor/case-definition-dsl.api.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -460,6 +460,15 @@ class InStateWithVariables extends AnyState {
460460
readonly variables: Record<string, AnyMatcherOrData>;
461461
}
462462

463+
declare namespace interactions {
464+
export {
465+
base,
466+
functions,
467+
http
468+
}
469+
}
470+
export { interactions }
471+
463472
declare namespace matchers {
464473
export {
465474
arrays,
@@ -475,15 +484,6 @@ declare namespace matchers {
475484
}
476485
export { matchers }
477486

478-
declare namespace mocks {
479-
export {
480-
base,
481-
functions,
482-
http
483-
}
484-
}
485-
export { mocks }
486-
487487
declare namespace modifiers {
488488
export {
489489
ShapedLike,

packages/case-definition-dsl/docs/case-definition-dsl.mocks.base.anyinteractiondescriptor._constructor_.md renamed to packages/case-definition-dsl/docs/case-definition-dsl.interactions.base.anyinteractiondescriptor._constructor_.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[Home](./index.md) &gt; [@contract-case/case-definition-dsl](./case-definition-dsl.md) &gt; [mocks](./case-definition-dsl.mocks.md) &gt; [base](./case-definition-dsl.mocks.base.md) &gt; [AnyInteractionDescriptor](./case-definition-dsl.mocks.base.anyinteractiondescriptor.md) &gt; [(constructor)](./case-definition-dsl.mocks.base.anyinteractiondescriptor._constructor_.md)
3+
[Home](./index.md) &gt; [@contract-case/case-definition-dsl](./case-definition-dsl.md) &gt; [interactions](./case-definition-dsl.interactions.md) &gt; [base](./case-definition-dsl.interactions.base.md) &gt; [AnyInteractionDescriptor](./case-definition-dsl.interactions.base.anyinteractiondescriptor.md) &gt; [(constructor)](./case-definition-dsl.interactions.base.anyinteractiondescriptor._constructor_.md)
44

5-
## mocks.base.AnyInteractionDescriptor.(constructor)
5+
## interactions.base.AnyInteractionDescriptor.(constructor)
66

77
The base class for all ContractCase Mock Descriptors. Extend this if you are implementing your own mock type.
88

@@ -50,7 +50,7 @@ setup
5050

5151
</td><td>
5252

53-
[ContractCaseCoreSetup](./case-definition-dsl.mocks.base.contractcasecoresetup.md)
53+
[ContractCaseCoreSetup](./case-definition-dsl.interactions.base.contractcasecoresetup.md)
5454

5555
</td><td>
5656

packages/case-definition-dsl/docs/case-definition-dsl.mocks.base.anyinteractiondescriptor.md renamed to packages/case-definition-dsl/docs/case-definition-dsl.interactions.base.anyinteractiondescriptor.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[Home](./index.md) &gt; [@contract-case/case-definition-dsl](./case-definition-dsl.md) &gt; [mocks](./case-definition-dsl.mocks.md) &gt; [base](./case-definition-dsl.mocks.base.md) &gt; [AnyInteractionDescriptor](./case-definition-dsl.mocks.base.anyinteractiondescriptor.md)
3+
[Home](./index.md) &gt; [@contract-case/case-definition-dsl](./case-definition-dsl.md) &gt; [interactions](./case-definition-dsl.interactions.md) &gt; [base](./case-definition-dsl.interactions.base.md) &gt; [AnyInteractionDescriptor](./case-definition-dsl.interactions.base.anyinteractiondescriptor.md)
44

5-
## mocks.base.AnyInteractionDescriptor class
5+
## interactions.base.AnyInteractionDescriptor class
66

77
The base class for all ContractCase Mock Descriptors. Extend this if you are implementing your own mock type.
88

@@ -33,7 +33,7 @@ Description
3333
</th></tr></thead>
3434
<tbody><tr><td>
3535

36-
[(constructor)(mockType, setup)](./case-definition-dsl.mocks.base.anyinteractiondescriptor._constructor_.md)
36+
[(constructor)(mockType, setup)](./case-definition-dsl.interactions.base.anyinteractiondescriptor._constructor_.md)
3737

3838
</td><td>
3939

@@ -65,7 +65,7 @@ Description
6565
</th></tr></thead>
6666
<tbody><tr><td>
6767

68-
[stringify()](./case-definition-dsl.mocks.base.anyinteractiondescriptor.stringify.md)
68+
[stringify()](./case-definition-dsl.interactions.base.anyinteractiondescriptor.stringify.md)
6969

7070
</td><td>
7171

@@ -78,7 +78,7 @@ You shouldn't need to override this method.
7878
</td></tr>
7979
<tr><td>
8080

81-
[toJSON()](./case-definition-dsl.mocks.base.anyinteractiondescriptor.tojson.md)
81+
[toJSON()](./case-definition-dsl.interactions.base.anyinteractiondescriptor.tojson.md)
8282

8383
</td><td>
8484

packages/case-definition-dsl/docs/case-definition-dsl.mocks.base.anyinteractiondescriptor.stringify.md renamed to packages/case-definition-dsl/docs/case-definition-dsl.interactions.base.anyinteractiondescriptor.stringify.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[Home](./index.md) &gt; [@contract-case/case-definition-dsl](./case-definition-dsl.md) &gt; [mocks](./case-definition-dsl.mocks.md) &gt; [base](./case-definition-dsl.mocks.base.md) &gt; [AnyInteractionDescriptor](./case-definition-dsl.mocks.base.anyinteractiondescriptor.md) &gt; [stringify](./case-definition-dsl.mocks.base.anyinteractiondescriptor.stringify.md)
3+
[Home](./index.md) &gt; [@contract-case/case-definition-dsl](./case-definition-dsl.md) &gt; [interactions](./case-definition-dsl.interactions.md) &gt; [base](./case-definition-dsl.interactions.base.md) &gt; [AnyInteractionDescriptor](./case-definition-dsl.interactions.base.anyinteractiondescriptor.md) &gt; [stringify](./case-definition-dsl.interactions.base.anyinteractiondescriptor.stringify.md)
44

5-
## mocks.base.AnyInteractionDescriptor.stringify() method
5+
## interactions.base.AnyInteractionDescriptor.stringify() method
66

77
This method returns the entire example as a JSON string, as a convenience so that wrapper libraries don't need to figure out how to walk a tree of example objects.
88

packages/case-definition-dsl/docs/case-definition-dsl.mocks.base.anyinteractiondescriptor.tojson.md renamed to packages/case-definition-dsl/docs/case-definition-dsl.interactions.base.anyinteractiondescriptor.tojson.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[Home](./index.md) &gt; [@contract-case/case-definition-dsl](./case-definition-dsl.md) &gt; [mocks](./case-definition-dsl.mocks.md) &gt; [base](./case-definition-dsl.mocks.base.md) &gt; [AnyInteractionDescriptor](./case-definition-dsl.mocks.base.anyinteractiondescriptor.md) &gt; [toJSON](./case-definition-dsl.mocks.base.anyinteractiondescriptor.tojson.md)
3+
[Home](./index.md) &gt; [@contract-case/case-definition-dsl](./case-definition-dsl.md) &gt; [interactions](./case-definition-dsl.interactions.md) &gt; [base](./case-definition-dsl.interactions.base.md) &gt; [AnyInteractionDescriptor](./case-definition-dsl.interactions.base.anyinteractiondescriptor.md) &gt; [toJSON](./case-definition-dsl.interactions.base.anyinteractiondescriptor.tojson.md)
44

5-
## mocks.base.AnyInteractionDescriptor.toJSON() method
5+
## interactions.base.AnyInteractionDescriptor.toJSON() method
66

77
Only override this method if you are writing a matcher in a language other than TypeScript.
88

packages/case-definition-dsl/docs/case-definition-dsl.mocks.base.contractcasecorebehaviour.md renamed to packages/case-definition-dsl/docs/case-definition-dsl.interactions.base.contractcasecorebehaviour.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[Home](./index.md) &gt; [@contract-case/case-definition-dsl](./case-definition-dsl.md) &gt; [mocks](./case-definition-dsl.mocks.md) &gt; [base](./case-definition-dsl.mocks.base.md) &gt; [ContractCaseCoreBehaviour](./case-definition-dsl.mocks.base.contractcasecorebehaviour.md)
3+
[Home](./index.md) &gt; [@contract-case/case-definition-dsl](./case-definition-dsl.md) &gt; [interactions](./case-definition-dsl.interactions.md) &gt; [base](./case-definition-dsl.interactions.base.md) &gt; [ContractCaseCoreBehaviour](./case-definition-dsl.interactions.base.contractcasecorebehaviour.md)
44

5-
## mocks.base.ContractCaseCoreBehaviour interface
5+
## interactions.base.ContractCaseCoreBehaviour interface
66

77
This type defines the core behaviour that ContractCase has with this mock.
88

@@ -39,7 +39,7 @@ Description
3939
</th></tr></thead>
4040
<tbody><tr><td>
4141

42-
[mockType](./case-definition-dsl.mocks.base.contractcasecorebehaviour.mocktype.md)
42+
[mockType](./case-definition-dsl.interactions.base.contractcasecorebehaviour.mocktype.md)
4343

4444
</td><td>
4545

@@ -58,7 +58,7 @@ This will almost always be the same as the top level type for your mock during r
5858
</td></tr>
5959
<tr><td>
6060

61-
[stateVariables](./case-definition-dsl.mocks.base.contractcasecorebehaviour.statevariables.md)
61+
[stateVariables](./case-definition-dsl.interactions.base.contractcasecorebehaviour.statevariables.md)
6262

6363
</td><td>
6464

@@ -77,7 +77,7 @@ All other values are errors.
7777
</td></tr>
7878
<tr><td>
7979

80-
[triggers](./case-definition-dsl.mocks.base.contractcasecorebehaviour.triggers.md)
80+
[triggers](./case-definition-dsl.interactions.base.contractcasecorebehaviour.triggers.md)
8181

8282
</td><td>
8383

packages/case-definition-dsl/docs/case-definition-dsl.mocks.base.contractcasecorebehaviour.mocktype.md renamed to packages/case-definition-dsl/docs/case-definition-dsl.interactions.base.contractcasecorebehaviour.mocktype.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[Home](./index.md) &gt; [@contract-case/case-definition-dsl](./case-definition-dsl.md) &gt; [mocks](./case-definition-dsl.mocks.md) &gt; [base](./case-definition-dsl.mocks.base.md) &gt; [ContractCaseCoreBehaviour](./case-definition-dsl.mocks.base.contractcasecorebehaviour.md) &gt; [mockType](./case-definition-dsl.mocks.base.contractcasecorebehaviour.mocktype.md)
3+
[Home](./index.md) &gt; [@contract-case/case-definition-dsl](./case-definition-dsl.md) &gt; [interactions](./case-definition-dsl.interactions.md) &gt; [base](./case-definition-dsl.interactions.base.md) &gt; [ContractCaseCoreBehaviour](./case-definition-dsl.interactions.base.contractcasecorebehaviour.md) &gt; [mockType](./case-definition-dsl.interactions.base.contractcasecorebehaviour.mocktype.md)
44

5-
## mocks.base.ContractCaseCoreBehaviour.mockType property
5+
## interactions.base.ContractCaseCoreBehaviour.mockType property
66

77
The type of this mock. Usually this is inverted on read vs write, for example, a written MOCK_HTTP_CLIENT might become a MOCK_HTTP_SERVER during reading.
88

packages/case-definition-dsl/docs/case-definition-dsl.mocks.base.contractcasecorebehaviour.statevariables.md renamed to packages/case-definition-dsl/docs/case-definition-dsl.interactions.base.contractcasecorebehaviour.statevariables.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[Home](./index.md) &gt; [@contract-case/case-definition-dsl](./case-definition-dsl.md) &gt; [mocks](./case-definition-dsl.mocks.md) &gt; [base](./case-definition-dsl.mocks.base.md) &gt; [ContractCaseCoreBehaviour](./case-definition-dsl.mocks.base.contractcasecorebehaviour.md) &gt; [stateVariables](./case-definition-dsl.mocks.base.contractcasecorebehaviour.statevariables.md)
3+
[Home](./index.md) &gt; [@contract-case/case-definition-dsl](./case-definition-dsl.md) &gt; [interactions](./case-definition-dsl.interactions.md) &gt; [base](./case-definition-dsl.interactions.base.md) &gt; [ContractCaseCoreBehaviour](./case-definition-dsl.interactions.base.contractcasecorebehaviour.md) &gt; [stateVariables](./case-definition-dsl.interactions.base.contractcasecorebehaviour.statevariables.md)
44

5-
## mocks.base.ContractCaseCoreBehaviour.stateVariables property
5+
## interactions.base.ContractCaseCoreBehaviour.stateVariables property
66

77
Whether or not this mock mode will invoke state handlers. If set to `"default"` then ContractCase will not invoke or require the state handlers and will use the default values for all state variables. If set to `"state"`<!-- -->, then ContractCase will invoke the state handlers and require the expected variables to be returned.
88

packages/case-definition-dsl/docs/case-definition-dsl.mocks.base.contractcasecorebehaviour.triggers.md renamed to packages/case-definition-dsl/docs/case-definition-dsl.interactions.base.contractcasecorebehaviour.triggers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[Home](./index.md) &gt; [@contract-case/case-definition-dsl](./case-definition-dsl.md) &gt; [mocks](./case-definition-dsl.mocks.md) &gt; [base](./case-definition-dsl.mocks.base.md) &gt; [ContractCaseCoreBehaviour](./case-definition-dsl.mocks.base.contractcasecorebehaviour.md) &gt; [triggers](./case-definition-dsl.mocks.base.contractcasecorebehaviour.triggers.md)
3+
[Home](./index.md) &gt; [@contract-case/case-definition-dsl](./case-definition-dsl.md) &gt; [interactions](./case-definition-dsl.interactions.md) &gt; [base](./case-definition-dsl.interactions.base.md) &gt; [ContractCaseCoreBehaviour](./case-definition-dsl.interactions.base.contractcasecorebehaviour.md) &gt; [triggers](./case-definition-dsl.interactions.base.contractcasecorebehaviour.triggers.md)
44

5-
## mocks.base.ContractCaseCoreBehaviour.triggers property
5+
## interactions.base.ContractCaseCoreBehaviour.triggers property
66

77
Whether or not this mock mode needs to be triggered by user-provided code. If `"provided"` then ContractCase will require the user to provide a trigger and a test function (eg, for testing an HTTP Client, code that will invoke it must be provided). If `"generated"`<!-- -->, then ContractCase will not require user provided triggers as it will generate them (eg, if the system under test is an HTTP server, ContractCase will generate client calls).
88

0 commit comments

Comments
 (0)