-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
11 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,9 @@ | ||
[![npm version](https://badge.fury.io/js/%40cowwoc%2Frequirements.svg)](https://badge.fury.io/js/%40cowwoc%2Frequirements) | ||
[![build-status](https://github.com/cowwoc/requirements.js/workflows/Build/badge.svg)](https://github.com/cowwoc/requirements.js/actions?query=workflow%3ABuild) | ||
|
||
# <img src="https://raw.githubusercontent.com/cowwoc/requirements.js/release-4.0.4/docs/checklist.svg?sanitize=true" width=64 height=64 alt="checklist"> Requirements API | ||
# <img src="https://raw.githubusercontent.com/cowwoc/requirements.js/release-4.0.5/docs/checklist.svg?sanitize=true" width=64 height=64 alt="checklist"> Requirements API | ||
|
||
[![API](https://img.shields.io/badge/api_docs-5B45D5.svg)](https://cowwoc.github.io/requirements.js/4.0.4/docs/api/) | ||
[![API](https://img.shields.io/badge/api_docs-5B45D5.svg)](https://cowwoc.github.io/requirements.js/4.0.5/docs/api/) | ||
[![Changelog](https://img.shields.io/badge/changelog-A345D5.svg)](docs/Changelog.md) | ||
[![java](https://img.shields.io/badge/other%20languages-java-457FD5.svg)](../../../requirements.java) | ||
|
||
|
@@ -18,13 +18,13 @@ A [fluent API](https://en.m.wikipedia.org/docs/Fluent_interface) for enforcing | |
To get started, add this dependency: | ||
|
||
```shell | ||
npm install --save @cowwoc/[email protected].4 | ||
npm install --save @cowwoc/[email protected].5 | ||
``` | ||
|
||
or [pnpm](https://pnpm.io/): | ||
|
||
```shell | ||
pnpm add @cowwoc/[email protected].4 | ||
pnpm add @cowwoc/[email protected].5 | ||
``` | ||
|
||
## Usage Example | ||
|
@@ -146,11 +146,11 @@ This library offers the following features: | |
Designed for discovery using your favorite IDE's auto-complete feature. | ||
The main entry points are: | ||
|
||
* [requireThat(value, name)](https://cowwoc.github.io/requirements.js/4.0.4/docs/api/module-DefaultRequirements.html#~requireThat) | ||
* [requireThat(value, name)](https://cowwoc.github.io/requirements.js/4.0.5/docs/api/module-DefaultRequirements.html#~requireThat) | ||
for method preconditions. | ||
* [assertThat(value, name)](https://cowwoc.github.io/requirements.js/4.0.4/docs/api/module-DefaultRequirements.html#~assertThat) | ||
* [assertThat(value, name)](https://cowwoc.github.io/requirements.js/4.0.5/docs/api/module-DefaultRequirements.html#~assertThat) | ||
for [class invariants, method postconditions and private methods](docs/Features.md#assertion-support). | ||
* [checkIf(value, name)](https://cowwoc.github.io/requirements.js/4.0.4/docs/api/module-DefaultRequirements.html#~checkIf) | ||
* [checkIf(value, name)](https://cowwoc.github.io/requirements.js/4.0.5/docs/api/module-DefaultRequirements.html#~checkIf) | ||
for multiple failures and customized error handling. | ||
|
||
See the [API documentation](https://cowwoc.github.io/requirements.java/10.0/docs/api/) for more details. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters