Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wezomcompany/toolkit-jest
https://github.com/wezomcompany/toolkit-jest
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/wezomcompany/toolkit-jest
- Owner: WezomCompany
- License: bsd-3-clause
- Created: 2021-02-12T21:50:23.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-10-16T23:30:54.000Z (about 1 year ago)
- Last Synced: 2024-11-06T18:52:27.898Z (9 days ago)
- Language: JavaScript
- Size: 1.23 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @wezom/toolkit-jest
> _Useful tools for working with Jest_
| Statements | Branches | Functions | Lines |
| --------------------------------------------------------------------------- | ---------------------------------------------------------------- | -------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|  |  |  |  |
## Table of Content:
1. [Usage](#usage)
- [Install npm package](#install-npm-package)
1. [Tools](#usage)
1. [`jestFunctionSignatureTest()`](#jestfunctionsignaturetest)
1. [`jestLogMute()` and `jestLogUnmute()`](#jestlogmute-and-jestlogunmute)
1. [Contributing](#contributing)
1. [License](#licence)
---
## Usage
### Install npm package
```bash
npm i @wezom/toolkit-jest
```
---
[▲ Go Top](#) | [▲ Table of Content](#table-of-content)
---
## Tools
### jestFunctionSignatureTest()
[comment]: <> (AUTODOC-TOOL-START::function-signature-test#default)
Function signature test with set of custom cases
_Parameters:_
| Name | Data type | Argument | Default value | Description |
| ------ | -------------------------------- | -------- | ------------- | ----------- |
| method | `T` | | |
| cases | `FunctionSignatureTestCase[]` | | |
_Returns:_ `void`
_Examples:_
```ts
// some-function.ts
export const someFunction = (y: boolean, z: number, w: number): number | null =>
y ? z + w : null;
// some-function.spec.ts
import { someFunction } from 'some-function';
import { jestFunctionSignatureTest } from '@wezom/toolkit-jest';
describe('Function signature should match specification', () => {
jestFunctionSignatureTest(someFunction, [
{
parameters: [true, 4, 5],
expected: 9
},
{
name: 'Custom test name',
parameters: [false, 4, 5],
expected: null
},
{
name: 'Invoke parameters by function',
parameters: () => {
// some logic for generate params
return [...params];
},
expected: null
}
]);
});
```
[comment]: <> (AUTODOC-TOOL-END)
---
[▲ Go Top](#) | [▲ Table of Content](#table-of-content)
---
### jestLogMute() and jestLogUnmute()
[comment]: <> (AUTODOC-TOOL-START::log-mute#jestLogMute)
Mute default `console.log` logging
_Parameters:_
| Name | Data type | Argument | Default value | Description |
| ------ | ------------ | ---------- | ------------- | ----------- |
| method | `MethodType` | _optional_ | `'log'` |
_Returns:_ `void`
_Examples:_
```ts
// some-function.ts
export const someFunction = (x: number, y: number): number => {
console.log('SOME LOG MESSAGE');
return x + y;
};
// some-function.spec.ts
import { someFunction } from 'some-function';
import { jestLogMute, jestLogUnmute } from '@wezom/toolkit-jest';
describe('Should be silent test', () => {
beforeAll(() => jestLogMute());
test('silent testing of the `someFunction`', () => {
expect(someFunction(1, 2)).toBe(3);
});
afterAll(() => jestLogUnmute());
});
```
[comment]: <> (AUTODOC-TOOL-END)
---
[▲ Go Top](#) | [▲ Table of Content](#table-of-content)
---
## Contributing
Please fill free to create [issues](https://github.com/WezomCompany/toolkit-jest/issues) or send [PR](https://github.com/WezomCompany/toolkit-jest/pulls)
## Licence
[BSD-3-Clause License](https://github.com/WezomCompany/toolkit-jest/blob/master/LICENSE)
---