constants tests and documentation

This commit is contained in:
2021-03-04 11:10:28 -06:00
parent 3031212380
commit d70918e264
4 changed files with 60 additions and 17 deletions

View File

@@ -40,6 +40,18 @@ also be set to a strong, random password.
* For Skynet mounts, add `-sk` argument to all commands listed above.
* For ScPrime mounts, add `-sp` argument to all commands listed above.
## Module Environment Variables
* To successfully complete unit tests, a `repertory` mount supporting remote mount needs to be
active. Set the following environment variables prior to running tests:
* `TEST_HOST`
* `TEST_PASSWORD`
* `TEST_PORT`
* To override the version being sent to `repertory`, set the following variable:
* `REPERTORY_JS_FORCE_VERSION`
* NOTE: This variable is primarily used for debugging/testing purposes and should normally
NOT be set.
## Example API Usage
```javascript