66 lines
1.7 KiB
Markdown
66 lines
1.7 KiB
Markdown
|
<!-- DO NOT EDIT MANUALLY, THIS FILE HAS BEEN GENERATED -->
|
||
|
|
|
||
|
|
# @vates/diff
|
||
|
|
|
||
|
|
[](https://npmjs.org/package/@vates/diff)  [](https://bundlephobia.com/result?p=@vates/diff) [](https://npmjs.org/package/@vates/diff)
|
||
|
|
|
||
|
|
> Computes differences between two arrays, buffers or strings
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
Installation of the [npm package](https://npmjs.org/package/@vates/diff):
|
||
|
|
|
||
|
|
```sh
|
||
|
|
npm install --save @vates/diff
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```js
|
||
|
|
import diff from '@vates/diff'
|
||
|
|
|
||
|
|
diff('foo bar baz', 'Foo qux')
|
||
|
|
// → [ 0, 'F', 4, 'qux', 7, '' ]
|
||
|
|
//
|
||
|
|
// Differences of the second string from the first one:
|
||
|
|
// - at position 0, it contains `F`
|
||
|
|
// - at position 4, it contains `qux`
|
||
|
|
// - at position 7, it ends
|
||
|
|
|
||
|
|
diff('Foo qux', 'foo bar baz')
|
||
|
|
// → [ 0, 'f', 4, 'bar', 7, ' baz' ]
|
||
|
|
//
|
||
|
|
// Differences of the second string from the first one:
|
||
|
|
// - at position 0, it contains f`
|
||
|
|
// - at position 4, it contains `bar`
|
||
|
|
// - at position 7, it contains `baz`
|
||
|
|
|
||
|
|
// works with all collections that supports
|
||
|
|
// - `.length`
|
||
|
|
// - `collection[index]`
|
||
|
|
// - `.slice(start, end)`
|
||
|
|
//
|
||
|
|
// which includes:
|
||
|
|
// - arrays
|
||
|
|
// - strings
|
||
|
|
// - `Buffer`
|
||
|
|
// - `TypedArray`
|
||
|
|
diff([0, 1, 2], [3, 4])
|
||
|
|
// → [ 0, [ 3, 4 ], 2, [] ]
|
||
|
|
```
|
||
|
|
|
||
|
|
## Contributions
|
||
|
|
|
||
|
|
Contributions are _very_ welcomed, either on the documentation or on
|
||
|
|
the code.
|
||
|
|
|
||
|
|
You may:
|
||
|
|
|
||
|
|
- report any [issue](https://github.com/vatesfr/xen-orchestra/issues)
|
||
|
|
you've encountered;
|
||
|
|
- fork and create a pull request.
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
[ISC](https://spdx.org/licenses/ISC) © [Vates SAS](https://vates.fr)
|