Skip to main content

Functions

O módulo Functions é responsável por realizar ações de funções específicas, como por exemplo, gerar uma string aleatória. Seus métodos podem ser acessados conforme o exemplo abaixo:

await Functions.checkIsNumber["v1_0_0"]({
  value: '1'
})
Informação adicional

O módulo mouse utiliza o conceito de coordenadas para realizar as ações. Veja aqui como utilizar as coordenadas.

Métodos​

checkIsNumber​

Método responsável por verificar se um valor é do tipo numérico.

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

Parâmetros obrigatórios​

  • value: Any - espera um valor do tipo any que será verificado.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

A constante ou variável criada para receber o retorno do método, como a constante checkedValuemostrada no exemplo anterior, receberá um valor do tipo boolean. Se o valor passado for do tipo numérico, o retorno será true, caso contrário, o retorno será false.

contains​

Método responsável por verificar a ocorrência de um ou mais textos em uma determinada string.

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

Parâmetros obrigatórios​

  • text: String - espera um valor do tipo string que será verificado.
  • values: Array - espera um array de strings com as palavras ou caracteres que serão procurados no texto.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

A constante ou variável criada para receber o retorno do método, como a constante containsmostrada no exemplo anterior, receberá um valor do tipo number que representará o número de ocorrências encontradas.

convertToNumber​

Método responsável por converter um valor do tipo string para um valor do tipo number.

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

Parâmetros obrigatórios​

  • value: Any - espera um valor do tipo any que será convertido para number.

Parâmetros opcionais​

  • fractions: Number - espera um valor do tipo number que representará a quantidade de casas decimais que existe no valor.
  • `fractionSeparator: String - espera um valor do tipo string que representará o caracter que será utilizado para separar as cadas decimais da parte inteira.

Retorno​

A constante ou variável criada para receber o retorno do método, como a constante numbermostrada no exemplo anterior, receberá o valor em convertido para number.

inRange​

Método responsável por verificar se um valor está dentro de um intervalo numérico.

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

Parâmetros obrigatórios​

  • number: Number - espera um valor do tipo number que será verificado.
  • min: Number - espera um valor do tipo number que representará o valor mínimo do intervalo.
  • max: Number - espera um valor do tipo number que representará o valor máximo do intervalo.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

A constante ou variável criada para receber o retorno do método, como a constante inRange mostrada no exemplo anterior, receberá um valor do tipo boolean. Se o valor passado estiver dentro do intervalo, o retorno será true, caso contrário, o retorno será false.

join​

Método responsável por juntar uma ou mais strings.

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

Parâmetros obrigatórios​

  • list: Any[] - espera um array de qualquer coisa que serão juntadas.
  • separator: String - espera um valor do tipo string que representará o caracter que será utilizado para separar as strings.

Parâmetros opcionais​

  • startIndex: Number - espera um valor do tipo number que representará a partir de qual posição do array será iniciado a junção.
  • endIndex: Number - espera um valor do tipo number que representará até qual posição do array será finalizada a junção.

Retorno​

A constante ou variável criada para receber o retorno do método, como a constante joined mostrada no exemplo anterior, receberá uma string com todas as strings unidas.

randomString​

Método responsável por gerar uma string aleatória.

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

Parâmetros obrigatórios​

Este método não possui parâmetros obrigatórios.

Parâmetros opcionais​

  • length: Number - espera um valor do tipo number que representará o tamanho da string que será gerada. Caso não seja informado, o valor padrão será 21.

Retorno​

A constante ou variável criada para receber o retorno do método, como a constante randomString mostrada no exemplo anterior, receberá uma string aleatória com o tamanho informado.

replaceAll​

Método responsável por substituir todas as ocorrências de um ou mais textos em uma determinada string.

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

Parâmetros obrigatórios​

  • from: String|String[] - espera um valor do tipo string ou array de strings que representa a(s) palavra(s) ou caracter(es) presentes no texto que serão substituídos.
  • to: String - espera um valor do tipo string que será o valor que será substituído.
  • text: String - espera um valor do tipo string no qual serão substituídos os valores informados no parâmetro from.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

A constante ou variável criada para receber o retorno do método, como a constante replaced mostrada no exemplo anterior, receberá uma string com os valores substituídos.

split​

Método responsável por separar uma string em um array de strings.

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

Parâmetros obrigatórios​

  • text: String - espera um valor do tipo string que será separado.
  • separator: String - espera um valor do tipo string que representará o caracter que será utilizado para separar as strings.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

A constante ou variável criada para receber o retorno do método, como a constante splitted mostrada no exemplo anterior, receberá um array de strings.

xmlToJson​

Método responsável por converter um XML em um objeto JSON.

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

Parâmetros obrigatórios​

  • xml: String - espera um valor do tipo string que representará o XML que será convertido.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

A constante ou variável criada para receber o retorno do método, como a constante json mostrada no exemplo anterior, receberá um objeto JSON convertido do XML.