Skip to content

Commit 87dedb6

Browse files
authored
readme: add links to section: change objects (#316)
1 parent 021c973 commit 87dedb6

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,52 +17,52 @@ npm install diff --save
1717

1818
* `Diff.diffChars(oldStr, newStr[, options])` - diffs two blocks of text, comparing character by character.
1919

20-
Returns a list of change objects (See below).
20+
Returns a list of [change objects](#change-objects).
2121

2222
Options
2323
* `ignoreCase`: `true` to ignore casing difference. Defaults to `false`.
2424

2525
* `Diff.diffWords(oldStr, newStr[, options])` - diffs two blocks of text, comparing word by word, ignoring whitespace.
2626

27-
Returns a list of change objects (See below).
27+
Returns a list of [change objects](#change-objects).
2828

2929
Options
3030
* `ignoreCase`: Same as in `diffChars`.
3131

3232
* `Diff.diffWordsWithSpace(oldStr, newStr[, options])` - diffs two blocks of text, comparing word by word, treating whitespace as significant.
3333

34-
Returns a list of change objects (See below).
34+
Returns a list of [change objects](#change-objects).
3535

3636
* `Diff.diffLines(oldStr, newStr[, options])` - diffs two blocks of text, comparing line by line.
3737

3838
Options
3939
* `ignoreWhitespace`: `true` to ignore leading and trailing whitespace. This is the same as `diffTrimmedLines`
4040
* `newlineIsToken`: `true` to treat newline characters as separate tokens. This allows for changes to the newline structure to occur independently of the line content and to be treated as such. In general this is the more human friendly form of `diffLines` and `diffLines` is better suited for patches and other computer friendly output.
4141

42-
Returns a list of change objects (See below).
42+
Returns a list of [change objects](#change-objects).
4343

4444
* `Diff.diffTrimmedLines(oldStr, newStr[, options])` - diffs two blocks of text, comparing line by line, ignoring leading and trailing whitespace.
4545

46-
Returns a list of change objects (See below).
46+
Returns a list of [change objects](#change-objects).
4747

4848
* `Diff.diffSentences(oldStr, newStr[, options])` - diffs two blocks of text, comparing sentence by sentence.
4949

50-
Returns a list of change objects (See below).
50+
Returns a list of [change objects](#change-objects).
5151

5252
* `Diff.diffCss(oldStr, newStr[, options])` - diffs two blocks of text, comparing CSS tokens.
5353

54-
Returns a list of change objects (See below).
54+
Returns a list of [change objects](#change-objects).
5555

5656
* `Diff.diffJson(oldObj, newObj[, options])` - diffs two JSON objects, comparing the fields defined on each. The order of fields, etc does not matter in this comparison.
5757

58-
Returns a list of change objects (See below).
58+
Returns a list of [change objects](#change-objects).
5959

6060
* `Diff.diffArrays(oldArr, newArr[, options])` - diffs two arrays, comparing each item for strict equality (===).
6161

6262
Options
6363
* `comparator`: `function(left, right)` for custom equality checks
6464

65-
Returns a list of change objects (See below).
65+
Returns a list of [change objects](#change-objects).
6666

6767
* `Diff.createTwoFilesPatch(oldFileName, newFileName, oldStr, newStr, oldHeader, newHeader)` - creates a unified diff patch.
6868

0 commit comments

Comments
 (0)