2020-07-08 00:17:31 +00:00
# @pushrocks/tapbundle
tap bundled for tapbuffer
## Availabililty and Links
* [npmjs.org (npm package) ](https://www.npmjs.com/package/@pushrocks/tapbundle )
* [gitlab.com (source) ](https://gitlab.com/pushrocks/tapbundle )
* [github.com (source mirror) ](https://github.com/pushrocks/tapbundle )
* [docs (typedoc) ](https://pushrocks.gitlab.io/tapbundle/ )
## Status for master
2020-07-11 16:07:30 +00:00
Status Category | Status Badge
-- | --
GitLab Pipelines | [](https://lossless.cloud)
GitLab Pipline Test Coverage | [](https://lossless.cloud)
npm | [](https://lossless.cloud)
Snyk | [](https://lossless.cloud)
TypeScript Support | [](https://lossless.cloud)
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
Code Style | [](https://lossless.cloud)
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
PackagePhobia (package size on registry) | [](https://lossless.cloud)
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
2020-07-08 00:17:31 +00:00
## Usage
Use TypeScript for best in class instellisense.
A few words on TypeScript
### Included in this package
2022-02-15 15:40:21 +00:00
* tap compatible testing framework written in TypeScript
* `expect` and `expectAsync` from the package `@pushrocks/smartexpect`
2020-07-08 00:17:31 +00:00
### Write your first tests
2022-02-15 15:40:21 +00:00
```typescript
import { tap, expect, expectAsync } from 'tapbundle'; // has typings in place
2020-07-08 00:17:31 +00:00
import * as myAwesomeModuleToTest from '../dist/index'; // '../dist/index' is the standard path for npmts modules
2020-07-11 16:07:30 +00:00
tap.test('my awesome description', async (tools) => {
2020-07-08 00:17:31 +00:00
// tools are optional parameter
tools.timeout(2000); // test will fail if it takes longer than 2000 millisenconds
});
2022-02-15 15:40:21 +00:00
const myTest2 = tap.test('my awesome test 2', async (tools) => {
2020-07-08 00:17:31 +00:00
myAwsomeModuleToTest.doSomethingAsync(); // we don't wait here
await tools.delayFor(3000); // yay! :) promise based timeouts :)
console.log('This gets logged 3000 ms into the test');
});
2020-07-11 16:07:30 +00:00
tap.test('my awesome test 3', async (tools) => {
2022-02-15 15:40:21 +00:00
expect(true).toBeTrue(); // will not throw
await expectAsync(tools.delayFor(2000)).toBeUndefined(); // yay expect promises :)
expectAsync(myTest2.promise) // access other tests metadata :)
.property('hrtMeasurement') // and drill down into properties
.property('milliSeconds').toBeGreaterThan(1000);
2020-07-08 00:17:31 +00:00
});
2022-02-15 15:40:21 +00:00
const myTest4 = tap.testParallel('my awesome test 4', async (tools) => {
2020-07-08 00:17:31 +00:00
await tools.delayFor(4000);
console.log('logs to console after 4 seconds into this test');
});
tap.test('my awesome test 5', async () => {
2022-02-15 15:40:21 +00:00
expect(myTest4.status).toEqual('pending'); // since this test will likely finish before myTest4.
2020-07-08 00:17:31 +00:00
});
tap.start(); // start the test, will automtically plan tests for you (so the tap parser knows when tests exit bofore they are finished)
```
## Contribution
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time ](https://lossless.link/contribute-onetime ) or [contribute monthly ](https://lossless.link/contribute ). :)
For further information read the linked docs at the top of this readme.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
| By using this npm module you agree to our [privacy policy ](https://lossless.gmbH/privacy )
[](https://maintainedby.lossless.com)
