update utils readme to include general utils

This commit is contained in:
Ron Rennick 2021-09-10 15:56:16 -03:00
parent 20cb447204
commit d2a94ba5d9
1 changed files with 29 additions and 1 deletions

View File

@ -78,7 +78,7 @@ This package provides support for enabling retries in tests:
- `MY_ACCOUNT_ADDRESSES` - Customer addresses
- `MY_ACCOUNT_ACCOUNT_DETAILS` - Customer account details
## Test Function
## Test Functions
### Merchant `merchant`
@ -153,6 +153,34 @@ This package provides support for enabling retries in tests:
| `updatePaymentGateway`| `paymentGatewayId`, `payload` | Update a payment gateway |
| `getSystemEnvironment` | | Get the current environment from the WooCommerce system status API.
### Classes
The package includes the following page specific utility classes
#### AdminEdit
The `AdminEdit` class is the base classic custom post type post editor class. It contains the following functions:
| Function | Parameters | Description |
|----------|------------|-------------|
| `verifyPublish` | `button, publishNotice, publishVerification` | Publish the post object currently being edited and verify publish status |
| `getId` | | Get the ID of the post object being edited |
#### OrderEdit
The `OrderEdit` is specific to the order edit screen and extends `AdminEdit`. It has the same functions.
### General Utilities
There is a general utilities object `utils` with the following functions:
| Function | Parameters | Description |
|----------|------------|-------------|
| `getSlug` | `text` | Take a string name and generate the slug for it |
| `describeIf` | `condition` | Return the `describe` or `describe.skip` function when the condition is true / false |
| `it` | `condition` | Return the `it` or `it.skip` function when the condition is true / false |
| `waitForTimeout` | `timeout` | Wait for a timeout in milliseconds |
### Page Utilities
| Function | Parameters | Description |