Items

get(options?: getOptions): Promise

Esta función se utiliza para obtener elementos de una colección. Ofrece varias opciones de configuración para personalizar el proceso de recuperación.

Options

options (opcional): Un objeto de tipo getOptions que contiene opciones de configuración para la operación de recuperación. Esta interfaz define la estructura de las opciones que se pueden proporcionar como argumento a la función get para personalizar la recuperación de elementos de una colección.

$3

- includes (opcional): Un arreglo de cadenas que especifica qué campos deben incluirse en los elementos recuperados.

- plugin (opcional): Una cadena que indica el nombre del complemento a utilizar para la recuperación de datos. Por ejemplo, 'default' o 'algolia'.

- pagination: Un objeto que contiene las opciones de paginación.

- rowsPerPage: Un número entero que define la cantidad máxima de elementos por página.

- page: Un número entero que representa la página que se desea recuperar.

- total: Un número entero que indica el total de elementos en la colección.

- sortBy: Una cadena que especifica el campo por el cual ordenar los elementos.

- sortType: Una cadena que indica el tipo de ordenamiento, como 'asc' (ascendente) o 'desc' (descendente).

- query (opcional): Una cadena que contiene un término de búsqueda o una consulta para filtrar elementos.

- filters (opcional): Un objeto que define filtros para refinar la búsqueda. Puede contener propiedades como el nombre del campo, el operador y el valor del filtro.

- localFilters (opcional): Un objeto que define filtros locales específicos para la recuperación de datos en el almacenamiento local.

- searchText (opcional): Una cadena que contiene el texto de búsqueda para buscar elementos que coincidan con el texto.

- searchIn (opcional): Un arreglo de cadenas que especifica en qué campos buscar el texto de búsqueda.

- withDeletes (opcional): Un booleano que, si se establece en true, permite recuperar elementos que han sido eliminados.

- onlyDeletes (opcional): Un booleano que, si se establece en true, permite recuperar solo elementos que han sido eliminados.

- deep (opcional): Un booleano que indica si se debe realizar una recuperación profunda de elementos relacionados.

- level (opcional): Un número entero que especifica el nivel de profundidad para la recuperación de elementos relacionados.

- orders (opcional): Un arreglo de cadenas que especifica el orden en el que se deben ordenar los elementos recuperados.

$3

``javascript
const options = {
includes: ['field1', 'field2'],
plugin: 'algolia',
pagination: {
rowsPerPage: 10,
page: 1,
total: 0,
sortBy: 'created_at',
sortType: 'desc',
},
query: 'keyword',
filters: { key: 'category', operator: '==', value: 'electronics' },
searchText: 'search text',
searchIn: ['title', 'description'],
withDeletes: false,
onlyDeletes: false,
deep: true,
level: 2,
orders: ['field1', 'field2'],
};
`

Valor de Retorno

Una Promesa que se resuelve en un objeto con las siguientes propiedades:

- success: Un booleano que indica el éxito de la operación.
- items: Un arreglo de elementos recuperados.
- pages: El número total de páginas (si se utiliza paginación).
- total: El número total de elementos en la colección.

Uso

`javascript
const options = {
// Las opciones de configuración van aquí
};

const resultado = await items.get(options);
console.log(resultado);
`

find - Método para Buscar un Documento

Este método se utiliza para buscar un documento en una colección por su identificador (id). Proporciona opciones de configuración para personalizar la búsqueda.

Parámetros

- id: Una cadena que representa el identificador del documento que se desea buscar.

- options (opcional): Un objeto de tipo findOptions que contiene opciones de configuración para la búsqueda.

Valor de Retorno

Una Promesa que se resuelve en un objeto con las siguientes propiedades:

- success: Un booleano que indica el éxito de la operación.
- ref: Una referencia al documento encontrado.
- data: Los datos del documento encontrado, que pueden ser planos o con referencias incrustadas según las opciones de búsqueda.
- id: El identificador del documento encontrado.

Uso

`javascript
const documentoEncontrado = await items.find('identificador', options);
console.log(documentoEncontrado);
``