Skip to content

Commit 7f98a1b

Browse files
authored
Add Tests block to README
1 parent 2601d4d commit 7f98a1b

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,3 +92,13 @@ The client exposing the `address` and `signal` functions
9292
Returns a `Promise`. When successful, `.then(function (addressDetails) {})` is returned. The format and explanation of the returned data can be found [at the official documentation](https://api.postcode.nl/documentation/address-api) of the API. When an error occurs, `.catch(function (err) {})` contains the error given. When `err.code == "PostcodeNl_Service_PostcodeAddress_AddressNotFoundException"`, the `postcode` and `number` supplied do not resolve to an address.
9393

9494
When `numberAddition` is supplied, but `houseNumberAddition` is an empty string, the `numberAddition` can not be verified, but this does not mean that mail sent to this address will not be accepted.
95+
96+
# Tests
97+
98+
To run the tests created for this plugin, run the following command:
99+
100+
```
101+
$ npm test
102+
```
103+
104+
To make sure all tests succeed, make sure that you set the environment variables `API_KEY` and `API_SECRET` to their correct values. Errors will be thrown if the credentials are not valid

0 commit comments

Comments
 (0)