Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve arguments descriptions #65

Merged
merged 3 commits into from
Sep 25, 2024
Merged

Improve arguments descriptions #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2a5069f
Improve arguments descriptions
Marketionist Sep 25, 2024
e513feb
Improve retryIfFalse arguments descriptions
Marketionist Sep 25, 2024
f181008
Improve sendRequest arguments descriptions
Marketionist Sep 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 18 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,23 +49,27 @@ console.log(process.env.TIMESTAMP); // '1588558255810'
```

## Generate current date and time
Sometimes you need to generate current date and time. It can easily be done like
this:
Sometimes you need to generate current date and time. It can easily be done with `generateDateTime` function:
```
const { dateTime } = require('js-automation-tools');

const currentDateTime = dateTime.generateDateTime(); // '2024-09-23T19:26:35'
```
Also you can use a `generateDateTimePlus` function that generates current (if no initial date is provided) date and time plus number of days, hours, minutes, seconds if they are provided. This function accepts configuration object with 5 arguments:
1. `days` - number of days that will be added to current (if no initial date is provided) date and time (optional, default value: `0`).
2. `hours` - number of hours that will be added to current (if no initial date is provided) date and time (optional, default value: `0`).
3. `minutes` - number of minutes that will be added to current (if no initial date is provided) date and time (optional, default value: `0`).
4. `seconds` - number of seconds that will be added to current (if no initial date is provided) date and time (optional, default value: `0`).
5. `initialDate` - string with initial date and time that you want to add a number of days, hours, minutes, seconds to (for example: '2024-03-14T00:14:25', optional, default value: current date and time).
```
const { dateTime } = require('js-automation-tools');

const currentDateTimePlusDay = dateTime.generateDateTimePlus({ days: 1 }); // '2024-09-24T19:26:35'
const currentDateTimePlusHour = dateTime.generateDateTimePlus({ hours: 1 }); // '2024-09-23T20:26:35'
const currentDateTimePlusMinute = dateTime.generateDateTimePlus({ minutes: 1 }); // '2024-09-23T19:27:35'
const currentDateTimePlusSecond = dateTime.generateDateTimePlus({ seconds: 1 }); // '2024-09-23T19:26:36'

const currentDateTimeMinusHour = dateTime.generateDateTimePlus({ hours: -1 }); // '2024-09-23T18:26:35'
```
Also you can call these functions with an optional initial date - to add
days/hours/minutes/seconds to that date:
```
const { dateTime } = require('js-automation-tools');

const pastDateTimePlusDay = dateTime.generateDateTimePlus({ days: 1, initialDate: '2024-03-14T00:14:25' }); // '2024-03-15T00:14:25'
const pastDateTimePlusHour = dateTime.generateDateTimePlus({ hours: 1, initialDate: '2024-03-14T00:14:25' }); // '2024-03-14T01:14:25'
Expand All @@ -89,9 +93,9 @@ Send request to any URL and get response - `sendRequest` function accepts
configuration object with 5 arguments:
1. `method` - string (for example: `'GET'` or `'POST'` or `'DELETE'` or any other).
2. `requestUrl` - string with URL of endpoint to send request to (for example: `'https://www.google.com/'`).
3. `headersString` - string that contains request headers (for example: `'{ "Content-Type": "application/json", "Authorization": "Bearer aBcD1234" }'`).
4. `bodyString` - string that contains request body (for example: `'{ "test1": 1, "test2": 2 }'`).
5. `logLevel` - number (for example: `0` or `1` or `2`, default value: `0` - no logs).
3. `headersString` - string that contains request headers (for example: `'{ "Content-Type": "application/json", "Authorization": "Bearer aBcD1234" }'`, optional).
4. `bodyString` - string that contains request body (for example: `'{ "test1": 1, "test2": 2 }'`, optional).
5. `logLevel` - number (for example: `0` or `1` or `2`, optional, default value: `0` - no logs).

