Saltar al contenido principal
Ir al Studio
Módulos

Functions

Functions

El módulo Functions es responsable de realizar acciones de funciones específicas, como por ejemplo, generar un string aleatorio. Sus métodos pueden accederse conforme al ejemplo a continuación:

js
await Functions.checkIsNumber["v1_0_0"]({
  value: '1'
})

Métodos​

checkIsNumber​

Método responsable de verificar si un valor es de tipo numérico.

js
const checkedValue = await Functions.checkIsNumber["v1_0_0"]({
  value: '1'
})

Parámetros obligatorios​

  • value: Any - espera un valor del tipo any que será verificado.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

La constante o variable creada para recibir el retorno del método, como la constante checkedValue mostrada en el ejemplo anterior, recibirá un valor del tipo boolean. Si el valor indicado es de tipo numérico, el retorno será true; en caso contrario, el retorno será false.

contains​

Método responsable de verificar la ocurrencia de uno o más textos en un determinado string.

js
const contains = await Functions.contains["v1_0_0"]({
  text: 'texto de exemplo',
  values: ['palavra1', 'palavra2']
})

Parámetros obligatorios​

  • text: String - espera un valor del tipo string que será verificado.
  • values: Array - espera un array de strings con las palabras o caracteres que serán buscados en el texto.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

La constante o variable creada para recibir el retorno del método, como la constante contains mostrada en el ejemplo anterior, recibirá un valor del tipo number que representará el número de ocurrencias encontradas.

convertToNumber​

Método responsable de convertir un valor del tipo string en un valor del tipo number.

js
const number = await Functions.convertToNumber["v1_0_0"]({
  value: '1',
})

Parámetros obligatorios​

  • value: Any - espera un valor del tipo any que será convertido a number.

Parámetros opcionales​

  • fractions: Number - espera un valor del tipo number que representará la cantidad de decimales que existen en el valor.
  • fractionSeparator: String - espera un valor del tipo string que representará el carácter que será utilizado para separar los decimales de la parte entera.

Retorno​

La constante o variable creada para recibir el retorno del método, como la constante number mostrada en el ejemplo anterior, recibirá el valor convertido a number.

date​

Método responsable de formatear y manipular fechas.

js
const formattedDate = await Functions.date["v1_0_0"]({
  date: '2024-01-15',
  inputFormat: 'YYYY-MM-DD',
  outputFormat: 'DD/MM/YYYY',
  timeline: [
    { operation: 'ADD', value: 1, unity: 'months' }
  ]
})

Parámetros obligatorios​

Este método no tiene parámetros obligatorios.

Parámetros opcionales​

  • date: String - fecha que será manipulada. Si no se indica, utiliza la fecha actual.
  • inputFormat: String - formato de la fecha de entrada (ej.: YYYY-MM-DD, DD/MM/YYYY). Si no se indica, intenta detectarlo automáticamente.
  • locale: String - idioma para el formato de la fecha (ej.: pt-BR, en-US).
  • timeline: Object[] - lista de operaciones de manipulación que serán aplicadas en secuencia. Cada objeto tiene:
    • operation: String - operación que será realizada. Valores: ADD | SUBTRACT | START_OF | END_OF.
    • value: Number - cantidad que será sumada o restada (utilizado en ADD y SUBTRACT).
    • unity: String - unidad de tiempo. Valores: years | months | days | hours | minutes | seconds.
  • outputFormat: String - formato de la fecha de salida (ej.: DD/MM/YYYY, YYYY-MM-DD HH:mm:ss).

Retorno​

La constante o variable creada para recibir el retorno del método, como la constante formattedDate mostrada en el ejemplo anterior, recibirá un string con la fecha formateada conforme al outputFormat indicado.

inRange​

Método responsable de verificar si un valor está dentro de un intervalo numérico.

js
const inRange = await Functions.inRange["v1_0_0"]({
  number: 1,
  min: 0,
  max: 10
})

Parámetros obligatorios​

  • number: Number - espera un valor del tipo number que será verificado.
  • min: Number - espera un valor del tipo number que representará el valor mínimo del intervalo.
  • max: Number - espera un valor del tipo number que representará el valor máximo del intervalo.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

