Module: test
Classes
Type Aliases
ActionMockableFactory
Ƭ ActionMockableFactory<Args, Context, Extension>: { $mock: ActionFactoryMock<Args, Context, Extension> | null ; $real: ActionFactory<Args, Context, Extension> } & ActionFactory<Args, Context, Extension>
Proxy of an action factory which can easily be mocked.
Type parameters
| Name | Type |
|---|---|
Args | extends any[] |
Context | extends Object |
Extension | extends Object |
Defined in
src/test/types.ts:37
ActionMockedExpectation
Ƭ ActionMockedExpectation<Context>: (context: Context) => Awaitable<void>
Type parameters
| Name | Type |
|---|---|
Context | extends Object = any |
Type declaration
▸ (context): Awaitable<void>
Mocked action run expectation to run before returning result.
Parameters
| Name | Type |
|---|---|
context | Context |
Returns
Awaitable<void>
Defined in
src/test/types.ts:21
ActionMockedPredicate
Ƭ ActionMockedPredicate<Context>: (context: Context) => Awaitable<boolean | void>
Type parameters
| Name | Type |
|---|---|
Context | extends Object = any |
Type declaration
▸ (context): Awaitable<boolean | void>
Mocked action run predicate to ensure the right context is intercepted.
Parameters
| Name | Type |
|---|---|
context | Context |
Returns
Awaitable<boolean | void>
Defined in
src/test/types.ts:15
ActionMockedResult
Ƭ ActionMockedResult<Context>: unknown | (context: Context) => Awaitable<unknown>
Mocked action run result definition (factory function or raw value).
Type parameters
| Name | Type |
|---|---|
Context | extends Object = any |
Defined in
src/test/types.ts:8
ActionMockedRunOptions
Ƭ ActionMockedRunOptions<Context>: Object
Options to configure a mocked action run.
Type parameters
| Name | Type |
|---|---|
Context | extends Object = any |
Type declaration
| Name | Type |
|---|---|
expectation? | ActionMockedExpectation<Context> |
predicate? | ActionMockedPredicate<Context> |
result? | ActionMockedResult<Context> |
times? | number |
Defined in
src/test/types.ts:27
Functions
makeActionFactoryMockable
▸ makeActionFactoryMockable<A, C, E>(factory): ActionMockableFactory<A, C, E>
Creates a proxy of an action factory which can be mocked.
Type parameters
| Name | Type |
|---|---|
A | extends any[] |
C | extends Object |
E | extends Object |
Parameters
| Name | Type |
|---|---|
factory | ActionFactory<A, C, E> |
Returns
ActionMockableFactory<A, C, E>
Defined in
src/test/makeActionFactoryMockable.ts:10
mockAction
▸ mockAction<A, C, E>(factory): default<A, C, E>
Starts mocking a mockable action factory.
Type parameters
| Name | Type |
|---|---|
A | extends any[] |
C | extends Object |
E | extends Object |
Parameters
| Name | Type |
|---|---|
factory | ActionMockableFactory<A, C, E> |
Returns
default<A, C, E>
Defined in
src/test/mockAction.ts:9
unmockAction
▸ unmockAction<A, C, E>(factory): void
Stops mocking a mockable action factory.
Type parameters
| Name | Type |
|---|---|
A | extends any[] |
C | extends Object |
E | extends Object |
Parameters
| Name | Type |
|---|---|
factory | ActionMockableFactory<A, C, E> |
Returns
void
Defined in
src/test/unmockAction.ts:8