jsdoc-tests
Version:
A JSDoc test tool for documentation-driven quality
51 lines (38 loc) • 1.01 kB
Markdown
# jsdoc-tests
[](http://badge.fury.io/js/jsdoc-tests)
A JSDoc test tool for documentation-driven quality, support async function and export module(ES module/CommonJS).
## Installation
```sh
yarn add -D jsdoc-tests # npm install -D jsdoc-tests
```
## Usage
- Create A source code in `./src/example.ts` with JSDoc.
````ts
/**
* Two numbers added together
*
* @param a {number}
* @param b {number}
*
* @example
*
* ```ts
* import { add } from './src/example';
*
* expect(add(1, 2)).toBe(3);
* ```
*/
export const add = (a: number, b: number) => {
return a + b;
};
````
- Create a test code in `./test/index.test.ts`.
```ts
import { jsdocTests } from 'jsdoc-tests';
test('test "add" function', () => {
jsdocTests('./src/example.ts');
});
```
## License
`jsdoc-tests` is [MIT licensed](https://github.com/testkits/jsdoc-tests/blob/master/LICENSE).