La constante o variable creada para recibir el retorno del método, como la constante inRange mostrada en el ejemplo anterior, recibirá un valor del tipo boolean. Si el valor indicado está dentro del intervalo, el retorno será true; en caso contrario, el retorno será false.

join​

Método responsable de unir uno o más strings.

js
const joined = await Functions.join["v1_0_0"]({
  list: ['palavra1', 'palavra2'],
  separator: '-'
})

Parámetros obligatorios​

  • list: Any[] - espera un array de cualquier cosa que será unida.
  • separator: String - espera un valor del tipo string que representará el carácter que será utilizado para separar los strings.

Parámetros opcionales​

  • startIndex: Number - espera un valor del tipo number que representará a partir de qué posición del array comenzará la unión.
  • endIndex: Number - espera un valor del tipo number que representará hasta qué posición del array finalizará la unión.

Retorno​

La constante o variable creada para recibir el retorno del método, como la constante joined mostrada en el ejemplo anterior, recibirá un string con todos los strings unidos.

mathExpression​

Método responsable de evaluar una expresión matemática, con soporte para la sustitución de variables.

js
const result = await Functions.mathExpression["v1_0_0"]({
  expression: ["x", "+", "y", "*", "2"],
  values: { x: 10, y: 5 }
})
// result.expression === "10 + 5 * 2"
// result.result === 20

Parámetros obligatorios​

  • expression: String[] - espera un array de strings que, al unirse por espacio, formarán la expresión matemática que será evaluada.

Parámetros opcionales​

  • values: Object - espera un objeto cuyas claves serán sustituidas por sus respectivos valores en la expresión antes de evaluarla.

Retorno​

La constante o variable creada para recibir el retorno del método, como la constante result mostrada en el ejemplo anterior, recibirá un objeto con las siguientes propiedades:

  • result.expression: String - la expresión matemática final después de la sustitución de variables.
  • result.result: Any - el resultado numérico de la evaluación de la expresión.

randomString​

Método responsable de generar un string aleatorio.

js
const randomString = await Functions.randomString["v1_0_0"]({
  length: 10
})

Parámetros obligatorios​

Este método no tiene parámetros obligatorios.

Parámetros opcionales​

  • length: Number - espera un valor del tipo number que representará el tamaño del string que será generado. Si no se indica, el valor predeterminado será 21.

Retorno​

La constante o variable creada para recibir el retorno del método, como la constante randomString mostrada en el ejemplo anterior, recibirá un string aleatorio con el tamaño indicado.

replaceAll​

Método responsable de sustituir todas las ocurrencias de uno o más textos en un determinado string.

js
const replaced = await Functions.replaceAll["v1_0_0"]({
  from: 'Hello',
  to: 'Hello World',
  text: 'Hello World'
})

Parámetros obligatorios​

  • from: String|String[] - espera un valor del tipo string o un array de strings que representa la(s) palabra(s) o carácter(es) presentes en el texto que serán sustituidos.
  • to: String - espera un valor del tipo string que será el valor sustituto.
  • text: String - espera un valor del tipo string en el cual serán sustituidos los valores indicados en el parámetro from.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

La constante o variable creada para recibir el retorno del método, como la constante replaced mostrada en el ejemplo anterior, recibirá un string con los valores sustituidos.

split​

Método responsable de separar un string en un array de strings.

js
const splitted = await Functions.split["v1_0_0"]({
  text: 'Hello World',
  separator: ' '
})

Parámetros obligatorios​

  • text: String - espera un valor del tipo string que será separado.
  • separator: String - espera un valor del tipo string que representará el carácter que será utilizado para separar los strings.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

La constante o variable creada para recibir el retorno del método, como la constante splitted mostrada en el ejemplo anterior, recibirá un objeto con las siguientes propiedades:

  • splitted.values: String[] - array con los strings resultantes de la separación.
  • splitted.count: Number - cantidad de elementos en el array resultante.

xmlToJson​

Método responsable de convertir un XML en un objeto JSON.

js
const json = await Functions.xmlToJson["v1_0_0"]({
  xml: '<xml><name>John</name></xml>'
})

Parámetros obligatorios​

  • xml: String - espera un valor del tipo string que representará el XML que será convertido.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

La constante o variable creada para recibir el retorno del método, como la constante json mostrada en el ejemplo anterior, recibirá un objeto JSON convertido del XML.