Saltar al contenido principal
Ir al Studio
Módulos

List

List

El módulo List es responsable de almacenar, obtener y eliminar valores dentro de una lista. Sus métodos pueden accederse como se muestra en el ejemplo a continuación:

js
const lista = List.create["v1_0_0"]()

Métodos​

create​

Método responsable de crear una nueva lista.

js
const lista = List.create["v1_0_0"]()

Parámetros obligatorios​

  • No hay parámetros obligatorios.

Parámetros opcionales​

  • No hay parámetros opcionales.

Retorno​

La constante o variable creada, como la lista del ejemplo mostrado anteriormente, devolverá un valor del tipo List. El valor del tipo List tiene los siguientes métodos y propiedades:

  • lista.addItem(): Método responsable de agregar un nuevo elemento a la lista.
  • lista.getItem(): Método responsable de obtener un elemento de la lista.
  • lista.removeItem(): Método responsable de eliminar un elemento de la lista.
  • lista.clear(): Método responsable de eliminar todos los elementos de la lista.
  • lista.size: Propiedad responsable de obtener el tamaño de la lista.
  • lista.values: Propiedad responsable de obtener los valores de la lista.

addItem​

Método responsable de agregar un elemento a una determinada lista.

js
const addList = await List.addList["v1_0_0"]({
    list: lista,
    value: 457
})

Parámetros obligatorios​

  • list: List - espera una instancia del tipo List obtenida a través del método create.
  • value: Any - valor que será almacenado, pudiendo ser cualquier valor.

Parámetros opcionales​

  • key: String - espera una clave para apuntar al valor; si el campo no se completa, se generará una clave aleatoria para el valor.

Retorno​

La constante o variable creada, como la addList del ejemplo mostrado anteriormente, recibirá un valor del tipo Objeto que dará acceso a las siguientes propiedades:

  • addList.key: String - devuelve la clave del valor almacenado.
  • addList.value: Any - devuelve el valor almacenado.

removeItem​

Método responsable de eliminar un elemento de una determinada lista.

js
List.removeItem["v1_0_0"]({
    list: lista,
    key: addList.key
})

Parámetros obligatorios​

  • list: List - espera una instancia del tipo List obtenida a través del método create.
  • key: String - espera la clave del elemento que será eliminado de la lista.

Retorno​

Esta acción no tiene retorno.

clear​

Método responsable de eliminar todos los elementos de una determinada lista.

js
List.clear["v1_0_0"]({
    list: lista
})

Parámetros obligatorios​

  • list: List - espera una instancia del tipo List obtenida a través del método create.

Retorno​

Esta acción no tiene retorno.

getValue​

Método responsable de obtener un valor de la lista de acuerdo con la clave indicada.

js
const getValue = actions.List.getValue["v1_0_0"]({
    list: lista,
    key: addList.key
})

Parámetros obligatorios​

  • list: List - espera una instancia del tipo List obtenida a través del método create.
  • key: String - espera la clave del elemento que se desea obtener de la lista.

Retorno​

La constante o variable creada, como la getValue del ejemplo mostrado anteriormente, recibirá un valor del tipo objeto que dará acceso a las siguientes propiedades:

  • getValue.key: String - devuelve la clave del valor obtenido por el método.
  • getValue.value: Any - devuelve el valor obtenido por el método.

getAllValues​

Método responsable de obtener todos los valores almacenados en una lista.

js
const allValues = await List.getAllValues["v1_0_0"]({
    list: lista
})

Parámetros obligatorios​

  • list: List - espera una instancia del tipo List obtenida a través del método create.

Retorno​

La constante o variable creada, como la allValues del ejemplo mostrado anteriormente, recibirá un valor del tipo objeto con la siguiente propiedad:

  • allValues.values: Any - devuelve todos los valores almacenados en la lista, o null si la lista está vacía.