-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
lmsp
committed
Oct 30, 2017
1 parent
113f037
commit 19312f2
Showing
1 changed file
with
63 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
<!-- Generated by documentation.js. Update this documentation by updating the source code. --> | ||
|
||
### Table of Contents | ||
|
||
- [equal](#equal) | ||
- [excludeIntersections](#excludeintersections) | ||
- [select](#select) | ||
|
||
## equal | ||
|
||
[src/equal.js:12-21](https://github.com/lmsp/data-ornament/blob/113f0376e31c241b1dd38e4b340dfb233bea4a9e/src/equal.js#L12-L21 "Source code on GitHub") | ||
|
||
equal - Devuelve true si word1 o word1.v es idéntico a word2 o word2.v | ||
|
||
**Parameters** | ||
|
||
- `word1` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))** Primer valor para comprobar igualdad | ||
- `word2` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))** Segundo valor a comprobar igualdad | ||
|
||
Returns **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** | ||
|
||
## excludeIntersections | ||
|
||
[src/excludeIntersections.js:27-27](https://github.com/lmsp/data-ornament/blob/113f0376e31c241b1dd38e4b340dfb233bea4a9e/src/excludeIntersections.js#L27-L27 "Source code on GitHub") | ||
|
||
excludeIntersections - Devuelve una lista de elementos que pertenecen a doc1 | ||
y que no intersectan con ningún elemento de doc2. | ||
La forma de mirar la intersección es peculiar y | ||
consiste en comprobar que el inicio del elemento de doc1 | ||
no cae entre el inicio(incluido) y el final(no incluido) | ||
de los elementos de doc2. | ||
|
||
**Parameters** | ||
|
||
- `doc1` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** Lista de elementos de los que se obtiene el resultado | ||
- `doc2` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** Lista de elementos con los que se comprueba la intersección | ||
|
||
Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** Lista de elementos de doc1 que no intersectan con doc2 | ||
|
||
## select | ||
|
||
[src/select.js:85-85](https://github.com/lmsp/data-ornament/blob/113f0376e31c241b1dd38e4b340dfb233bea4a9e/src/select.js#L85-L85 "Source code on GitHub") | ||
|
||
select - Selecciona todos los elementos que contienen word dentro de doc. | ||
|
||
**Parameters** | ||
|
||
- `word` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Texto a buscar | ||
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Opciones: | ||
**isolatedLeft** Si vale true selecciona sólo los textos | ||
que por la izquierda contengan un espacio, tabulador | ||
o retorno de carro. Valor por defecto false. | ||
**isolatedRight** Si vale true selecciona sólo los textos | ||
que por la derecha contengan un espacio, tabulador o | ||
retorno de carro. Valor por defecto false. | ||
**isolatedBoth** Si vale true selecciona sólo los textos | ||
que tanto por la izquierda como por la derecha contengan | ||
un espacio, tabulador o retorno de carro. Valor por | ||
defecto false. | ||
- `doc` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array))** Documento en el que buscar | ||
|
||
Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** Devuelve el documento que contiene word todas las veces que | ||
aparece en doc |