Also you can just call `sendRequest` function without `headersString`,
`bodyString`, `logLevel` arguments if they are not needed - for example in GET
Expand Down Expand Up @@ -138,10 +142,10 @@ check will be `true` or the amount of provided attempts will be exceeded -
```
2. `functionCheck` - function to execute to check the result of
`functionToExecute` (if successful - should return `true`, for example:
`(responseBody) => responseBody.length > 0`).
3. `attempts` - number of attempts to retry (default value: `10`).
4. `waitTime` - time to wait between retries (in milliseconds, default value: `1000`).
5. `logLevel` - number (for example: `0` or `1` or `2`, default value: `0` - no logs).
`(responseBody) => responseBody.length > 0`, optional).
3. `attempts` - number of attempts to retry (optional, default value: `10`).
4. `waitTime` - time to wait between retries in milliseconds (optional, default value: `1000`).
5. `logLevel` - number (for example: `0` or `1` or `2`, optional, default value: `0` - no logs).

> Note: you have to specify the `retryIfFalse` arguments inside the
> configuration object as `key: value` pairs:
Expand Down
8 changes: 4 additions & 4 deletions utils/retry.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ const ERROR_FAILED_FUNCTION_TO_EXECUTE = '\n-> Provided number of attempts was e
* (`functionCheck`) check will be `true` or the amount of provided attempts (`attempts`) will be exceeded.
* @param {Object} configurationObject configuration object with parameters, for example: `{ functionToExecute: myFunction, functionCheck: checkFunction, attempts: 20, waitTime: 5000, logLevel: 2 }`.
* @param {Function} configurationObject.functionToExecute function to execute (for example an API request).
* @param {Function|_returnResult} configurationObject.functionCheck function to execute to check the result of `functionToExecute` (if successful - should return `true`, for example: `(responseBody) => responseBody.length > 0`).
* @param {Number|_attemptsDefault} configurationObject.attempts number of attempts to retry (default value: `10`).
* @param {Number|_waitTimeDefault} configurationObject.waitTime time to wait between retries (in milliseconds, default value: `1000`).
* @param {Number|_logLevelDefault} configurationObject.logLevel number (for example: `0` or `1` or `2`, default value: `0` - no logs).
* @param {Function=} configurationObject.functionCheck function to execute to check the result of `functionToExecute` (if successful - should return `true`, for example: `(responseBody) => responseBody.length > 0`, optional).
* @param {Number=} configurationObject.attempts number of attempts to retry (optional, default value: `10`).
* @param {Number=} configurationObject.waitTime time to wait between retries in milliseconds (optional, default value: `1000`).
* @param {Number=} configurationObject.logLevel number (for example: `0` or `1` or `2`, optional, default value: `0` - no logs).
* @returns {Promise} response of a function that was provided for execution.
*/
async function retryIfFalse ({
Expand Down
6 changes: 3 additions & 3 deletions utils/send-request.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,9 @@ function _handleResponse (response, logLevel, callbackFunction) {
* @param {Object} configurationObject configuration object with parameters, for example: `{ method: 'POST', requestUrl: 'http://httpbin.org/post', headersString: '{ "Content-Type": "application/json", "Authorization": "Bearer aBcD1234" }', bodyString: '{ "test1": 1, "test2": 2 }', logLevel: 1 }`.
* @param {String} configurationObject.method string with method `'GET'` or `'POST'` or `'DELETE'` or any other.
* @param {String} configurationObject.requestUrl string with URL of endpoint to send request to (for example: `'https://www.google.com/'`).
* @param {String|_emptyString} configurationObject.headersString string that contains request headers (for example: `'{ "Content-Type": "application/json", "Authorization": "Bearer aBcD1234" }'`).
* @param {String|_emptyString} configurationObject.bodyString string that contains request body (for example: `'{ "test1": 1, "test2": 2 }'`).
* @param {Number|_logLevelDefault} configurationObject.logLevel number (for example: `0` or `1` or `2`, default value: `0` - no logs).
* @param {String=} configurationObject.headersString string that contains request headers (for example: `'{ "Content-Type": "application/json", "Authorization": "Bearer aBcD1234" }'`, optional).
* @param {String=} configurationObject.bodyString string that contains request body (for example: `'{ "test1": 1, "test2": 2 }'`, optional).
* @param {Number=} configurationObject.logLevel number (for example: `0` or `1` or `2`, optional, default value: `0` - no logs).
* @returns {Promise} response from endpoint. Resolves into an object with `statusCode`, `headers`, `body`.
*/
function sendRequest ({
Expand Down
Loading