Skip to content

Commit 7cebe2d

Browse files
committed
Fix doc links in module-utils
1 parent 6ec91d8 commit 7cebe2d

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

src/ox_modules/module-utils.js

+9-9
Original file line numberDiff line numberDiff line change
@@ -54,19 +54,19 @@ export default class UtilsModule extends OxygenModule {
5454
* @return {Object} DecryptResult Object with getDecryptResult method
5555
* @example <caption>[javascript] Usage example</caption>
5656
* // to encrypt plaintext into ciphertext
57-
* const encrypt = utils.encrypt('https://www.wikipedia.org/');
57+
* const encrypt = utils.encrypt('https://www.wikipedia.org');
5858
* log.info(encrypt); // will print b757ba2c2fc50fbb511d596816ca06c4fa56f4e98ce222f30bc58d5251ed635e
5959
*
6060
* // to decrypt ciphertext and use it in script
6161
* const decrypt = utils.decrypt(encrypt);
6262
* log.info(decrypt); // will print ENCRYPTED
6363
*
6464
* web.init();
65-
* web.open(decrypt); // will open https://www.wikipedia.org/
65+
* web.open(decrypt); // will open https://www.wikipedia.org
6666
*
6767
* // to get original plaintext use getDecryptResult
6868
* const value = decrypt.getDecryptResult();
69-
* log.info(value); //will print https://www.wikipedia.org/
69+
* log.info(value); //will print https://www.wikipedia.org
7070
*/
7171
decrypt(text) {
7272
return libUtils.decrypt(text);
@@ -79,19 +79,19 @@ export default class UtilsModule extends OxygenModule {
7979
* @return {String} Encrypted text
8080
* @example <caption>[javascript] Usage example</caption>
8181
* // to encrypt plaintext into ciphertext
82-
* const encrypt = utils.encrypt('https://www.wikipedia.org/');
82+
* const encrypt = utils.encrypt('https://www.wikipedia.org');
8383
* log.info(encrypt); // will print b757ba2c2fc50fbb511d596816ca06c4fa56f4e98ce222f30bc58d5251ed635e
8484
*
8585
* // to decrypt ciphertext and use it in script
8686
* const decrypt = utils.decrypt(encrypt);
8787
* log.info(decrypt); // will print ENCRYPTED
8888
*
8989
* web.init();
90-
* web.open(decrypt); // will open https://www.wikipedia.org/
90+
* web.open(decrypt); // will open https://www.wikipedia.org
9191
*
9292
* // to get original plaintext use getDecryptResult
9393
* const value = decrypt.getDecryptResult();
94-
* log.info(value); //will print https://www.wikipedia.org/
94+
* log.info(value); //will print https://www.wikipedia.org
9595
*/
9696
encrypt(text) {
9797
return libUtils.encrypt(text);
@@ -100,7 +100,7 @@ export default class UtilsModule extends OxygenModule {
100100
* @summary Reads data from csv file
101101
* @function readCsv
102102
* @param {String} filePath - Absolute path to file
103-
* @param {Object=} options - Options (https://csv.js.org/parse/options/)
103+
* @param {Object=} options - [Options](https://csv.js.org/parse/options/)
104104
*/
105105
readCsv(filePath, options = {}) {
106106
const parse = require('csv-parse/lib/sync');
@@ -144,7 +144,7 @@ export default class UtilsModule extends OxygenModule {
144144
* @function writeCsv
145145
* @param {String} filePath - Absolute path to file
146146
* @param {Array} data - CSV data in format [{column_name_1: 'foo', column_name_2: 'bar'}]
147-
* @param {Object=} options - Options (https://github.com/anton-bot/objects-to-csv#async-todiskfilename-options)
147+
* @param {Object=} options - [Options](https://github.com/anton-bot/objects-to-csv#async-todiskfilename-options)
148148
*/
149149
async writeCsv(filePath, data, options = {}) {
150150
try {
@@ -194,7 +194,7 @@ export default class UtilsModule extends OxygenModule {
194194
* @summary Parse XML data to JS object
195195
* @function xmlToJson
196196
* @param {string|Buffer} xmlDataStr - Like <root a="nice" b="very nice" ><a>wow</a></root>
197-
* @param {boolean|Object} options - Options (https://github.com/NaturalIntelligence/fast-xml-parser/blob/b0ea6358844ccca95cab02758e038c1c3321427e/docs/v4/2.XMLparseOptions.md)
197+
* @param {boolean|Object} options - [Options](https://github.com/NaturalIntelligence/fast-xml-parser/blob/master/docs/v4/2.XMLparseOptions.md)
198198
*/
199199
xmlToJson(xmlDataStr, options = {}) {
200200
try {

0 commit comments

Comments
 (0)