Skip to content

Commit a413197

Browse files
committed
update readme example with await
1 parent fd27b3a commit a413197

File tree

2 files changed

+20
-12
lines changed

2 files changed

+20
-12
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -299,13 +299,13 @@ var HtmlDiffer = require('@markedjs/html-differ').HtmlDiffer,
299299

300300
**@param** *{String}* - the 1-st HTML code<br>
301301
**@param** *{String}* - the 2-nd HTML code<br>
302-
**@returns** *{Array of objects}* - [array with diffs](https://github.com/kpdecker/jsdiff#change-objects) between HTML
302+
**@returns** *Promise<{Array of objects}>* - [array with diffs](https://github.com/kpdecker/jsdiff#change-objects) between HTML
303303

304304
##### htmlDiffer.isEqual
305305

306306
**@param** *{String}* - the 1-st HTML code<br>
307307
**@param** *{String}* - the 2-nd HTML code<br>
308-
**@returns** *{Boolean}*
308+
**@returns** *Promise<{Boolean}>*
309309

310310

311311
### Logger
@@ -356,11 +356,15 @@ var options = {
356356

357357
var htmlDiffer = new HtmlDiffer(options);
358358

359-
var diff = htmlDiffer.diffHtml(html1, html2),
360-
isEqual = htmlDiffer.isEqual(html1, html2),
361-
res = logger.getDiffText(diff, { charsAroundDiff: 40 });
359+
async function run() {
360+
const diff = await htmlDiffer.diffHtml(html1, html2);
361+
const isEqual = await htmlDiffer.isEqual(html1, html2);
362+
const res = logger.getDiffText(diff, { charsAroundDiff: 40 });
362363

363-
logger.logDiffText(diff, { charsAroundDiff: 40 });
364+
logger.logDiffText(diff, { charsAroundDiff: 40 });
365+
}
366+
367+
run();
364368
```
365369

366370
## Usage as a program

README.ru.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -297,13 +297,13 @@ var HtmlDiffer = require('html-differ').HtmlDiffer,
297297

298298
**@param** *{String}* - 1-й HTML<br>
299299
**@param** *{String}* - 2-й HTML<br>
300-
**@returns** *{Array of objects}* - [массив с отличиями](https://github.com/kpdecker/jsdiff#change-objects) между HTML
300+
**@returns** *Promise<{Array of objects}>* - [массив с отличиями](https://github.com/kpdecker/jsdiff#change-objects) между HTML
301301

302302
##### htmlDiffer.isEqual
303303

304304
**@param** *{String}* - 1-й HTML<br>
305305
**@param** *{String}* - 2-й HTML<br>
306-
**@returns** *{Boolean}*
306+
**@returns** *Promise<{Boolean}>*
307307

308308
### Logger
309309

@@ -353,11 +353,15 @@ var options = {
353353

354354
var htmlDiffer = new HtmlDiffer(options);
355355

356-
var diff = htmlDiffer.diffHtml(html1, html2),
357-
isEqual = htmlDiffer.isEqual(html1, html2),
358-
res = logger.getDiffText(diff, { charsAroundDiff: 40 });
356+
async function run() {
357+
const diff = await htmlDiffer.diffHtml(html1, html2);
358+
const isEqual = await htmlDiffer.isEqual(html1, html2);
359+
const res = logger.getDiffText(diff, { charsAroundDiff: 40 });
359360

360-
logger.logDiffText(diff, { charsAroundDiff: 40 });
361+
logger.logDiffText(diff, { charsAroundDiff: 40 });
362+
}
363+
364+
run();
361365
```
362366

363367
## Использование в качестве программы

0 commit comments

Comments
 (0)