Funções predefinidas de expressões adaptáveis

APLICA-SE A: SDK v4

Este artigo lista as funções predefinidas disponíveis ordenadas por seu uso geral. Para obter informações sobre operadores usados em funções predefinidas e sintaxe de expressão, confira Operadores.

As expressões predefinidas são divididas nos seguintes tipos de função:

• Cadeia de caracteres
• Coleção
• Comparação lógica
• Conversão
• Matemática
• Data
• Timex
• Análise de URI
• Manipulação e construção de objetos
• Expressão regular
• Verificação de tipo

Você também pode exibir a lista em ordem alfabética.

Funções de cadeia de caracteres

Função	Explicação
length	Retornar o comprimento de uma cadeia de caracteres.
substitui	Substituir uma substring pela cadeia de caracteres especificada e retornar a cadeia de caracteres atualizada. Essa função diferencia maiúsculas de minúsculas.
replaceIgnoreCase	Substituir uma subcadeia de caracteres pela cadeia de caracteres especificada e retornar a cadeia de caracteres atualizada. Essa função não diferencia maiúsculas de minúsculas.
split	Retornar uma matriz que contém substrings com base no delimitador especificado.
substring	Retornar caracteres de uma cadeia de caracteres.
toLower	Retornar uma cadeia de caracteres em minúsculas em um formato de localidade opcional.
toUpper	Retornar uma cadeia de caracteres em maiúsculas em um formato de localidade opcional.
cortar	Remover os espaços em branco à esquerda e à direita de uma cadeia de caracteres.
addOrdinal	Retornar o número ordinal do número de entrada.
endsWith	Verificar se uma cadeia de caracteres termina com uma subcadeia de caracteres específica. Retornar true se a substring for encontrada ou retornar false se não for encontrada. Essa função não diferencia maiúsculas de minúsculas.
startsWith	Verificar se uma cadeia de caracteres começa com uma subcadeia de caracteres específica. Retornar true se a substring for encontrada ou retornar false se não for encontrada. Essa função não diferencia maiúsculas de minúsculas.
countWord	Retornar o número de palavras na cadeia de caracteres fornecida.
concat	Combinar duas ou mais cadeias de caracteres e retornar a cadeia de caracteres resultante.
newGuid	Retornar uma nova cadeia de caracteres Guid.
indexOf	Retornar a posição inicial ou o valor de índice de uma substring ou procurar o objeto especificado e retornar o índice de base zero da primeira ocorrência na lista inteira. Essa função não diferencia maiúsculas de minúsculas, e os índices começam com o número 0.
lastIndexOf	Retornar a posição inicial ou o valor de índice da última ocorrência de uma substring ou pesquisar o objeto especificado e retornar o índice de base zero da última ocorrência dentro do intervalo de elementos na lista. Essa função não diferencia maiúsculas de minúsculas, e os índices começam com o número 0.
sentenceCase	Coloca em maiúscula a primeira letra da primeira palavra em uma cadeia de caracteres em um formato local opcional.
titleCase	Coloca em maiúscula a primeira letra de cada palavra em uma cadeia de caracteres em um formato de localidade opcional.
reverse	Inverte a ordem dos elementos em uma cadeia de caracteres ou matriz.

Funções Coleção

Função	Explicação
contains	Funciona para localizar um item em uma cadeia de caracteres, localizar um item em uma matriz ou localizar um parâmetro em um objeto complexo. Exemplos: contains('hello world', 'hello') contains(createArray('1','2'), '1') contains(json("{'foo':'bar'}"), 'foo')
first	Retornar o primeiro item da coleção.
join	Retornar uma cadeia de caracteres que tem todos os itens de uma matriz e tem cada caractere separado por um delimitador. Exemplo: join(createArray('a','b'), '.') = "a.b"
last	Retornar o último item da coleção.
count	Retornar o número de itens na coleção.
foreach	Operar em cada elemento e retornar a nova coleção.
union	Retornar uma coleção que tem todos os itens das coleções especificadas.
skip	Remover itens do início de uma coleção e retornar os itens restantes.
take	Retornar itens do início de uma coleção.
intersection	Retornar uma coleção que tem somente os itens comuns entre as coleções especificadas.
subArray	Retornar uma submatriz das posições inicial e final especificadas. Os valores de índice começam com o número 0.
select	Operar em cada elemento e retornar a nova coleção de elementos transformados.
where	Filtrar em cada elemento e retornar a nova coleção de elementos filtrados que correspondem à condição específica.
sortBy	Classificar elementos na coleção em ordem crescente e retornar a coleção classificada.
sortByDescending	Classificar elementos na coleção em ordem decrescente e retornar a coleção classificada.
indicesAndValues	Transformar uma matriz ou objeto em uma matriz de objetos com a propriedade index e value.
flatten	Nivelar matrizes em uma matriz com valores que não são da matriz.
unique	Remover todas as duplicatas de uma matriz.
qualquer	Determina se algum elemento de uma sequência satisfaz uma condição.
all	Determina se todos os elementos de uma sequência satisfazem uma condição.
reverse	Inverte a ordem dos elementos em uma cadeia de caracteres ou matriz.
merge	Mescla vários objetos JSON ou itens em uma cadeia de caracteres.

Funções de comparação lógica

Função	Explicação
and	And lógico. Retornar true se todas as expressões especificadas forem avaliadas como true.
equals	Comparação igual. Retornar true se os valores especificados forem iguais.
empty	Verifique se o destino está vazio.
greater	Comparação maior que. Retornar true se o primeiro valor for maior ou retornar false se for menor.
greaterOrEquals	Comparação maior que ou igual a. Retornar true se o primeiro valor for maior ou igual ou retornar false se o primeiro valor for menor.
if	Verificar se uma expressão é verdadeira ou falsa. Com base no resultado, retornar um valor especificado.
less	Operação comparativa "menor que". Retornar true se o primeiro valor for menor ou retornar false se o primeiro valor for maior.
lessOrEquals	Operação comparativa "menor que ou igual a". Retornar true se o primeiro valor for menor ou igual ou retornar false se o primeiro valor for maior.
not	Operador NOT lógico. Retornar true se a expressão for false ou retornar false se for true.
or	Lógico ou operação. Retornar true se pelo menos uma expressão for true ou retornar false quando todas forem false.
exists	Avaliar a veracidade da expressão.

Funções de conversão

Função	Explicação
float	Retornar a representação de ponto flutuante da cadeia de caracteres especificada.
int	Retornar a representação inteira da cadeia de caracteres especificada.
cadeia de caracteres	Retornar a versão da cadeia de caracteres do valor especificado em um formato de localidade opcional.
bool	Retornar uma representação booliana da cadeia de caracteres especificada.
createArray	Criar uma matriz de várias entradas.
json	Retornar o objeto ou valor de tipo JSON (JavaScript Object Notation) de uma cadeia de caracteres ou XML.
base64	Retornar a versão codificada em base64 de uma cadeia de caracteres ou matriz de bytes.
base64ToBinary	Retornar a versão binária de uma cadeia de caracteres codificada em Base64.
base64ToString	Retornar a versão de cadeia de caracteres de uma cadeia de caracteres codificada em base64.
binary	Retornar a versão binária de um valor de entrada.
dataUri	Retornar o URI de um valor de entrada.
dataUriToBinary	Retornar a versão binária de um URI de dados.
dataUriToString	Retornar a versão da cadeia de caracteres de um URI de dados.
uriComponent	Retornar a versão codificada para URI correspondente a um valor de entrada substituindo caracteres não seguros para URL por caracteres de escape.
uriComponentToString	Retornar a versão de cadeia de caracteres de uma cadeia de caracteres codificada em URI.
xml	Retornar a versão XML de uma cadeia de caracteres.
formatNumber	Formatar um valor para o número mais próximo do número especificado de dígitos fracionários e uma localidade especificada opcional.
jsonStringify	Retornar a string JSON de um valor.
stringOrValueEmpacotar interpolação de cadeia de caracteres para obter o valor real. Por exemplo, stringOrValue('${1}') retorna o número 1, enquanto stringOrValue('${1} item') retorna a cadeia de caracteres "item 1".

Funções matemáticas

Função	Explicação
abs	Retorna o valor absoluto do número especificado.
add	And matemático. Retornar o resultado de adicionar dois números (caso de número puro) ou da concatenação duas ou mais cadeias de caracteres.
div	Divisão matemática. Retornar o resultado inteiro da divisão de dois números.
max	Retornar o maior valor de uma coleção.
min	Retornar o menor valor de uma coleção.
mod	Retornar o resto da divisão de dois números.
mul	Multiplicação matemática. Retornar o produto da multiplicação de dois números.
rand	Retornar um número aleatório entre o valor mínimo e máximo especificado.
sqrt	Retornar a raiz quadrada de um número especificado.
sub	Subtração matemática. Retornar o resultado da subtração do segundo número do primeiro.
sum	Retornar a soma dos números em uma matriz.
range	Retornar uma matriz de inteiros que começa em um inteiro especificado.
exp	Retornar a exponenciação de um número para outro.
average	Retornar o número médio de uma matriz numérica.
floor	Retornar o maior número inteiro que seja menor ou igual ao número especificado.
ceiling	Retornar o menor número inteiro que seja maior ou igual ao número especificado.
round	Arredondar um valor para o inteiro mais próximo ou para o número especificado de casas decimais.

Funções de data e hora

Função	Explicação
addDays	Adicionar um número especificado de dias a um carimbo de data/hora fornecido em um formato de localidade opcional.
addHours	Adicionar um número especificado de horas a um carimbo de data/hora fornecido em um formato de localidade opcional.
addMinutes	Adicionar um número especificado de minutos a um carimbo de data/hora fornecido em um formato de localidade opcional.
addSeconds	Adicionar um número especificado de segundos a um carimbo de data/hora fornecido.
dayOfMonth	Retornar o dia de um mês de um carimbo de data/hora ou expressão Timex fornecido.
dayOfWeek	Retornar o dia da semana de um carimbo de data/hora fornecido.
dayOfYear	Retornar o dia do ano de um carimbo de data/hora fornecido.
formatDateTime	Retornar um carimbo de data/hora em um formato de localidade opcional.
formatEpoch	Retornar um carimbo de data/hora em um formato de localidade opcional da Época do UNIX (horário do UNIX, horário do POSIX).
formatTicks	Retornar um carimbo de data/hora em um formato de localidade opcional a partir de tiques.
subtractFromTime	Subtrair um número de unidades de tempo de um carimbo de data/hora em um formato de localidade opcional.
utcNow	Retornar o carimbo de data/hora atual em um formato de localidade opcional como uma cadeia de caracteres.
dateReadBack	Usar a biblioteca de data e hora para fornecer um readback de data.
month	Retornar o mês de um carimbo de data/hora fornecido.
date	Retornar a data de um carimbo de data/hora fornecido.
year	Retornar o ano de um carimbo de data/hora fornecido.
getTimeOfDay	Retornar a hora do dia de um carimbo de data/hora fornecido.
getFutureTime	Retornar o carimbo de data/hora atual em um formato de localidade opcional mais as unidades de tempo especificadas.
getPastTime	Retornar o carimbo de data/hora atual em um formato de localidade opcional menos as unidades de tempo especificadas.
addToTime	Adicionar um número de unidades de tempo a um carimbo de data/hora em um formato de localidade opcional.
convertFromUTC	Converter um carimbo de data/hora em um formato de localidade opcional do Tempo Universal Coordenado (UTC).
convertToUTC	Converter um carimbo de data/hora em um formato de localidade opcional para o Tempo Universal Coordenado (UTC).
startOfDay	Retornar o início do dia para um carimbo de data/hora em um formato de localidade opcional.
startOfHour	Retornar o início da hora para um carimbo de data/hora em um formato de localidade opcional.
startOfMonth	Retornar o início do mês de um carimbo de data/hora em um formato de localidade opcional.
ticks	Retornar o valor de propriedade ticks de um carimbo de data/hora especificado.
ticksToDays	Converter um valor da propriedade ticks para o número de dias.
ticksToHours	Converter um valor da propriedade ticks para o número de horas.
ticksToMinutes	Converter um valor da propriedade ticks para o número de minutos.
dateTimeDiff	Retornar a diferença em ticks entre dois carimbos de data/hora.
getPreviousViableDate	Retornar a data viável anterior de uma expressão Timex com base na data atual e em um fuso horário especificado opcionalmente.
getNextViableDate	Retornar a próxima data viável de uma expressão Timex com base na data atual e em um fuso horário especificado opcionalmente.
getPreviousViableTime	Retornar a hora viável anterior de uma expressão Timex com base na hora atual e em um fuso horário especificado opcionalmente.
getNextViableTime	Retornar a próxima hora viável de uma expressão Timex com base na data atual e em um fuso horário especificado opcionalmente.

Funções timex

Função	Explicação
isPresent	Retornar true se a expressão TimexProperty ou Timex se referir ao presente.
isDuration	Retornar true se a expressão TimexProperty ou Timex se referir à duração.
isTime	Retornar true se a expressão TimexProperty ou Timex se referir ao tempo.
isDate	Retornar true se a expressão TimexProperty ou Timex se referir à data.
isTimeRange	Retornar true se a expressão TimexProperty ou Timex se referir ao intervalo de tempo.
isDateRange	Retornar true se a expressão TimexProperty ou Timex se referir ao intervalo de datas.
isDefinite	Retornar true se a expressão TimexProperty ou Timex se referir ao dia definido.
resolver	Retornar a cadeia de caracteres se a expressão TimexProperty ou Timex fornecida se referir a um horário válido. O horário válido contém horas, minutos e segundos.

Funções de análise de URI

Função	Explicação
uriHost	Retornar o valor de host de um URI (Uniform Resource Identifier).
uriPath	Retornar o valor de caminho de um URI (Uniform Resource Identifier).
uriPathAndQuery	Retornar os valores de caminho e consulta de um URI (Uniform Resource Identifier).
uriPort	Retornar o valor de porta de um URI (Uniform Resource Identifier).
uriQuery	Retornar o valor de consulta de um URI (Uniform Resource Identifier).
uriScheme	Retornar o valor de esquema de um URI (Uniform Resource Identifier).

Funções de manipulação e construção de objetos

Função	Explicação
addProperty	Adicionar uma propriedade e seu valor, ou par nome-valor, a um objeto JSON e retornar o objeto atualizado.
removeProperty	Remover uma propriedade de um objeto JSON e retornar o objeto atualizado.
setProperty	Definir o valor da propriedade de um objeto JSON e retornar o objeto atualizado.
getProperty	Retornar o valor de uma propriedade especificada ou propriedade raiz de um objeto JSON.
coalesce	Retornar o primeiro valor não nulo de um ou mais parâmetros.
xPath	Verificar o XML em busca de nós ou valores correspondentes a uma expressão XPath (Linguagem XPath) e retornar esses nós ou valores.
jPath	Marcar JSON ou uma cadeia de caracteres JSON para nós ou valores que correspondam a uma expressão de caminho e retornar os nós correspondentes.
setPathToValue	Definir o valor de um caminho específico e retornar o valor.

Funções de expressão regular

Função	Explicação
isMatch	Retornar true se uma cadeia de caracteres corresponder a um padrão regex comum.

Funções de verificação de tipo

Função	Explicação
EOL	Retornar o texto da sequência de fim da linha (EOL).
isInteger	Retornar true se a entrada fornecida for um número inteiro
isFloat	Retornar true se a entrada fornecida for um número de ponto flutuante
isBoolean	Retornar true se a entrada fornecida for um booliano.
isArray	Retornar true se a entrada fornecida for uma matriz.
isObject	Retornar true se a entrada fornecida for um objeto.
isDateTime	Retornar true se a entrada fornecida for um carimbo de data/hora de formato UTC ISO.
isString	Retornar true se a entrada fornecida for uma cadeia de caracteres.

Funções pré-criadas classificadas em ordem alfabética

abs

Retorna o valor absoluto de um número especificado.

abs(<number>)

Parâmetro	Obrigatório	Type	Descrição
<number>	Sim	número	Número para obter o valor absoluto de

Valor retornado	Type	Description
<result>	número	O resultado do cálculo do valor absoluto.

Exemplos

Estes exemplos calculam o valor absoluto:

abs(3.12134)
abs(-3.12134)

E ambos retornam o resultado 3.12134.

add

Retornar o resultado de adicionar dois ou mais números (caso de número puro) ou concatenar duas ou mais cadeias de caracteres (outro caso).

add(<item1>, <item2>, ...)

Parâmetro	Obrigatório	Type	Descrição
<item1>, <item2>,...	Sim	qualquer	itens

Valor retornado	Type	Descrição
<result-sum>	número ou cadeia de caracteres	O resultado de adicionar os números especificados ou do resultado de concatenar.

Exemplo

Esse exemplo adiciona os números especificados:

add(1, 1.5)

E retorna o resultado 2,5.

Este exemplo concatena os itens especificados:

add('hello',null)
add('hello','world')

E retorna os resultados

• olá
• helloworld

addDays

Adicionar um número de dias a um carimbo de data/hora em um formato de localidade opcional.

addDays('<timestamp>', <days>, '<format>'?, '<locale>'?)

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	string	A cadeia de caracteres que contém o carimbo de data/hora que deve estar no formato UTC ISO padrão AAAA-MM-DDTHH:mm:ss.fffZ
<days>	Sim	Número inteiro	O número positivo ou negativo de dias a ser adicionado
<format>	Não	string	Um padrão de formato personalizado. O formato padrão do carimbo de data/hora é o UTC ISO, AAAA-MM-DDTHH:mm:ss.fffZ, compatível com a ISO 8601.
<locale>	Não	string	Um local de informações de cultura opcional

Valor retornado	Type	Descrição
<updated-timestamp>	string	O carimbo de data/hora mais o número de dias especificado

Exemplo 1

Esse exemplo adiciona 10 dias ao carimbo de data/hora especificado:

addDays('2018-03-15T13:00:00.000Z', 10)

E retorna o resultado 2018-03-25T00:00:00.000Z.

Exemplo 2

Esse exemplo subtrai cinco dias do carimbo de data/hora especificado:

addDays('2018-03-15T00:00:00.000Z', -5)

E retorna o resultado 2018-03-10T00:00:00.000Z.

Exemplo 3

Este exemplo adiciona 1 dia ao carimbo de data/hora especificado na localidade de-DE:

addDays('2018-03-15T13:00:00.000Z', 1, '', 'de-dE')

E retorna o resultado 16.03.18 13:00:00.

addHours

Adicionar um número de horas a um carimbo de data/hora em um formato de localidade opcional.

addHours('<timestamp>', <hours>, '<format>'?, '<locale>'?)

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	string	Uma cadeia de caracteres que contém o carimbo de data/hora
<hours>	Sim	Número inteiro	O número positivo ou negativo de horas a ser adicionado
<format>	Não	string	Um padrão de formato personalizado. O formato padrão do carimbo de data/hora é o UTC ISO, AAAA-MM-DDTHH:mm:ss.fffZ, compatível com a ISO 8601.
<locale>	Não	string	Um local de informações de cultura opcional

Valor retornado	Type	Descrição
<updated-timestamp>	string	O carimbo de data/hora mais o número de horas especificado

Exemplo 1

Esse exemplo adiciona 10 horas ao carimbo de data/hora especificado:

addHours('2018-03-15T00:00:00.000Z', 10)

E retorna o resultado 2018-03-15T10:00:00.000Z.

Exemplo 2

Esse exemplo subtrai cinco horas do carimbo de data/hora especificado:

addHours('2018-03-15T15:00:00.000Z', -5)

E retorna o resultado 2018-03-15T10:00:00.000Z.

Exemplo 3

Esse exemplo adiciona 2 horas ao carimbo de data/hora especificado na localidade de-DE:

addHours('2018-03-15T13:00:00.000Z', 2, '', 'de-DE')

E retorna o resultado 15.03.18 15:00:00.

addMinutes

Adicionar um número de minutos a um carimbo de data/hora em um formato de localidade opcional.

addMinutes('<timestamp>', <minutes>, '<format>'?, '<locale>'?)

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	string	Uma cadeia de caracteres que contém o carimbo de data/hora
<minutes>	Sim	Número inteiro	O número positivo ou negativo de minutos a ser adicionado
<format>	Não	string	Um padrão de formato personalizado. O formato padrão do carimbo de data/hora é o UTC ISO, AAAA-MM-DDTHH:mm:ss.fffZ, compatível com a ISO 8601.
<locale>	Não	string	Um local de informações de cultura opcional

Valor retornado	Type	Descrição
<updated-timestamp>	string	O carimbo de data/hora mais o número de minutos especificado

Exemplo 1

Esse exemplo adiciona 10 minutos ao carimbo de data/hora especificado:

addMinutes('2018-03-15T00:10:00.000Z', 10)

E retorna o resultado 2018-03-15T00:20:00.000Z.

Exemplo 2

Esse exemplo subtrai cinco minutos do carimbo de data/hora especificado:

addMinutes('2018-03-15T00:20:00.000Z', -5)

E retorna o resultado 2018-03-15T00:15:00.000Z.

Exemplo 3

Esse exemplo adiciona 30 minutos ao carimbo de data/hora especificado na localidade de-DE:

addMinutes('2018-03-15T00:00:00.000Z', 30, '', 'de-DE')

E retorna o resultado 15.03.18 13:30:00.

addOrdinal

Retornar o número ordinal do número de entrada.

addOrdinal(<number>)

Parâmetro	Obrigatório	Type	Descrição
<number>	Sim	Número inteiro	Os números a serem convertidos em um número ordinal

Valor retornado	Type	Description
<result>	string	O número ordinal convertido do número de entrada

Exemplo

addOrdinal(11)
addOrdinal(12)
addOrdinal(13)
addOrdinal(21)
addOrdinal(22)
addOrdinal(23)

E, respectivamente, retorna estes resultados:

• 11º
• 12º
• 13º
• 21º
• 22º
• 23º

addProperty

Adicionar uma propriedade e seu valor, ou par nome-valor, a um objeto JSON e retornar o objeto atualizado. Se o objeto já existir em runtime, a função gerará um erro.

addProperty('<object>', '<property>', value)

Parâmetro	Obrigatório	Type	Descrição
<object>	Sim	objeto	O objeto JSON em que você deseja adicionar uma propriedade
<property>	Sim	string	O nome da propriedade a ser adicionada
<value>	Sim	qualquer	O valor da propriedade

Valor retornado	Type	Descrição
<updated-object>	objeto	O objeto JSON atualizado após a adição de uma nova propriedade

Exemplo

Este exemplo adiciona a propriedade accountNumber ao objeto customerProfile convertido em JSON com a função json(). A função atribui um valor gerado pela função newGuid() e retorna o objeto atualizado:

addProperty(json('customerProfile'), 'accountNumber', newGuid())

addSeconds

Adicionar um número de segundos a um carimbo de data/hora.

addSeconds('<timestamp>', <seconds>, '<format>'?)

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	string	Uma cadeia de caracteres que contém o carimbo de data/hora
<seconds>	Sim	Número inteiro	O número positivo ou negativo de segundos a ser adicionado
<format>	Não	string	Um padrão de formato personalizado. O formato padrão do carimbo de data/hora é o UTC ISO, AAAA-MM-DDTHH:mm:ss.fffZ, compatível com a ISO 8601.

Valor retornado	Type	Descrição
<updated-timestamp>	string	O carimbo de data/hora mais o número de segundos especificado

Exemplo 1

Esse exemplo adiciona 10 segundos ao carimbo de data/hora especificado:

addSeconds('2018-03-15T00:00:00.000Z', 10)

E retorna o resultado 2018-03-15T00:00:10.000Z.

Exemplo 2

Esse exemplo subtrai cinco segundos ao carimbo de data/hora especificado:

addSeconds('2018-03-15T00:00:30.000Z', -5)

E retorna o resultado 2018-03-15T00:00:25.000Z.

addToTime

Adicionar um número de unidades de tempo a um carimbo de data/hora em um formato de localidade opcional. Consulte também getFutureTime().

addToTime('<timestamp>', '<interval>', <timeUnit>, '<format>'?, '<locale>'?)

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	string	Uma cadeia de caracteres que contém o carimbo de data/hora
<interval>	Sim	Número inteiro	O número de unidades de tempo especificadas a ser adicionado
<timeUnit>	Sim	string	A unidade de tempo a ser usada com interval. As unidades possíveis são "Second", "Minute", "Hour", "Day", "Week", "Month" e "Year".
<format>	Não	string	Um padrão de formato personalizado. O formato padrão do carimbo de data/hora é o UTC ISO, AAAA-MM-DDTHH:mm:ss.fffZ, compatível com a ISO 8601.
<locale>	Não	string	Um local de informações de cultura opcional

Valor retornado	Type	Descrição
<updated-timestamp>	string	O carimbo de data/hora mais o número de unidades de tempo especificadas com o formato fornecido.

Exemplo 1

Este exemplo adiciona um dia ao carimbo de data/hora especificado.

addToTime('2018-01-01T00:00:00.000Z', 1, 'Day')

E retorna o resultado 2018-01-02T00:00:00.000Z.

Exemplo 2

Este exemplo adiciona duas semanas ao carimbo de data/hora especificado.

addToTime('2018-01-01T00:00:00.000Z', 2, 'Week', 'MM-DD-YY')

E retorna o resultado no formato 'MM-DD-AA' como 01-15-18.

all

Determina se todos os elementos de uma sequência satisfazem uma condição.

all(<sequence>, <item>, <condition>)

Parâmetro	Obrigatório	Type	Descrição
<sequência>	Sim	objeto	Uma sequência a ser avaliada.
<item>	Sim	string	Refere-se aos elementos a serem avaliados na sequência.
<condition>	Sim	expressão	A expressão para avaliar a condição.

Valor retornado	Type	Descrição
true ou false	Booliano	Retorna true se todos os elementos satisfizerem uma condição. Retorna false se pelo menos um não satisfizer.

Exemplos

Estes exemplos determinam se todos os elementos de uma sequência satisfazem uma condição:

all(createArray(1, 'cool'), item, isInteger(item))
all(createArray(1, 2), item => isInteger(item))

E retornam os seguintes resultados, respectivamente:

• false, porque ambos os itens na sequência não são inteiros.
• true, porque ambos os itens na sequência são inteiros.

and

Verificar se todas as expressões são verdadeiras. Retornar true quando todas as expressões forem true ou retornar false quando pelo menos uma expressão for false.

and(<expression1>, <expression2>, ...)

Parâmetro	Obrigatório	Type	Descrição
<expression1>, <expression2>, ...	Sim	Boolean	As expressões a serem verificadas

Valor retornado	Type	Descrição
true ou false	Booliano	Retornar true se todas as expressões forem true. Retornar false se pelo menos uma expressão for false.

Exemplo 1

Esses exemplos verificam se os valores boolianos são todos true:

and(true, true)
and(false, true)
and(false, false)

E, respectivamente, retorna estes resultados:

• Ambas as expressões são true, então as funções retornam true.
• Uma expressão é false, então as funções retornam false.
• Ambas as expressões são false, então a função retorna false.

Exemplo 2

Esses exemplos verificam se as expressões especificadas são todas true:

and(equals(1, 1), equals(2, 2))
and(equals(1, 1), equals(1, 2))
and(equals(1, 2), equals(1, 3))

E, respectivamente, retorna estes resultados:

• Ambas as expressões são true, então as funções retornam true.
• Uma expressão é false, então as funções retornam false.
• Ambas as expressões são false, então as funções retornam false.

qualquer

Determina se todos os elementos em uma sequência satisfazem uma condição.

all(<sequence>, <item>, <condition>)

Parâmetro	Obrigatório	Type	Descrição
<sequência>	Sim	objeto	Uma sequência a ser avaliada.
<item>	Sim	string	Refere-se aos elementos a serem avaliados na sequência.
<condition>	Sim	expressão	A expressão para avaliar a condição.

Valor retornado	Type	Descrição
true ou false	Booliano	Retorna true se todos os elementos satisfizerem a condição. Retorna false se pelo menos um não satisfizer.

Exemplos

Estes exemplos determinam se todos os elementos de uma sequência satisfazem uma condição:

any(createArray(1, 'cool'), item, isInteger(item))
any(createArray('first', 'cool'), item => isInteger(item))

E retornam os seguintes resultados, respectivamente:

• true, porque pelo menos um item na sequência é um inteiro
• false, porque nenhum item na sequência é um inteiro.

média

Retornar a média numérica de uma matriz numérica.

average(<numericArray>)

Parâmetro	Obrigatório	Type	Descrição
<numericArray>	Sim	matriz de números	A matriz de entrada para calcular a média

Valor retornado	Type	Descrição
<average-of-array>	número	O valor médio da matriz fornecida

Exemplo

Este exemplo calcula a média da matriz em createArray():

average(createArray(1,2,3))

E retorna o resultado 2.

base64

Retornar a versão codificada em base64 de uma cadeia de caracteres ou matriz de bytes.

base64('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	Cadeia de caracteres ou matriz de bytes	A cadeia de caracteres de entrada

Valor retornado	Type	Descrição
<base64-string>	string	A versão codificada em base64 da cadeia de caracteres de entrada

Exemplo 1

Este exemplo converte a cadeia de caracteres hello em uma cadeia de caracteres codificada em base64:

base64('hello')

E retorna o resultado "aGVsbG8=".

Exemplo 2

Este exemplo usa byteArr, que é igual a new byte[] { 3, 5, 1, 12 }:

base64('byteArr')

E retorna o resultado "AwUBDA==".

base64ToBinary

Retornar a matriz binária de uma cadeia de caracteres codificada em base64.

base64ToBinary('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	string	A cadeia de caracteres codificada em Base64 a ser convertida

Valor retornado	Type	Descrição
<binary-for-base64-string>	matriz de bytes	A versão binária da cadeia de caracteres codificada em base64

Exemplo

Este exemplo converte a cadeia de caracteres codificada em base64 AwUBDA== em uma cadeia de caracteres binária:

base64ToBinary('AwUBDA==')

E retorna o resultado new byte[] { 3, 5, 1, 12 }.

base64ToString

Retornar a versão da cadeia de caracteres para uma cadeia de caracteres codificada em base64, decodificando com eficiência a cadeia de caracteres base64.

base64ToString('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	string	A cadeia de caracteres codificada em Base64 a ser decodificada

Valor retornado	Type	Descrição
<decoded-base64-string>	string	A versão de cadeia de caracteres de uma cadeia de caracteres codificada em base64

Exemplo

Este exemplo converte a cadeia de caracteres codificada em base64 aGVsbG8= em uma cadeia de caracteres decodificada:

base64ToString('aGVsbG8=')

E retorna o resultado hello.

binary

Retornar a versão binária de uma cadeia de caracteres.

binary('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	string	A cadeia de caracteres a ser convertida

Valor retornado	Type	Descrição
<binary-for-input-value>	matriz de bytes	A versão binária para a cadeia de caracteres especificada

Exemplo

Este exemplo converte a cadeia de caracteres hello em uma cadeia de caracteres binária:

binary('hello')

E retorna o resultado new byte[] { 104, 101, 108, 108, 111 }.

bool

Retornar a versão booliana de um valor.

bool(<value>)

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	qualquer	O valor a ser convertido

Valor retornado	Type	Descrição
true ou false	Booliano	A versão booliana do valor especificado

Exemplo

Esses exemplos convertem os valores especificados em valores boolianos:

bool(1)
bool(0)

E, respectivamente, retorna estes resultados:

• true
• false

ceiling

Retornar o maior número inteiro que seja menor ou igual ao número especificado.

ceiling('<number>')

Parâmetro	Obrigatório	Type	Descrição
<number>	Sim	número	Um número de entrada

Valor retornado	Type	Descrição
<integer-value>	Número inteiro	O maior número inteiro maior ou igual ao número de entrada

Exemplo

Este exemplo retorna o maior número inteiro menor ou igual ao número 10.333:

ceiling(10.333)

E retorna o número inteiro 11.

coalesce

Retornar o primeiro valor não nulo de um ou mais parâmetros. Cadeias de caracteres vazias, matrizes vazias e objetos vazios não são nulos.

coalesce(<object**1>, <object**2>, ...)

Parâmetro	Obrigatório	Type	Descrição
<object**1>, <object**2>, ...	Sim	Qualquer um (tipos mistos aceitáveis)	Um ou mais itens para verificar se são nulos

Valor retornado	Type	Descrição
<first-non-null-item>	qualquer	O primeiro item ou valor que não seja nulo. Se todos os parâmetros forem nulos, essa função retornará null.

Exemplo

Esses exemplos retornarão o primeiro valor não nulo dos valores especificados ou null quando todos os valores forem nulos:

coalesce(null, true, false)
coalesce(null, 'hello', 'world')
coalesce(null, null, null)

E respectivamente retorna:

• true
• olá
• nulo

concat

Combine dois ou mais objetos e retorne os objetos combinados em uma lista ou cadeia de caracteres.

concat('<text1>', '<text2>', ...)

Parâmetro	Obrigatório	Type	Descrição
<objeto1>, <objeto2>, ...	Sim	qualquer	Pelo menos dois objetos para concatenar.

Valor retornado	Type	Descrição
<object1object2...>	cadeia de caracteres ou lista	A cadeia de caracteres ou lista combinada. Valores nulos são ignorados.

Valores de retorno esperados:

• Se todos os itens forem listas, uma lista será retornada.
• Se existir um item que não seja uma lista, uma cadeia de caracteres será retornada.
• Se um valor for nulo, ele será ignorado e não concatenado.

Exemplo

Este exemplo combina as cadeias de caracteres Hello e World:

concat('Hello', 'World')

E retorna o resultado HelloWorld.

Exemplo 2

Este exemplo combina as listas [1,2] e [3,4]:

concat([1,2],[3,4])

E retorna o resultado [1,2,3,4].

Exemplo 3

Estes exemplos combinam objetos de diferentes tipos:

concat('a', 'b', 1, 2)
concat('a', [1,2])

E retornam os seguintes resultados, respectivamente:

• A cadeia de caracteres ab12.
• O objeto aSystem.Collections.Generic.List 1[System.Object]. Isso é ilegível e melhor evitar.

Exemplo 4

Estes exemplos combinam objetos null:

concat([1,2], null)
concat('a', 1, null)

E retornam os seguintes resultados, respectivamente:

• A lista [1,2].
• A cadeia de caracteres a1.

contains

Verificar se uma coleção tem um item específico. Retornar true se o item for encontrado ou retornar false se não for encontrado. Essa função diferencia maiúsculas de minúsculas.

contains('<collection>', '<value>')
contains([<collection>], '<value>')

Essa função funciona nos seguintes tipos de coleção:

• Uma cadeia de caracteres para localizar uma subcadeia de caracteres
• Uma matriz para localizar um valor
• Um dicionário para localizar uma chave

Parâmetro	Obrigatório	Type	Descrição
<collection>	Sim	Cadeia de caracteres, matriz ou dicionário	A coleção a ser verificada
<value>	Sim	Cadeia de caracteres, matriz ou dicionário, respectivamente	O item a ser localizado

Valor retornado	Type	Descrição
true ou false	Booliano	Retornar true se o item for encontrado. Retornar false se não for encontrado.

Exemplo 1

Este exemplo verifica se há a substring world na cadeia de caracteres hello world:

contains('hello world', 'world')

E retorna o resultado true.

Exemplo 2

Este exemplo verifica se há a substring universe na substring hello world:

contains('hello world', 'universe')

E retorna o resultado false.

contagem

Retornar o número de itens em uma coleção.

count('<collection>')
count([<collection>])

Parâmetro	Obrigatório	Type	Descrição
<collection>	Sim	cadeia de caracteres ou matriz	A coleção com os itens a serem contados

Valor retornado	Type	Descrição
<length-or-count>	Número inteiro	O número de itens na coleção

Exemplos:

Esses exemplos contam o número de itens nestas coleções:

count('abcd')
count(createArray(0, 1, 2, 3))

E ambas retornam o resultado 4.

countWord

Retornar o número de palavras na cadeia de caracteres

countWord('<text>')

Parâmetro	Obrigatório	Type	Descrição
<text>	Sim	string	A cadeia de caracteres a ser contada

Valor retornado	Type	Descrição
<count>	Número inteiro	O número de palavras na cadeia de caracteres

Exemplo

Este exemplo conta o número de palavras na cadeia de caracteres hello world:

countWord("hello word")

E retorna o resultado 2.

convertFromUTC

Converter um carimbo de data/hora de UTC (Tempo Universal Coordenado) para um fuso horário de destino.

convertFromUTC('<timestamp>', '<destinationTimeZone>', '<format>'?, '<locale>'?)

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	string	Uma cadeia de caracteres que contém o carimbo de data/hora
<destinationTimeZone>	Sim	string	O nome do fuso horário de destino. Compatível com fusos horários Windows e IANA.
<format>	Não	string	Um padrão de formato personalizado. O formato padrão para o carimbo de data/hora é o formato "o", aaaa-MM-ddTHH:mm:ss.fffffffK, que está em conformidade com a ISO 8601.
<locale>	Não	string	Um local de informações de cultura opcional

Valor retornado	Type	Descrição
<converted-timestamp>	string	O carimbo de data/hora convertido na região do fuso horário

Exemplos:

Estes exemplos convertem de UTC para Horário Padrão do Pacífico:

convertFromUTC('2018-02-02T02:00:00.000Z', 'Pacific Standard Time', 'MM-DD-YY')
convertFromUTC('2018-02-02T02:00:00.000Z', 'Pacific Standard Time')

E, respectivamente, retornam estes resultados:

• 02-01-18
• 2018-01-01T18:00:00.0000000

Exemplo 2

Este exemplo converte um carimbo de data/hora na localidade en-US de UTC para Hora Padrão do Pacífico:

convertFromUTC('2018-01-02T02:00:00.000Z', 'Pacific Standard Time', 'D', 'en-US')

E retorna o resultado segunda-feira, 1º de janeiro de 2018.

convertToUTC

Converter um carimbo de data/hora em um formato de localidade opcional para UTC (Tempo Universal Coordenado) do fuso horário de origem.

convertToUTC('<timestamp>', '<sourceTimeZone>', '<format>'?, '<locale>'?)

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	string	Uma cadeia de caracteres que contém o carimbo de data/hora
<sourceTimeZone>	Sim	string	O nome do fuso horário de destino. Compatível com fusos horários Windows e IANA.
<format>	Não	string	Um padrão de formato personalizado. O formato padrão do carimbo de data/hora é o UTC ISO, AAAA-MM-DDTHH:mm:ss.fffZ, compatível com a ISO 8601.
<locale>	Não	string	Um local de informações de cultura opcional

Valor retornado	Type	Descrição
<converted-timestamp>	string	O carimbo de data/hora convertido na região do fuso horário

Exemplo

Este exemplo converte um carimbo de data/hora em UTC do Horário Padrão do Pacífico

convertToUTC('01/01/2018 00:00:00', 'Pacific Standard Time')

E retorna o resultado 2018-01-01T08:00:00.000Z.

Exemplo 2

Este exemplo converte um carimbo de data/hora na localidade de-DE de UTC para Horário Padrão do Pacífico:

convertToUTC('01/01/2018 00:00:00', 'Pacific Standard Time', '', 'de-DE')

E retorna o resultado 01.01.18 08:00:00.

createArray

Retornar uma matriz de várias entradas.

createArray('<object1>', '<object2>', ...)

Parâmetro	Obrigatório	Type	Descrição
<objeto1>, <objeto2>, ...	Sim	Qualquer um, mas não misto	Pelo menos dois itens para criar a matriz

Valor retornado	Type	Descrição
[<objeto1>, <objeto2>, ...]	matriz	A matriz criada com base em todos os itens de entrada

Exemplo

Este exemplo cria uma matriz com base nestas entradas:

createArray('h', 'e', 'l', 'l', 'o')

E retorna o resultado [h, e, l, l, o].

dataUri

Retornar um URI (Uniform Resource Identifier) de dados de uma cadeia de caracteres.

dataUri('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	string	A cadeia de caracteres a ser convertida

Valor retornado	Type	Descrição
[<date-uri>]	string	O URI dos dados da cadeia de caracteres de entrada

Exemplo

dataUri('hello')

Retorna o resultado data:text/plain;charset=utf-8;base64,aGVsbG8=.

dataUriToBinary

Retornar a versão binária de um URI (Uniform Resource Identifier) de dados.

dataUriToBinary('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	string	O URI de dados a ser convertido

Valor retornado	Type	Descrição
[<binary-for-data-uri>]	matriz de bytes	A versão binária do URI de dados

Exemplo

Este exemplo cria uma versão binária para o seguinte URI de dados:

dataUriToBinary('aGVsbG8=')

E retorna o resultado new byte[] { 97, 71, 86, 115, 98, 71, 56, 61 }.

dataUriToString

Retornar a versão de cadeia de caracteres de um URI (Uniform Resource Identifier) de dados.

dataUriToString('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	string	O URI de dados a ser convertido

Valor retornado	Type	Descrição
[<string-for-data-uri>]	string	A versão de cadeia de caracteres do URI de dados

Exemplo

Este exemplo cria uma cadeia de caracteres para o seguinte URI de dados:

dataUriToString('data:text/plain;charset=utf-8;base64,aGVsbG8=')

E retorna o resultado hello.

date

Retornar a data de um carimbo de data/hora especificado no formato m/dd/aaaa.

date('<timestramp>')

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	string	Uma cadeia de caracteres que contém o carimbo de data/hora

Valor retornado	Type	Descrição
<date>	string	A data do carimbo de data/hora especificado

date('2018-03-15T13:00:00.000Z')

Retorna o resultado 3-15-2018.

dateReadBack

Usar a biblioteca de data e hora para fornecer um readback de data.

dateReadBack('<currentDate>', '<targetDate>')

Parâmetro	Obrigatório	Type	Descrição
<currentDate>	Sim	string	Uma cadeia de caracteres que contém a data atual
<targetDate>	Sim	string	Uma cadeia de caracteres que contém a data de destino

Valor retornado	Type	Descrição
<date-readback>	string	O readback entre a data atual e a data de destino

Exemplo 1

dateReadBack('2018-03-15T13:00:00.000Z', '2018-03-16T13:00:00.000Z')

Retorna o resultado em tomorrow.

dateTimeDiff

Retornar a diferença em ticks entre dois carimbos de data/hora.

dateTimeDiff('<timestamp1>', '<timestamp2>')

Parâmetro	Obrigatório	Type	Descrição
<timestamp1>	Sim	string	A primeira cadeia de caracteres a ser comparada
<timestamp2>	Sim	string	A segunda cadeia de caracteres a ser comparada

Valor retornado	Type	Descrição
<ticks>	número	A diferença em ticks entre dois carimbos de data/hora

Exemplo 1

Este exemplo retorna a diferença em ticks entre dois carimbos de data/hora:

dateTimeDiff('2019-01-01T08:00:00.000Z','2018-01-01T08:00:00.000Z')

E retorna o número 315360000000000.

Exemplo 2

Este exemplo retorna a diferença em ticks entre dois carimbos de data/hora:

dateTimeDiff('2018-01-01T08:00:00.000Z', '2019-01-01T08:00:00.000Z')

Retorna o resultado -315360000000000. O valor é um número negativo.

dayOfMonth

Retorna o dia do mês de um carimbo de data/hora.

dayOfMonth('<timestamp>')

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	string	Uma cadeia de caracteres que contém o carimbo de data/hora

Valor retornado	Type	Descrição
<day-of-month>	Número inteiro	O dia do mês do carimbo de data/hora especificado

Exemplo

Este exemplo retorna o número do dia do mês do seguinte carimbo de data/hora:

dayOfMonth('2018-03-15T13:27:36Z')

E retorna o resultado 15.

dayOfWeek

Retornar o dia da semana de um carimbo de data/hora.

dayOfWeek('<timestamp>')

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	string	Uma cadeia de caracteres que contém o carimbo de data/hora

Valor retornado	Type	Descrição
<day-of-week>	Número inteiro	O dia da semana do carimbo de data/hora especificado. O domingo é 0, a segunda-feira é 1 e assim por diante.

Exemplo

Este exemplo retorna o número do dia da semana do seguinte carimbo de data/hora:

dayOfWeek('2018-03-15T13:27:36Z')

E retorna o resultado 3.

dayOfYear

Retorna o dia do ano de um carimbo de data/hora.

dayOfYear('<timestamp>')

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	string	Uma cadeia de caracteres que contém o carimbo de data/hora

Valor retornado	Type	Descrição
<day-of-year>	Número inteiro	O dia do ano do carimbo de data/hora especificado

Exemplo

Este exemplo retorna o número do dia do ano do seguinte carimbo de data/hora:

dayOfYear('2018-03-15T13:27:36Z')

E retorna o resultado 74.

div

Retornar o resultado inteiro da divisão de dois números. Para retornar o restante, confira mod().

div(<dividend>, <divisor>)

Parâmetro	Obrigatório	Type	Descrição
<dividend>	Sim	número	O número a ser dividido pelo divisor
<divisor>	Sim	número	O número que divide o dividendo. Ele não pode ser 0.

Valor retornado	Type	Descrição
<quotient-result>	número	O resultado da divisão do primeiro número pelo segundo

Exemplo

Os dois exemplos dividem o primeiro número pelo segundo:

div(10, 5)
div(11, 5)

E retorna o resultado 2.

Existe alguma lacuna entre Javascript e SDK do .NET. Por exemplo, a expressão a seguir retornará resultados diferentes em Javascript e SDK do .NET:

Se um dos parâmetros for um float, o resultado também será um FLOAT com SDK do .NET.

Exemplo

div(11.2, 2)

Retorna o resultado 5,6.

Se um dos parâmetros for um float, o resultado será um INT com Javascript do SDK.

Exemplo

div(11.2, 2)

Retorna o resultado 5.

A solução alternativa para o Javascript manter um certo número de casas decimais nos resultados é usar essa expressão. Por exemplo, para manter 3 casas decimais:

float(concat(string(div(a, b)),'.',string(mod(div(a*1000, b), 1000))))

empty

Verifique se uma instância está vazia. Retorne true se a entrada estiver vazia. Vazio significa:

• a entrada é nula ou indefinida
• a entrada é uma cadeia de caracteres nula ou vazia
• a entrada tem uma coleção de tamanho zero
• a entrada é um objeto sem propriedade.

empty('<instance>')
empty([<instance>])

Parâmetro	Obrigatório	Type	Descrição
<instância>	Sim	qualquer	A instância a ser verificada

Valor retornado	Type	Descrição
true ou false	Booliano	Retorne true quando a instância estiver vazia.

Exemplo

Esses exemplos verificam se a instância especificada está vazia:

empty('')
empty('abc')
empty([1])
empty(null)

E retornam estes resultados, respectivamente:

• Passa uma cadeia de caracteres vazia para que a função retorne true.
• Passa uma cadeia de caracteres abc, para que a função retorne false.
• Passa a coleção com um item, de modo que a função retorna false.
• Passa o objeto nulo, de modo que a função retorna true.

endsWith

Verificar se uma cadeia de caracteres termina com uma subcadeia de caracteres específica. Retornar true se a substring for encontrada ou retornar false se não for encontrada. Essa função não diferencia maiúsculas de minúsculas.

endsWith('<text>', '<searchText>')

Parâmetro	Obrigatório	Type	Descrição
<text>	Sim	string	A cadeia de caracteres a ser verificada
<searchText>	Sim	string	A subcadeia de caracteres final a ser localizada

Valor retornado	Type	Descrição
true ou false	Booliano	Retornar true quando a substring final for localizada. Retornar false se não for encontrada

Exemplo 1

Este exemplo verifica se a cadeia de caracteres hello world termina com a cadeia de caracteres world:

endsWith('hello world', 'world')

E retorna o resultado true.

Exemplo 2

Este exemplo verifica se a cadeia de caracteres hello world termina com a cadeia de caracteres universe:

endsWith('hello world', 'universe')

E retorna o resultado false.

EOL

Retornar o texto da sequência de fim da linha (EOL).

EOL()

Valor retornado	Type	Descrição
<IsOSPlatform>	string	Retornar \r\n no Windows e \n no Mac e Linux.

Exemplo

Este exemplo verifica o final do texto da sequência de linhas:

EOL()

E retorna as seguintes cadeias de caracteres:

• Windows: \r\n
• Mac or Linux: \n

equals

Verificar se os valores, expressões ou objetos são equivalentes. Retornar true quando ambos forem equivalentes ou retornar false quando não forem equivalentes.

equals('<object1>', '<object2>')

Parâmetro	Obrigatório	Type	Descrição
<objeto1>, <objeto2>	Sim	qualquer	Os valores, expressões ou objetos a serem comparados

Valor retornado	Type	Descrição
true ou false	Booliano	Retornar true quando ambos forem equivalentes. Retornar false se não for equivalente.

Exemplo

Estes exemplos verificam se as entradas especificadas são equivalentes:

equals(true, 1)
equals('abc', 'abcd')

E retornam estes resultados, respectivamente:

• Ambos os valores são equivalentes, então a função retorna true.
• Ambos os valores não são equivalentes, então a função retorna false.

exists

Avaliar a veracidade da expressão.

exists(expression)

Parâmetro	Obrigatório	Type	Descrição
expressão	Sim	expressão	Expressão da qual a veracidade será avaliada

Valor retornado	Type	Descrição
<true ou false>	Booliano	Resultado da avaliação da expressão

Exemplo

Estes exemplos avaliam a veracidade de foo = {"bar":"value"}:

exists(foo.bar)
exists(foo.bar2)

E retornam estes resultados, respectivamente:

• true
• false

exp

Retornar a exponenciação de um número para outro.

exp(realNumber, exponentNumber)

Parâmetro	Obrigatório	Type	Descrição
realNumber	Sim	número	Número real do qual o expoente será calculado
exponentNumber	Sim	número	Número do expoente

Valor retornado	Type	Descrição
<result-exp>	número	O resultado do cálculo do expoente de realNumber

Exemplo

Este exemplo calcula o expoente:

exp(2, 2)

E retorna o resultado 4.

first

Retornar o primeiro item de uma cadeia de caracteres ou de uma matriz.

first('<collection>')
first([<collection>])

Parâmetro	Obrigatório	Type	Descrição
<collection>	Sim	cadeia de caracteres ou matriz	A coleção na qual localizar o primeiro item

Valor retornado	Type	Descrição
<first-collection-item>	qualquer	O primeiro item na coleção

Exemplo

Estes exemplos localizam o primeiro item nas seguintes coleções:

first('hello')
first(createArray(0, 1, 2))

E retornam estes resultados, respectivamente:

• h
• 0

mesclar

Nivelar uma matriz em valores que não são da matriz. Opcionalmente, defina a profundidade máxima de nivelamento.

flatten([<collection>], '<depth>')

Parâmetro	Obrigatório	Type	Descrição
<collection>	Sim	matriz	Coleção a ser nivelada
<depth>	Não	número	Profundidade máxima de nivelamento. O padrão é infinito.

Valor retornado	Type	Descrição
<new-collection>	matriz	Nova coleção cujos elementos foram nivelados para uma não matriz na profundidade especificada

Exemplo 1

Este exemplo nivela a seguinte matriz:

flatten(createArray(1, createArray(2), createArray(createArray(3, 4), createArray(5, 6)))

E retorna o resultado [1, 2, 3, 4, 5, 6].

Exemplo 2

Este exemplo nivela a matriz com uma profundidade de 1:

flatten(createArray(1, createArray(2), createArray(createArray(3, 4), createArray(5, 6)), 1)

E retorna o resultado [1, 2, [3, 4], [5, 6]].

float

Converter uma versão de cadeia de caracteres de um número de ponto flutuante em um número de ponto flutuante. É possível usar essa função apenas ao passar parâmetros personalizadas para um aplicativo, como um aplicativo lógico. Uma exceção será lançada se a cadeia de caracteres não puder ser convertida em float.

float('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	string	A cadeia de caracteres que tem um número de ponto flutuante válido a ser convertido

Valor retornado	Type	Descrição
<float-value>	float	O número de ponto flutuante da cadeia de caracteres especificada

Exemplo

Este exemplo converte a versão flutuante de uma cadeia de caracteres:

float('10.333')

E retorna o float 10.333.

floor

Retornar o maior número inteiro que seja menor ou igual ao número especificado.

floor('<number>')

Parâmetro	Obrigatório	Type	Descrição
<number>	Sim	número	Um número de entrada

Valor retornado	Type	Descrição
<integer-value>	Número inteiro	O maior número inteiro menor ou igual ao número de entrada

Exemplo

Este exemplo calcula o valor mínimo do número 10.333:

floor(10.333)

E retorna o número inteiro 10.

foreach

Operar em cada elemento e retornar a nova coleção.

foreach([<collection/instance>], <iteratorName>, <function>)

Parâmetro	Obrigatório	Type	Descrição
<collection/instance>	Sim	objeto ou matriz	A coleção com os itens
<iteratorName>	Sim	Nome do iterador	O item principal da função de seta
<function>	Sim	expressão	Função que contém iteratorName

Valor retornado	Type	Descrição
<new-collection>	matriz	A nova coleção na qual cada elemento foi avaliado pela função

Exemplo 1

Este exemplo gera uma nova coleção:

foreach(createArray(0, 1, 2, 3), x, x + 1)

E retorna o resultado [1, 2, 3, 4].

Exemplo 2

Estes exemplos geram uma nova coleção:

foreach(json("{'name': 'jack', 'age': '15'}"), x, concat(x.key, ':', x.value))
foreach(json("{'name': 'jack', 'age': '15'}"), x=> concat(x.key, ':', x.value))

E retorna o resultado ['name:jack', 'age:15']. Observe que a segunda expressão é uma expressão lambda, que alguns acham mais legível.

formatDateTime

Retornar um carimbo de data/hora em um formato de localidade opcional.

formatDateTime('<timestamp>', '<format>'?, '<locale>'?)

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	string	Uma cadeia de caracteres que contém o carimbo de data/hora
<format>	Não	string	Um padrão de formato personalizado. O formato padrão do carimbo de data/hora é o UTC ISO, AAAA-MM-DDTHH:mm:ss.fffZ, compatível com a ISO 8601.
<locale>	Não	string	Um local de informações de cultura opcional

Valor retornado	Type	Descrição
<reformatted-timestamp>	string	O carimbo de data/hora atualizado no formato especificado

Exemplo 1

Esse exemplo converte um carimbo de data/hora no formato especificado:

formatDateTime('03/15/2018 12:00:00', 'yyyy-MM-ddTHH:mm:ss')

E retorna o resultado 2018-03-15T12:00:00.

Exemplo 2

Este exemplo converte um carimbo de data/hora na localidade de-DE:

formatDateTime('2018-03-15', '', 'de-DE')

E retorna o resultado 15.03.18 00:00:00.

formatEpoch

Retorna um carimbo de data/hora em um formato de localidade opcional no formato especificado da hora do UNIX (também conhecida como hora da Época, hora do POSIX, hora da Época do UNIX).

formatEpoch('<epoch>', '<format>'?, '<locale>'?)

Parâmetro	Obrigatório	Type	Descrição
<epoch>	Sim	número	O número de época
<format>	Não	string	Um padrão de formato personalizado. O formato padrão do carimbo de data/hora é o UTC ISO, AAAA-MM-DDTHH:mm:ss.fffZ, compatível com a ISO 8601.
<locale>	Não	string	Um local de informações de cultura opcional

Valor retornado	Type	Descrição
<reformatted-timestamp>	string	O carimbo de data/hora atualizado no formato especificado

Exemplo

Este exemplo converte um carimbo de data/hora do Unix no formato especificado:

formatEpoch(1521118800, 'yyyy-MM-ddTHH:mm:ss.fffZ)'

E retorna o resultado 2018-03-15T12:00:00.000Z.

Exemplo

Este exemplo converte um carimbo de data/hora do Unix na localidade de-DE:

formatEpoch(1521118800, '', 'de-DE')

E retorna o resultado 15.03.18 13:00:00.

formatNumber

Formatar um valor para o número especificado de dígitos fracionários e uma localidade especificada opcional.

formatNumber('<number>', '<precision-digits>', '<locale>'?)

Parâmetro	Obrigatório	Type	Descrição
<number>	Sim	número	Um número de entrada
<precision-digits>	Sim	Número inteiro	Um número especificado de dígitos fracionários
<locale>	Não	string	Um local de informações de cultura opcional

Valor retornado	Type	Descrição
<valor retornado>	número	O valor retornado da entrada formatada em um número especificado de dígitos fracionários e uma localidade especificada

Exemplo 1

Este exemplo formata o número 10.333 para 2 dígitos fracionários:

formatNumber(10.333, 2)

E retorna a a cadeia de caracteres 10.33.

Exemplo 2

Estes exemplos formatam números para um número especificado de dígitos na localidade en-US:

formatNumber(12.123, 2, 'en-US')
formatNumber(1.551, 2, 'en-US')
formatNumber(12.123, 4, 'en-US')

E retornam os seguintes resultados, respectivamente:

• 12.12
• 1.55
• 12.1230

formatTicks

Retornar um carimbo de data/hora em um formato de localidade opcional no formato especificado a partir de tiques.

formatTicks('<ticks>', '<format>'?, '<locale>'?)

Parâmetro	Obrigatório	Type	Descrição
<epoch>	Sim	número (ou bigint em JavaScript)	O número de tiques
<format>	Não	string	Um padrão de formato personalizado. O formato padrão do carimbo de data/hora é o UTC ISO, AAAA-MM-DDTHH:mm:ss.fffZ, compatível com a ISO 8601.
<locale>	Não	string	Um local de informações de cultura opcional

Valor retornado	Type	Descrição
<reformatted-timestamp>	string	O carimbo de data/hora atualizado no formato especificado

Exemplo 1

Este exemplo converte tiques no formato especificado:

formatTicks(637243624200000000, 'yyyy-MM-ddTHH:mm:ss.fffZ')

E retorna o resultado 2020-05-06T11:47:00.000Z.

Exemplo 2

Este exemplo converte tiques no formato especificado na localidade de-DE:

formatTicks(637243624200000000, '', 'de-DE')

E retorna o resultado 06.05.20 11:47:00.

getFutureTime

Retornar o carimbo de data/hora atual em um formato de localidade opcional mais as unidades de tempo especificadas.

getFutureTime(<interval>, <timeUnit>, '<format>'?, '<locale>'?)

Parâmetro	Obrigatório	Type	Descrição
<interval>	Sim	Número inteiro	O número de unidades de tempo especificadas a serem adicionadas
<timeUnit>	Sim	string	A unidade de tempo a ser usada com interval. As unidades possíveis são "Second", "Minute", "Hour", "Day", "Week", "Month" e "Year".
<format>	Não	string	Um padrão de formato personalizado. O formato padrão do carimbo de data/hora é o UTC ISO, AAAA-MM-DDTHH:mm:ss.fffZ, compatível com a ISO 8601.
<locale>	Não	string	Um local de informações de cultura opcional

Valor retornado	Type	Descrição
<updated-timestamp>	string	O carimbo de data/hora atual mais o número de unidades de tempo especificado

Exemplo 1

Suponha que o carimbo de data/hora seja 2019-03-01T00:00:00.000Z. O exemplo abaixo adiciona cinco dias a esse carimbo de data/hora:

getFutureTime(2, 'Week')

E retorna o resultado 2019-03-15T00:00:00.000Z.

Exemplo 2

Suponha que o carimbo de data/hora seja 2018-03-01T00:00:00.000Z. O exemplo abaixo adiciona cinco dias ao carimbo de data/hora e converte o resultado para o formato MM-DD-AA:

getFutureTime(5, 'Day', 'MM-DD-YY')

E retorna o resultado 03-06-18.

Exemplo 3

Suponha que o carimbo de data/hora atual seja 2020-05-01T00:00:00.000Z e a localidade seja de-DE. O exemplo abaixo adiciona 1 dia a esse carimbo de data/hora:

getFutureTime(1,'Day', '', 'de-DE')

E retorna o resultado 02.05.20 00:00:00.

getNextViableDate

Retornar a próxima data viável de uma expressão Timex com base na data atual e em um fuso horário especificado opcionalmente.

getNextViableDate(<timexString>, <timezone>?)

Parâmetro	Obrigatório	Type	Descrição
<timexString>	Sim	string	A cadeia de caracteres Timex da data a ser avaliada.
<timezone>	Não	string	O fuso horário opcional.

Valor retornado	Type	Descrição
<nextViableTime>	string	A próxima data viável.

Exemplos

Digamos que a data é 2020-06-12 e a hora atual é 15:42:21.

Estes exemplos avaliam a cadeia de caracteres Timex para a próxima data viável com base na data e hora acima:

getPreviousViableDate("XXXX-12-20", "America/Los_Angeles")
getPreviousViableDate("XXXX-02-29")

E retornam as seguintes cadeias de caracteres, respectivamente:

• 2020-12-20
• 2024-02-29

getNextViableTime

Retornar a próxima hora viável de uma expressão Timex com base na data atual e em um fuso horário especificado opcionalmente.

getNextViableTime(<timexString>, <timezone>?)

Parâmetro	Obrigatório	Type	Descrição
<timexString>	Sim	string	A cadeia de caracteres Timex do tempo a ser avaliado.
<timezone>	Não	string	O fuso horário opcional.

Valor retornado	Type	Descrição
<nextViableTime>	string	O próximo tempo viável.

Exemplos

Digamos que a data é 2020-06-12 e a hora atual é 15:42:21.

Estes exemplos avaliam uma cadeia de caracteres Timex para a próxima hora viável com base na data e hora acima:

getNextViableTime("TXX:12:14", "Asia/Tokyo")
getNextViableTime("TXX:52:14")

E retornam as seguintes cadeias de caracteres, respectivamente:

• T16:12:14
• T15:52:14

getPastTime

Retornar o carimbo de data/hora atual menos as unidades de tempo especificadas.

getPastTime(<interval>, <timeUnit>, '<format>'?)

Parâmetro	Obrigatório	Type	Descrição
<interval>	Sim	Número inteiro	O número específico de unidades de tempo a serem subtraídas
<timeUnit>	Sim	string	A unidade de tempo a ser usada com interval. As unidades possíveis são "Second", "Minute", "Hour", "Day", "Week", "Month" e "Year".
<format>	Não	string	Um padrão de formato personalizado. O formato padrão do carimbo de data/hora é o UTC ISO, AAAA-MM-DDTHH:mm:ss.fffZ, compatível com a ISO 8601.

Valor retornado	Type	Descrição
<updated-timestamp>	string	O carimbo de data/hora atual menos o número de unidades de tempo especificado

Exemplo 1

Suponha que o carimbo de data/hora seja 2018-02-01T00:00:00.000Z. Esse exemplo subtrai cinco dias desse carimbo de data/hora:

getPastTime(5, 'Day')

E retorna o resultado 2019-01-27T00:00:00.000Z.

Exemplo 2

Suponha que o carimbo de data/hora seja 2018-03-01T00:00:00.000Z. Este exemplo subtrai cinco dias para o carimbo de data/hora no formato MM-DD-AA:

getPastTime(5, 'Day', 'MM-DD-YY')

E retorna o resultado 02-26-18.

Exemplo 3

Suponha que o carimbo de data/hora atual seja 2020-05-01T00:00:00.000Z e a localidade seja de-DE. O exemplo abaixo subtrai 1 dia do carimbo de data/hora:

getPastTime(1,'Day', '', 'de-DE')

E retorna o resultado 31.04.20 00:00:00.

getPreviousViableDate

Retornar a data viável anterior de uma expressão Timex com base na data atual e em um fuso horário especificado opcionalmente.

getPreviousViableDate(<timexString>, <timezone>?)

Parâmetro	Obrigatório	Type	Descrição
<timexString>	Sim	string	A cadeia de caracteres Timex da data a ser avaliada.
<timezone>	Não	string	O fuso horário opcional.

Valor retornado	Type	Descrição
<previousViableDate>	string	A data viável anterior.

Exemplos

Digamos que a data é 2020-06-12 e a hora atual é 15:42:21.

Estes exemplos avaliam uma cadeia de caracteres Timex para a data viável anterior com base na data e hora acima:

getPreviousViableDate("XXXX-12-20", "Eastern Standard Time")
getPreviousViableDate("XXXX-02-29")

E retornam as seguintes cadeias de caracteres, respectivamente:

• 2019-12-20
• 2020-02-29

getPreviousViableTime

Retornar a hora viável anterior de uma expressão Timex com base na data atual e em um fuso horário especificado opcionalmente.

getPreviousViableTime(<timexString>, <timezone>?)

Parâmetro	Obrigatório	Type	Descrição
<timexString>	Sim	string	A cadeia de caracteres Timex do tempo a ser avaliado.
<timezone>	Não	string	O fuso horário opcional.

Valor retornado	Type	Descrição
<previousViableTime>	string	O tempo viável anterior.

Exemplos

Digamos que a data é 2020-06-12 e a hora atual é 15:42:21.

Estes exemplos avaliam uma cadeia de caracteres Timex para a hora viável anterior com base na data e hora acima:

getPreviousViableTime("TXX:52:14")
getPreviousViableTime("TXX:12:14", 'Europe/London')

E retornam as seguintes cadeias de caracteres, respectivamente:

• T14:52:14
• T15:12:14

getProperty

Retornar o valor de uma propriedade especificada ou a propriedade raiz de um objeto JSON.

Retornar o valor de uma propriedade especificada

getProperty(<JSONObject>, '<propertyName>')

Parâmetro	Obrigatório	Type	Descrição
<JSONObject>	Sim	objeto	O objeto JSON que contém a propriedade e os valores.
<propertyName>	Não	string	O nome da propriedade opcional a partir da qual acessar valores.

Valor retornado	Type	Descrição
value	string	O valor da propriedade especificada no objeto JSON.

Exemplo

Digamos que você tenha o seguinte objeto JSON:

{
   "a:b" : "a:b value",
   "c":
   {
        "d": "d key"
    }
}

Estes exemplos recuperam uma propriedade especificada do objeto JSON acima:

getProperty({"a:b": "value"}, 'a:b')
getProperty(c, 'd')

E retornam as seguintes cadeias de caracteres, respectivamente:

• valor a:b
• d key

Retorna a propriedade raiz

getProperty('<propertyName>')

Parâmetro	Obrigatório	Type	Descrição
<propertyName>	Sim	string	O nome da propriedade opcional para acessar valores do escopo de memória raiz.

Valor retornado	Type	Descrição
value	string	O valor da propriedade raiz fornecida em um objeto JSON.

Exemplo

Digamos que você tenha o seguinte objeto JSON:

{
   "a:b" : "a:b value",
   "c":
   {
        "d": "d key"
    }
}

Este exemplo recupera a propriedade raiz do objeto JSON acima:

getProperty("a:b")

E retorna a cadeia de caracteres de valor a:b.

getTimeOfDay

Retornar a hora do dia de um carimbo de data/hora fornecido.

getTimeOfDay('<timestamp>')

A hora retornada é uma das cadeias de caracteres a seguir:

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	string	Uma cadeia de caracteres que contém o carimbo de data/hora especificado

Valor retornado	Type	Descrição
<time-of-day>	string	A hora do dia do carimbo de data/hora especificado

Abaixo estão listadas as cadeias de caracteres associadas à hora do dia:

Hora do dia	Carimbo de data/hora
meia-noite	00:00
manhã	00:01 – 11:59
tarde	12:00
noite	18:00 – 22:00
noite	22:01 – 23:59

Exemplo

getTimeOfDay('2018-03-15T08:00:00.000Z')

Retorna o resultado manhã.

greater

Verificar se o primeiro valor é maior que o segundo valor. Retornar true se o primeiro valor for maior ou retornar false se for menor.

greater(<value>, <compareTo>)
greater('<value>', '<compareTo>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	inteiro, float ou cadeia de caracteres	O primeiro valor para verificar se é maior do que o segundo
<compareTo>	Sim	inteiro, float ou cadeia de caracteres, respectivamente	O valor de comparação

Valor retornado	Type	Descrição
true ou false	Booliano	Retornar true se o primeiro valor for maior que o segundo. Retornar false se o primeiro valor for igual ou menor que o segundo.

Exemplo

Esses exemplos verificam se o primeiro valor é maior que o segundo:

greater(10, 5)
greater('apple', 'banana')

E retornam os seguintes resultados, respectivamente:

• true
• false

greaterOrEquals

Verificar se o primeiro valor é superior ou igual ao segundo. Retornar true quando o primeiro valor for maior ou igual ou retornar false se o primeiro valor for inferior.

greaterOrEquals(<value>, <compareTo>)
greaterOrEquals('<value>', '<compareTo>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	inteiro, float ou cadeia de caracteres	O primeiro valor para verificar se é superior ou igual ao segundo
<compareTo>	Sim	inteiro, float ou cadeia de caracteres, respectivamente	O valor de comparação

Valor retornado	Type	Descrição
true ou false	Booliano	Retornar true se o primeiro valor for maior ou igual ao segundo. Retornar false se o primeiro valor for menor que o segundo.

Exemplo

Esses exemplos verificam se o primeiro valor é superior ou igual ao segundo:

greaterOrEquals(5, 5)
greaterOrEquals('apple', 'banana')

E retornam os seguintes resultados, respectivamente:

• true
• false

if

Verificar se uma expressão é verdadeira ou falsa. Com base no resultado, retornar um valor especificado.

if(<expression>, <valueIfTrue>, <valueIfFalse>)

Parâmetro	Obrigatório	Type	Descrição
<expression>	Sim	Boolean	A expressão a ser verificada
<valueIfTrue>	Sim	qualquer	O valor a ser retornado se a expressão for true
<valueIfFalse>	Sim	qualquer	O valor a ser retornado se a expressão for false

Valor retornado	Type	Descrição
<specified-return-value>	qualquer	O valor especificado retornado dependendo se a expressão for true ou false

Exemplo

Este exemplo avalia se equals(1,1) é true:

if(equals(1, 1), 'yes', 'no')

E retorna yes, porque a expressão especificada retorna true. Caso contrário, o exemplo retorna no.

indexOf

Retornar o valor de índice ou da posição inicial de uma substring. Essa função não diferencia maiúsculas de minúsculas, e os índices começam com o número 0.

indexOf('<text>', '<searchText>')

Parâmetro	Obrigatório	Type	Descrição
<text>	Sim	cadeia de caracteres ou matriz	A cadeia de caracteres que tem a subcadeia de caracteres a ser localizada
<searchText>	Sim	string	A subcadeia de caracteres a ser localizada

Valor retornado	Type	Descrição
<index-value>	Número inteiro	O valor de índice ou da posição inicial da substring especificada.
Se a cadeia de caracteres não for localizada, retornará o número -1.

Exemplo 1

Este exemplo localiza o valor de índice inicial da substring world na cadeia de caracteres hello world:

indexOf('hello world', 'world')

E retorna o resultado 6.

Exemplo 2

Este exemplo localiza o valor de índice inicial da substring def na matriz ['abc', 'def', 'ghi']:

indexOf(createArray('abc', 'def', 'ghi'), 'def')

E retorna o resultado 1.

indicesAndValues

Transformar uma matriz ou objeto em uma matriz de objetos com a propriedade index (index atual) e value. Para matrizes, o índice é a posição na matriz. Para objetos, é a chave do valor.

indicesAndValues('<collection or object>')

Parâmetro	Obrigatório	Type	Descrição
<collection ou object>	Sim	objeto ou matriz	Objeto ou matriz original

Valor retornado	Type	Descrição
<collection>	matriz	Nova matriz. Cada item tem duas propriedades: o índice com a posição em uma matriz ou a chave para um objeto e o valor correspondente.

Exemplo 1

Digamos que você tenha uma lista { items: ["zero", "one", "two"] }. A seguinte função usa essa lista:

indicesAndValues(items)

E retorna uma nova lista:

[
  {
    index: 0,
    value: 'zero'
  },
  {
    index: 1,
    value: 'one'
  },
  {
    index: 2,
    value: 'two'
  }
]

Exemplo 2

Digamos que você tenha uma lista { items: ["zero", "one", "two"] }. A seguinte função usa essa lista:

where(indicesAndValues(items), elt, elt.index >= 1)

E retorna uma nova lista:

[
  {
    index: 1,
    value: 'one'
  },
  {
    index: 2,
    value: 'two'
  }
]

Exemplo 3

Digamos que você tenha uma lista { items: ["zero", "one", "two"] }. A seguinte função usa essa lista:

join(foreach(indicesAndValues(items), item, item.value), ',')

E retorna o resultado zero,one,two. Essa expressão tem o mesmo efeito que join(items, ',').

Exemplo 4

Digamos que você tenha um objeto { user: {name: 'jack', age: 20} }. A seguinte função usa esse objeto:

indicesAndValues(user)

E retorna um novo objeto:

[
  {
    index: 'name',
    value: 'jack'
  },
  {
    index: 'age',
    value: 20
  }
]

int

Retornar a versão em inteiros de uma cadeia de caracteres. Uma exceção será lançada se a cadeia de caracteres não puder ser convertida em um inteiro.

int('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	string	A cadeia de caracteres a ser convertida

Valor retornado	Type	Descrição
<integer-result>	Número inteiro	A versão em inteiros da cadeia de caracteres especificada

Exemplo

Este exemplo cria uma versão em inteiros da cadeia de caracteres 10:

int('10')

E retorna o resultado como o inteiro 10.

intersection

Retornar uma coleção que tem somente os itens comuns entre as coleções especificadas. Para aparecer no resultado, um item deve ser exibido em todas as coleções passadas para essa função. Se um ou mais itens tiverem o mesmo nome, o último item com o nome será exibido neste resultado.

intersection([<collection1>], [<collection2>], ...)
intersection('<collection1>', '<collection2>', ...)

Parâmetro	Obrigatório	Type	Descrição
<collection1>, <collection2>	Sim	matriz ou objeto, mas não ambos	As coleções das quais você deseja somente os itens comuns

Valor retornado	Type	Descrição
<common-items>	matriz ou objeto, respectivamente	Uma coleção que tem somente os itens comuns entre as coleções especificadas

Exemplo

Este exemplo localiza os itens comuns entre as seguintes matrizes:

intersection(createArray(1, 2, 3), createArray(101, 2, 1, 10), createArray(6, 8, 1, 2))

E retorna uma matriz apenas com os itens [1, 2].

isArray

Retornar true se uma entrada fornecida for uma matriz.

isArray('<input>')

Parâmetro	Obrigatório	Type	Descrição
<input>	Sim	qualquer	A entrada a ser testada

Valor retornado	Type	Descrição
<Boolean-result>	Booliano	Retornar true se uma entrada fornecida for uma matriz ou retornar false se não for uma matriz.

Exemplos

Os seguintes exemplos verificam se a entrada é uma matriz:

isArray('hello')
isArray(createArray('hello', 'world'))

E retornam os seguintes resultados, respectivamente:

• A entrada é uma cadeia de caracteres, portanto, a função retorna false.
• A entrada é uma matriz, portanto, a função retorna true.

isBoolean

Retornar true se uma entrada fornecida for um booliano.

isBoolean('<input>')

Parâmetro	Obrigatório	Type	Descrição
<input>	Sim	qualquer	A entrada a ser testada

Valor retornado	Type	Descrição
<Boolean-result>	Booliano	Retornar true se uma entrada fornecida for um booliano ou retornar false se não for um booliano.

Exemplos

Os seguintes exemplos verificam se a entrada é um booliano:

isBoolean('hello')
isBoolean(32 > 16)

E retornam os seguintes resultados, respectivamente:

• A entrada é uma cadeia de caracteres, portanto, a função retorna false.
• A entrada é um booliano, portanto, a função retorna true.

isDate

Retornar true se a expressão TimexProperty ou Timex fornecida se referir a uma data válida. As datas válidas contêm o month e o dayOfMonth ou contêm o dayOfWeek.

isDate('<input>')

Parâmetro	Obrigatório	Type	Descrição
<input>	Sim	objeto ou cadeia de caracteres	O objeto Timexproperty de entrada ou uma cadeia de caracteres de expressão Timex.

Valor retornado	Type	Descrição
<boolean-result>	Booliano	Retornar true se a entrada se referir a uma data válida ou retornar false se a data for inválida.

Exemplos

Estes exemplos verificam se as seguintes entradas são datas válidas:

isDate('2020-12')
isDate('xxxx-12-21')

E retornam os seguintes resultados:

• false
• true

isDateRange

Retornar true se a expressão TimexProperty ou Timex fornecida se referir a um intervalo de datas válido.

isDateRange('<input>')

Parâmetro	Obrigatório	Type	Descrição
<input>	Sim	objeto ou cadeia de caracteres	O objeto Timexproperty de entrada ou uma cadeia de caracteres de expressão Timex.

Valor retornado	Type	Descrição
<boolean-result>	Booliano	Retornar true se a entrada fornecida se referir a um intervalo de datas válido ou retornar false se não for um intervalo de datas válido.

Exemplos

Estes exemplos verificam se as entradas a seguir são intervalos de datas válidos:

isDateRange('PT30M')
isDateRange('2012-02')

E retornam os seguintes resultados:

• false
• true

isDateTime

Retornar true se uma entrada fornecida for uma cadeia de caracteres de carimbo de data/hora de formato ISO UTC (AAAA-MM-DDTHH:mm:ss.fffZ).

isDateTime('<input>')

Parâmetro	Obrigatório	Type	Descrição
<input>	Sim	qualquer	A entrada a ser testada

Valor retornado	Type	Descrição
<Boolean-result>	Booliano	Retornar true se uma entrada fornecida for uma cadeia de caracteres de carimbo de data/hora de formato UTC ISO ou retornar false se não for uma cadeia de caracteres de carimbo de data/hora de formato UTC ISO.

Exemplos

Os seguintes exemplos verificam se a entrada é uma cadeia de caracteres de formato UTC ISO:

isDateTime('hello world!')
isDateTime('2019-03-01T00:00:00.000Z')

E retornam os seguintes resultados, respectivamente:

• A entrada é uma cadeia de caracteres, portanto, a função retorna false.
• A entrada é uma cadeia de caracteres de formato UTC ISO, portanto, a função retorna true.

isDefinite

Retornar true se a expressão TimexProperty ou Timex fornecida se referir a uma data válida. As datas válidas contêm year, month e dayOfMonth.

isDefinite('<input>')

Parâmetro	Obrigatório	Type	Descrição
<input>	Sim	objeto ou cadeia de caracteres	O objeto Timexproperty de entrada ou uma cadeia de caracteres de expressão Timex.

Valor retornado	Type	Descrição
<boolean-result>	Booliano	Retornar true se a entrada fornecida se referir a uma data completa válida ou retornar false se não fizer referência a uma data completa válida.

Exemplos

Suponha que haja um objeto Timexproperty validFullDate = new TimexProperty("2020-02-20") e a propriedade Now esteja definida como true. Os seguintes exemplos verificam se o objeto refere-se a uma data completa válida:

isDefinite('xxxx-12-21')
isDefinite(validFullDate)

E retornam os seguintes resultados, respectivamente:

• false
• true

isDuration

Retornar true se a expressão TimexProperty ou Timex fornecida se referir a uma duração válida.

isDuration('<input>')

Parâmetro	Obrigatório	Type	Descrição
<input>	Sim	objeto ou cadeia de caracteres	O objeto Timexproperty de entrada ou uma cadeia de caracteres de expressão Timex.

Valor retornado	Type	Descrição
<boolean-result>	Booliano	Retornar true se a entrada se referir a uma duração válida ou retornar false se a entrada não se referir a uma duração válida.

Exemplos

Os exemplos abaixo verificam se a seguinte entrada se refere a uma duração válida:

isDuration('PT30M')
isDuration('2012-02')

E retornam os seguintes resultados, respectivamente:

• true
• false

isFloat

Retornar true se uma entrada fornecida for um número de ponto flutuante. Devido ao alinhamento entre C# e JavaScript, um número com um resto diferente de zero de seu módulo 1 será tratado como um número de ponto flutuante.

isFloat('<input>')

Parâmetro	Obrigatório	Type	Descrição
<input>	Sim	qualquer	A entrada a ser testada

Valor retornado	Type	Descrição
<Boolean-result>	Booliano	Retornar true se uma entrada fornecida for um número de ponto flutuante ou retornar false se a entrada não for um número de ponto flutuante.

Exemplos

Os exemplos a seguir verificam se a entrada é um número de ponto flutuante:

isFloat('hello world!')
isFloat(1.0)
isFloat(12.01)

E retornam os seguintes resultados, respectivamente:

• A entrada é uma cadeia de caracteres, portanto, a função retorna false.
• A entrada tem um módulo que é igual a 0, portanto, a função retorna false.
• A entrada é um número de ponto flutuante, portanto, a função retorna true.

isInteger

Retornar true se a entrada fornecida for um número inteiro. Devido ao alinhamento entre C# e JavaScript, um número com um resto diferente de zero de seu módulo 1 será tratado como um número de ponto flutuante.

isInteger('<input>')

Parâmetro	Obrigatório	Type	Descrição
<input>	Sim	qualquer	A entrada a ser testada

Valor retornado	Type	Descrição
<Boolean-result>	Booliano	A entrada é um número inteiro

Exemplos

Os seguintes exemplos verificam se a entrada é um inteiro:

isInteger('hello world!')
isInteger(1.0)
isInteger(12)

E retornam os seguintes resultados, respectivamente:

• A entrada é uma cadeia de caracteres, portanto, a função retorna false.
• A entrada tem um módulo que é igual a 0, portanto, a função retorna true.
• A entrada é um inteiro, portanto, a função retorna true.

isMatch

Retornar true se uma cadeia de caracteres fornecida corresponder a um padrão de expressão regular especificado.

isMatch('<target**string>', '<pattern>')

Parâmetro	Obrigatório	Type	Descrição
<target**string>	Sim	string	A cadeia de caracteres a ser correspondida
<pattern>	Sim	string	Um padrão de expressão regular

Valor retornado	Type	Descrição
<Boolean-result>	Booliano	Retornar true se uma cadeia de caracteres fornecida corresponder a um padrão comum de expressão regular ou retornar false se não corresponder ao padrão.

Exemplos

O seguinte exemplo verifica se a entrada corresponde ao padrão de expressão regular especificado:

isMatch('ab', '^[a-z]{1,2}$')
isMatch('FUTURE', '(?i)fortune|future')
isMatch('12abc34', '([0-9]+)([a-z]+)([0-9]+)')
isMatch('abacaxc', 'ab.*?c')

E retorna o mesmo resultado true.

isObject

Retornar true se uma entrada fornecida for um objeto complexo ou retornar false se for um objeto primitivo. Os objetos primitivos incluem cadeias de caracteres, números e boolianos; os tipos complexos, como classes, contêm propriedades.

isObject('<input>')

Parâmetro	Obrigatório	Type	Descrição
<input>	Sim	qualquer	A entrada a ser testada

Valor retornado	Type	Descrição
<Boolean-result>	Booliano	Retornar true se uma entrada fornecida for um objeto complexo ou retornar false se for um objeto primitivo.

Exemplos

Os seguintes exemplos verificam se a entrada fornecida é um objeto:

isObject('hello world!')
isObject({userName: "Sam"})

E retornam os seguintes resultados, respectivamente:

• A entrada é uma cadeia de caracteres, portanto, a função retorna false.
• A entrada é um objeto, portanto, a função retorna true.

isPresent

Retornar true se a expressão TimexProperty ou Timex fornecida se referir ao presente.

isPresent('<input>')

Parâmetro	Obrigatório	Type	Descrição
<input>	Sim	objeto ou cadeia de caracteres	O objeto Timexproperty de entrada ou uma cadeia de caracteres de expressão Timex

Valor retornado	Type	Descrição
<boolean-result>	Booliano	Retornar true se a entrada se referir ao presente ou retornar false se ela não se referir ao presente.

Exemplos suponha que tenhamos um objeto Timexproperty validNow = new TimexProperty() { Now = true } e definimos a propriedade Now como true. Os exemplos abaixo verificam se a seguinte entrada se refere ao presente:

isPresent('PT30M')
isPresent(validNow)

E retornam os seguintes resultados, respectivamente:

• false
• true

isString

Retornar true se uma entrada fornecida for uma cadeia de caracteres.

isString('<input>')

Parâmetro	Obrigatório	Type	Descrição
<input>	Sim	qualquer	A entrada a ser testada

Valor retornado	Type	Descrição
<Boolean-result>	Booliano	Retornar true se uma entrada fornecida for uma cadeia de caracteres ou retornar false se não for uma cadeia de caracteres.

Exemplos

Os seguintes exemplos verificam se a entrada fornecida é uma cadeia de caracteres:

isString('hello world!')
isString(3.14)

E retornam os seguintes resultados, respectivamente:

• A entrada é uma cadeia de caracteres, portanto, a função retorna true.
• A entrada é um float, portanto, a função retorna false.

isTime

Retornar true se a expressão TimexProperty ou Timex fornecida se referir a um horário válido. O horário válido contém horas, minutos e segundos.

isTime('<input>')

Parâmetro	Obrigatório	Type	Descrição
<input>	Sim	objeto ou cadeia de caracteres	O objeto Timexproperty de entrada ou uma cadeia de caracteres de expressão Timex

Valor retornado	Type	Descrição
<boolean-result>	Booliano	Retornar true se a entrada se referir a um horário válido ou retornar false se não se referir a um horário válido.

Exemplos

Estes exemplos verificam se a seguinte entrada se refere a um horário válido:

isTime('PT30M')
isTime('2012-02-21T12:30:45')

E retornam os seguintes resultados, respectivamente:

• false
• true

isTimeRange

Retornar true se a expressão TimexProperty ou Timex fornecida se referir a um intervalo de tempo válido que contêm partOfDay.

isTime('<input>')

Parâmetro	Obrigatório	Type	Descrição
<input>	Sim	objeto ou cadeia de caracteres	O objeto Timexproperty de entrada ou uma cadeia de caracteres de expressão Timex.

Valor retornado	Type	Descrição
<boolean-result>	Booliano	Retornar true se a entrada se referir a um intervalo de tempo válido ou retornar false se não se referir a um intervalo de tempo válido.

Exemplos

Suponha que tenhamos um objeto Timexproperty validTimeRange = new TimexProperty() { PartOfDay = "morning" } e definimos a propriedade Now como true. Estes exemplos verificam se as seguintes entradas são intervalos de tempo válidos:

isTimeRange('PT30M')
isTimeRange(validTimeRange)

E retornam os seguintes resultados, respectivamente:

• false
• true

join

Retornar uma cadeia de caracteres que tem todos os itens de uma matriz com cada caractere separado por um delimitador.

join([<collection>], '<delimiter>')

Parâmetro	Obrigatório	Type	Descrição
<collection>	Sim	matriz	A matriz que tem os itens a serem ingressados
<delimiter>	Sim	string	O separador exibido entre cada caractere na cadeia de caracteres resultante

Valor retornado	Type	Descrição
<caractere1><delimitador><caractere2><delimitador>...	string	A cadeia de caracteres resultante criada com base em todos os itens na matriz especificada

Exemplo

Esse exemplo cria uma cadeia de caracteres com base em todos os itens nessa matriz com o caractere . especificado como o delimitador:

join(createArray('a', 'b', 'c'), '.')

E retorna o resultado a.b.c.

jPath

Marcar JSON ou uma cadeia de caracteres JSON para nós ou valores que correspondam a uma expressão de caminho e retornar os nós correspondentes.

jPath(<json>, '<path>')

Parâmetro	Obrigatório	Type	Descrição
<json>	Sim	qualquer	A cadeia de caracteres ou objeto JSON para pesquisar nós ou valores que correspondem a um valor de expressão path
<caminho>	Sim	qualquer	A expressão de caminho usada para localizar valores ou nós JSON correspondentes

Valor retornado	Type	Descrição
[ <json-node>]	matriz	Uma lista de nós ou valores JSON que corresponde à expressão de caminho especificada

Exemplo de C#

Digamos que você tenha o seguinte JSON:

{
    "Stores": [
        "Lambton Quay",
        "Willis Street"
    ],
    "Manufacturers": [
        {
            "Name": "Acme Co",
            "Products": [
                {
                    "Name": "Anvil",
                    "Price": 50
                }
            ]
        },
        {
            "Name": "Contoso",
            "Products": [
                {
                    "Name": "Elbow Grease",
                    "Price": 99.95
                },
                {
                    "Name": "Headlight Fluid",
                    "Price": 4
                }
            ]
        }
    ]
}

A expressão de caminho é $..Products[?(@.Price >= 50)].Name

jPath(jsonStr, path)

E ele retorna o resultado ["Anvil", "Elbow Grease"].

Exemplo de JavaScript

Digamos que você tenha o seguinte JSON:

{
    "automobiles": [
        {
            "maker": "Nissan",
            "model": "Teana",
            "year": 2011
        },
        {
            "maker": "Honda",
            "model": "Jazz",
            "year": 2010
        },
        {
            "maker": "Honda",
            "model": "Civic",
            "year": 2007
        },
        {
            "maker": "Toyota",
            "model": "Yaris",
            "year": 2008
        },
        {
            "maker": "Honda",
            "model": "Accord",
            "year": 2011
        }
    ],
    "motorcycles": [
        {
            "maker": "Honda",
            "model": "ST1300",
            "year": 2012
        }
    ]
}

A expressão do caminho é .automobiles{.maker === "Honda" && .year > 2009}.model.

jPath(jsonStr, path)

E ela retorna o resultado ['Jazz', 'Accord'].

json

Retornar o objeto ou valor de tipo JSON (JavaScript Object Notation) de uma cadeia de caracteres ou XML.

json('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	cadeia de caracteres ou XML	A cadeia de caracteres ou XML a ser convertido

Valor retornado	Type	Descrição
<JSON-result>	string	O objeto JSON resultante criado a partir da cadeia de caracteres especificada ou XML.

Exemplo 1

Este exemplo converte uma cadeia de caracteres em JSON:

json('{"fullName": "Sophia Owen"}')

E retorna o resultado:

{
  "fullName": "Sophia Owen"
}

Exemplo 2

Este exemplo converte o XML em JSON:

json(xml('<?xml version="1.0"?> <root> <person id='1'> <name>Sophia Owen</name> <occupation>Engineer</occupation> </person> </root>'))

E retorna o resultado:

{
   "?xml": { "@version": "1.0" },
   "root": {
      "person": [ {
         "@id": "1",
         "name": "Sophia Owen",
         "occupation": "Engineer"
      } ]
   }
}

jsonStringify

Retornar a string JSON de um valor.

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	objeto	O objeto a ser convertido em uma cadeia de caracteres JSON

Valor retornado	Type	Descrição
<JSON-result>	string	A cadeia de caracteres JSON resultante.

Exemplos

Estes exemplos mostram objetos convertidos em cadeias de caracteres JSON:

jsonStringify(null)
jsonStringify({a:'b'})

E retornam os seguintes resultados de cadeia de caracteres, respectivamente:

• nulo
• {"a":"b"}

last

Retornar o último item de uma coleção.

last('<collection>')
last([<collection>])

Parâmetro	Obrigatório	Type	Descrição
<collection>	Sim	cadeia de caracteres ou matriz	A coleção na qual localizar o último item

Valor retornado	Type	Descrição
<last-collection-item>	Cadeia de caracteres ou matriz, respectivamente	O último item na coleção

Exemplo

Esses exemplos localizam o último item nestas coleções:

last('abcd')
last(createArray(0, 1, 2, 3))

E retornam os seguintes resultados, respectivamente:

• d
• 3

lastIndexOf

Retorna a posição inicial ou valor de índice da última ocorrência de uma substring. Essa função não diferencia maiúsculas de minúsculas, e os índices começam com o número 0.

lastIndexOf('<text>', '<searchText>')

Parâmetro	Obrigatório	Type	Descrição
<text>	Sim	cadeia de caracteres ou matriz	A cadeia de caracteres que tem a subcadeia de caracteres a ser localizada
<searchText>	Sim	string	A subcadeia de caracteres a ser localizada

Valor retornado	Type	Descrição
<ending-index-value>	Número inteiro	A posição inicial ou valor de índice da última ocorrência da substring especificada. Se a cadeia de caracteres não for localizada, retornará o número -1.

Exemplo 1

Este exemplo encontra o valor de índice inicial da última ocorrência da substring world na cadeia de caracteres hello world:

lastIndexOf('hello world', 'world')

E retorna o resultado 6.

Exemplo 2

Este exemplo localiza o valor de índice inicial da última ocorrência da substring def na matriz ['abc', 'def', 'ghi', 'def'].

lastIndexOf(createArray('abc', 'def', 'ghi', 'def'), 'def')

E retorna o resultado 3.

length

Retornar o comprimento de uma cadeia de caracteres.

length('<str>')

Parâmetro	Obrigatório	Type	Descrição
<str>	Sim	string	A cadeia de caracteres a ser calculada para o comprimento

Valor retornado	Type	Descrição
<length>	Número inteiro	O comprimento dessa cadeia de caracteres

Exemplos

Estes exemplos obtêm o comprimento das cadeias de caracteres:

length('hello')
length('hello world')

E retornam os seguintes resultados, respectivamente:

• 5
• 11

less

Verificar se o primeiro valor é menor que o segundo valor. Retornar true se o primeiro valor for menor ou retornar false se o primeiro valor for maior.

less(<value>, <compareTo>)
less('<value>', '<compareTo>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	inteiro, float ou cadeia de caracteres	O primeiro valor para verificar se é menor do que o segundo
<compareTo>	Sim	inteiro, float ou cadeia de caracteres, respectivamente	O item de comparação

Valor retornado	Type	Descrição
true ou false	Booliano	Retornar true se o primeiro valor for menor que o segundo. Retornar false se o primeiro valor for igual ou maior que o segundo.

Exemplos

Esses exemplos verificam se o primeiro valor é menor que o segundo.

less(5, 10)
less('banana', 'apple')

E retornam os seguintes resultados, respectivamente:

• true
• false

lessOrEquals

Verificar se o primeiro valor é inferior ou igual ao segundo valor. Retornar true se o primeiro valor for menor ou igual ou retornar false se o primeiro valor for maior.

lessOrEquals(<value>, <compareTo>)
lessOrEquals('<value>', '<compareTo>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	inteiro, float ou cadeia de caracteres	O primeiro valor para verificar se é inferior ou igual ao segundo
<compareTo>	Sim	inteiro, float ou cadeia de caracteres, respectivamente	O item de comparação

Valor retornado	Type	Descrição
true ou false	Booliano	Retornar true se o primeiro valor for igual ou menor que o segundo. Retornar false se o primeiro valor for maior que o segundo.

Exemplo

Estes exemplos verificam se o primeiro valor é menor ou igual ao segundo.

lessOrEquals(10, 10)
lessOrEquals('apply', 'apple')

E retornam os seguintes resultados, respectivamente:

• true
• false

max

Retornar o maior valor de uma lista ou matriz. A lista ou matriz é inclusiva em ambas as extremidades.

max(<number1>, <number2>, ...)
max([<number1>, <number2>, ...])

Parâmetro	Obrigatório	Type	Descrição
<número1>, <número2>, ...	Sim	número	O conjunto de números do qual você deseja o valor mais alto
[<número1>, <número2>, ...]	Sim	matriz de números	A matriz de números da qual você deseja o valor mais alto

Valor retornado	Type	Descrição
<max-value>	número	O valor mais alto na matriz ou conjunto de números especificado

Exemplos

Esses exemplos obtêm o valor mais alto do conjunto de números e da matriz:

max(1, 2, 3)
max(createArray(1, 2, 3))

E retornam o resultado 3.

merge

Mescla vários objetos JSON ou uma matriz de objetos.

merge(<json1>, <json2>, ...)

Parâmetro	Obrigatório	Type	Descrição
<json1>, <json2>, ...	Sim	objetos ou matriz	O conjunto de objetos JSON ou matriz a serem mesclados.

Valor retornado	Type	Description
<result>	objeto	O objeto JSON combinado ou objetos de matriz combinados.

Exemplos

Digamos que você tenha os seguintes objetos JSON:

json1 = @"{
            'FirstName': 'John',
            'LastName': 'Smith',
            'Enabled': false,
            'Roles': [ 'User' ]
          }"
json2 =@"{
            'Enabled': true,
            'Roles': [ 'User', 'Admin' ]
          }"

Este exemplo mescla os objetos JSON:

string(merge(json(json1), json(json2)))

E retorna o objeto resultante {"FirstName":"John","LastName":"Smith","Enabled":true,"Roles":["User","Admin"]}.

Digamos que você queira combinar objetos e uma lista de objetos. O exemplo a seguir combina o objeto JSON e uma matriz de objetos:

merge({k1:'v1'}, [{k2:'v2'}, {k3: 'v3'}], {k4:'v4'})

E retorna o objeto { "k1": "v1", "k2": "v2", "k3": "v3", "k4": "v4" }.

min

Retornar o valor mais baixo de um conjunto de números ou de uma matriz.

min(<number1>, <number2>, ...)
min([<number1>, <number2>, ...])

Parâmetro	Obrigatório	Type	Descrição
<número1>, <número2>, ...	Sim	número	O conjunto de números do qual você deseja o valor mais baixo
[<número1>, <número2>, ...]	Sim	matriz de números	A matriz de números da qual você deseja o valor mais baixo

Valor retornado	Type	Descrição
<min-value>	número	O valor mais baixo na matriz ou conjunto de números especificado

Exemplos

Esses exemplos obtêm o valor mais baixo no conjunto de números e na matriz:

min(1, 2, 3)
min(createArray(1, 2, 3))

E retornam o resultado 1.

mod

Retornar o resto da divisão de dois números. Para obter o resultado inteiro, confira div().

mod(<dividend>, <divisor>)

Parâmetro	Obrigatório	Type	Descrição
<dividend>	Sim	número	O número a ser dividido pelo divisor
<divisor>	Sim	número	O número que divide o dividendo. Ele não pode ser 0.

Valor retornado	Type	Descrição
<modulo-result>	número	O resto da divisão do primeiro número pelo segundo

Exemplo

O exemplo divide o primeiro número pelo segundo:

mod(3, 2)

E retorna o resultado 1.

month

Retornar o mês do carimbo de data/hora especificado.

month('<timestamp>')

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	string	Uma cadeia de caracteres que contém o carimbo de data/hora

Valor retornado	Type	Descrição
<number-of-month>	Número inteiro	O número do mês no carimbo de data/hora especificado

Exemplo

month('2018-03-15T13:01:00.000Z')

E ele retorna o resultado 3.

mul

Retornar o produto da multiplicação de dois números.

mul(<multiplicand1>, <multiplicand2>)

Parâmetro	Obrigatório	Type	Descrição
<multiplicand1>	Sim	inteiro ou float	O número a ser multiplicado por multiplicand2
<multiplicand2>	Sim	inteiro ou float	O número que multiplica multiplicand1

Valor retornado	Type	Descrição
<product-result>	inteiro ou float	O produto da multiplicação do primeiro número pelo segundo

Exemplos

Esses exemplos multiplicam o primeiro número pelo segundo:

mul(1, 2)
mul(1.5, 2)

E retornam os seguintes resultados, respectivamente:

• 2
• 3

newGuid

Retornar uma nova cadeia de caracteres Guid.

newGuid()

Valor retornado	Type	Descrição
<Guid-string>	string	Uma nova cadeia de caracteres Guid, o comprimento é 36 e é semelhante a xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx

Exemplo

newGuid()

E retorna um resultado que segue o formato xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx.

not

Verificar se uma expressão é falsa. Retornar true se a expressão for false ou retornar false se for true.

not(<expression>)

Parâmetro	Obrigatório	Type	Descrição
<expression>	Sim	Boolean	A expressão a ser verificada

Valor retornado	Type	Descrição
true ou false	Booliano	Retornar true se a expressão for falsa. Retornar false se a expressão for true.

Exemplo 1

Esses exemplos verificam se as expressões especificadas são false:

not(false)
not(true)

E retornam os seguintes resultados, respectivamente:

• A expressão é false, então a função retorna true.
• A expressão é true, então a função retorna false.

Exemplo 2

Esses exemplos verificam se as expressões especificadas são false:

not(equals(1, 2))
not(equals(1, 1))

E retornam os seguintes resultados, respectivamente:

• A expressão é false, então a função retorna true.
• A expressão é true, então a função retorna false.

or

Verificar se pelo menos uma expressão é verdadeira. Retornar true se pelo menos uma expressão for true ou retornar false quando todas forem false.

or(<expression1>, <expression2>, ...)

Parâmetro	Obrigatório	Type	Descrição
<expression1>, <expression2>, ...	Sim	Boolean	As expressões a serem verificadas

Valor retornado	Type	Descrição
true ou false	Booliano	Retornar true se pelo menos uma expressão for true. Retornar false se todas as expressões forem false.

Exemplo 1

Esses exemplos verificam se pelo menos uma expressão é true:

or(true, false)
or(false, false)

E retornam os seguintes resultados, respectivamente:

• No mínimo, uma expressão é true, então a função retorna true.
• Ambas as expressões são false, então a função retorna false.

Exemplo 2

Esses exemplos verificam se pelo menos uma expressão é true:

or(equals(1, 1), equals(1, 2))
or(equals(1, 2), equals(1, 3))

E retornam os seguintes resultados, respectivamente:

• No mínimo, uma expressão é true, então a função retorna true.
• Ambas as expressões são false, então a função retorna false.

rand

Retornar um inteiro aleatório de um intervalo especificado, inclusivo apenas na extremidade inicial.

rand(<minValue>, <maxValue>)

Parâmetro	Obrigatório	Type	Descrição
<minValue>	Sim	Número inteiro	O menor inteiro no intervalo
<maxValue>	Sim	Número inteiro	O inteiro que segue o inteiro mais alto no intervalo que a função pode retornar

Valor retornado	Type	Descrição
<random-result>	Número inteiro	O inteiro aleatório retornado do intervalo especificado

Exemplo

Esse exemplo obtém um inteiro aleatório do intervalo especificado, excluindo o valor máximo:

rand(1, 5)

E retorna 1, 2, 3 ou 4 como resultado.

range

Retornar uma matriz de inteiros que começa em um inteiro especificado.

range(<startIndex>, <count>)

Parâmetro	Obrigatório	Type	Descrição
<startIndex>	Sim	Número inteiro	Um número inteiro que inicia a matriz como o primeiro item
<count>	Sim	Número inteiro	O número de inteiros na matriz

Valor retornado	Type	Descrição
<range-result>	Número inteiro	A matriz com inteiros que começa no índice especificado

Exemplo

Este exemplo cria uma matriz de inteiros que começa no índice especificado 1 e tem o número de inteiros especificado como 4:

range(1, 4)

E retorna o resultado [1, 2, 3, 4].

removeProperty

Remover uma propriedade de um objeto e retornar o objeto atualizado.

removeProperty(<object>, '<property>')

Parâmetro	Obrigatório	Type	Descrição
<object>	Sim	objeto	O objeto JSON no qual você deseja remover uma propriedade
<property>	Sim	string	O nome da propriedade a remover

Valor retornado	Type	Descrição
<updated-object>	objeto	O objeto JSON atualizado sem a propriedade especificada

Exemplo

Este exemplo remove a propriedade accountLocation de um objeto customerProfile, convertido em JSON com a função json() e retorna o objeto atualizado:

removeProperty(json('customerProfile'), 'accountLocation')

substituir

Substituir uma subcadeia de caracteres pela cadeia de caracteres especificada e retornar a cadeia de caracteres resultante. Essa função diferencia maiúsculas de minúsculas.

replace('<text>', '<oldText>', '<newText>')

Parâmetro	Obrigatório	Type	Descrição
<text>	Sim	string	A cadeia de caracteres que tem a subcadeia de caracteres a ser substituída
<oldText>	Sim	string	A subcadeia de caracteres a ser substituída
<newText>	Sim	string	A cadeia de caracteres de substituição

Valor retornado	Type	Descrição
<updated-text>	string	A cadeia de caracteres atualizada após substituir a substring. Se a substring não for localizada, a função retornará a cadeia de caracteres original.

Exemplo 1

Este exemplo localiza a substring old em the old string e substitui old por new:

replace('the old string', 'old', 'new')

O resultado é a cadeia de caracteres the new string.

Exemplo 2

Ao lidar com caracteres de escape, o mecanismo de expressão lida com o unescape para você. Essa função substitui as cadeias de caracteres por caracteres de escape.

replace('hello\"', '\"', '\n')
replace('hello\n', '\n', '\\\\')
@"replace('hello\\', '\\', '\\\\')"
@"replace('hello\n', '\n', '\\\\')"

E retornam os seguintes resultados, respectivamente:

• hello\n
• hello\\
• @"hello\\"
• @"hello\\"

replaceIgnoreCase

Substituir uma subcadeia de caracteres pela cadeia de caracteres especificada e retornar a cadeia de caracteres resultante. Essa função não diferencia maiúsculas de minúsculas.

replaceIgnoreCase('<text>', '<oldText>', '<newText>')

Parâmetro	Obrigatório	Type	Descrição
<text>	Sim	string	A cadeia de caracteres que tem a subcadeia de caracteres a ser substituída
<oldText>	Sim	string	A subcadeia de caracteres a ser substituída
<newText>	Sim	string	A cadeia de caracteres de substituição

Valor retornado	Type	Descrição
<updated-text>	string	A cadeia de caracteres atualizada após substituir a substring. Se a subcadeia de caracteres não for localizada, retorne a cadeia de caracteres original.

Exemplo

Este exemplo localiza a substring old na cadeia de caracteres the old string e substitui old por new:

replace('the old string', 'old', 'new')

E retorna o resultado the new string.

resolver

Retorna a cadeia de caracteres de uma determinada expressão TimexProperty ou Timex se ela se referir a um horário válido. O horário válido contém horas, minutos e segundos.

resolve('<timestamp')

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	string	Uma cadeia de caracteres que contém o carimbo de data/hora.

Valor retornado	Type	Descrição
<return>	string	Uma cadeia de caracteres da expressão TimexProperty ou Timex avaliada.

Exemplos

Estes exemplos mostram se as cadeias de caracteres fornecidas se referem ao tempo válido:

resolve(T14)
resolve(2020-12-20)
resolve(2020-12-20T14:20)

E retornam os seguintes resultados, respectivamente:

• 14:00:00
• 2020-12-20
• 2020-12-20 14:20:00

reverse

Inverte a ordem dos elementos em uma cadeia de caracteres ou matriz.

reverse(<value>)

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	cadeia de caracteres ou matriz	A cadeia de caracteres a ser revertida na matriz.

Valor retornado	Type	Descrição
<return>	cadeia de caracteres ou matriz	Os elementos invertidos de uma cadeia de caracteres ou matriz.

Exemplos

Estes exemplos invertem os elementos de uma cadeia de caracteres ou matriz:

reverse(hello)
reverse(concat(hello,world))

E retornam os seguintes valores, respectivamente:

- A cadeia de caracteres olleh. - A cadeia de caracteres dlrowolleh.

round

Arredondar um valor para o inteiro mais próximo ou para o número especificado de casas decimais.

round('<number>', '<precision-digits>')

Parâmetro	Obrigatório	Type	Descrição
<number>	Sim	número	Um número de entrada
<precision-digits>	Não	Número inteiro	Um número especificado de dígitos fracionários. O padrão é 0.

Valor retornado	Type	Descrição
<valor retornado>	número	O valor retornado da entrada arredondado em um número especificado de dígitos fracionários

Exemplo 1

Este exemplo arredonda o número 10,333:

round(10.333)

E retorna o número 10.

Exemplo 2

Este exemplo arredonda o número 10,3313 para 2 dígitos fracionários:

round(10.3313, 2)

E retorna o número 10,33.

select

Operar em cada elemento e retornar a nova coleção de elementos transformados.

select([<collection/instance>], <iteratorName>, <function>)

Parâmetro	Obrigatório	Type	Descrição
<collection/instance>	Sim	matriz	A coleção com os itens
<iteratorName>	Sim	Nome do iterador	O item chave
<function>	Sim	expressão	Função que pode conter iteratorName

Valor retornado	Type	Descrição
<new-collection>	matriz	A nova coleção na qual cada elemento foi avaliado com a função

Exemplo 1

Este exemplo gera uma nova coleção:

select(createArray(0, 1, 2, 3), x, x + 1)

E retorna o resultado [1, 2, 3, 4].

Exemplo 2

Estes exemplos geram uma nova coleção:

select(json("{'name': 'jack', 'age': '15'}"), x, concat(x.key, ':', x.value))
select(json("{'name': 'jack', 'age': '15'}"), x=> concat(x.key, ':', x.value))

E retorna o resultado ['name:jack', 'age:15']. Observe que a segunda expressão é uma expressão lambda, que alguns acham mais legível.

sentenceCase

Colocar em maiúsculas a primeira letra da primeira palavra em uma cadeia de caracteres em um formato de localidade opcional.

sentenceCase('<text>', '<locale>'?)

Parâmetro	Obrigatório	Type	Descrição
<text>	Sim	string	A cadeia de caracteres original
<locale>	Não	string	Um local de informações de cultura opcional

Valor retornado	Type	Descrição
cadeia de caracteres de resultado	string	Retorna o resultado do caso da sentença

Exemplo 1

Estes exemplos colocam a primeira letra em maiúscula em uma cadeia de caracteres:

sentenceCase('a')
sentenceCase('abc def')
sentenceCase('aBC dEF')

E retornam os seguintes resultados, respectivamente:

• A
• Abc def
• Abc def

Exemplo 2

Estes exemplos colocam a primeira letra em maiúsculas em uma cadeia de caracteres no formato de localidade especificado:

sentenceCase('a', 'fr-FR')
sentenceCase('abc', 'en-US')
sentenceCase('aBC', 'fr-FR')

E retornam os seguintes resultados, respectivamente:

• A
• Abc
• Abc

setPathToValue

Recuperar o valor da propriedade especificada do objeto JSON.

setPathToValue(<path>, <value>)

Parâmetro	Obrigatório	Type	Descrição
<Caminho>	Sim	objeto	O caminho que você deseja definir
<value>	Sim	objeto	O valor que você deseja definir para o caminho

Valor retornado	Type	Descrição
value	objeto	O valor a ser definido

Exemplo 1

O seguinte exemplo define o valor 1 para o caminho:

setPathToValue(path.x, 1)

E retorna o resultado 1. path.x está definido como 1.

Exemplo 2

Este exemplo abaixo define o valor:

setPathToValue(path.array[0], 7) + path.array[0]

E retorna o resultado 14.

setProperty

Definir o valor da propriedade do objeto e retornar o objeto atualizado. Para adicionar uma nova propriedade, use essa função ou a função addProperty().

setProperty(<object>, '<property>', <value>)

Parâmetro	Obrigatório	Type	Descrição
<object>	Sim	objeto	O objeto JSON no qual você deseja definir uma propriedade
<property>	Sim	string	O nome da propriedade a ser definida
<value>	Sim	qualquer	O valor a ser definido para a propriedade especificada

Valor retornado	Type	Descrição
<updated-object>	objeto	O objeto JSON atualizado cuja propriedade você define

Exemplo

Este exemplo define a propriedade accountNumber em um objeto customerProfile, convertido em JSON com a função json(). A função atribui um valor gerado pela função newGuid() e retorna o objeto JSON atualizado:

setProperty(json('customerProfile'), 'accountNumber', newGuid())

skip

Remover itens do início de uma coleção e retornar todos os outros itens.

skip([<collection>], <count>)

Parâmetro	Obrigatório	Type	Descrição
<collection>	Sim	matriz	A coleção cujos itens você deseja remover
<count>	Sim	Número inteiro	Um inteiro positivo para o número de itens a ser removido no início

Valor retornado	Type	Descrição
<updatedCollection>	matriz	A coleção atualizada depois de remover os itens especificados

Exemplo

Este exemplo remove um item, o número 1, do início da matriz especificada:

skip(createArray(0, 1, 2, 3), 1)

E retorna uma matriz com os itens restantes: [1,2,3].

sortBy

Classificar elementos na coleção em ordem crescente e retornar a coleção classificada.

sortBy([<collection>], '<property>')

Parâmetro	Obrigatório	Type	Descrição
<collection>	Sim	cadeia de caracteres ou matriz	A coleção a ser classificada
<property>	Não	string	Classificar por essa propriedade específica do elemento object na coleção, se definido

Valor retornado	Type	Descrição
<new-collection>	matriz	A nova coleção cujos elementos foram classificados

Exemplo 1

Este exemplo gera classificações na seguinte coleção:

sortBy(createArray(1, 2, 0, 3))

E retornam o resultado [0, 1, 2, 3].

Exemplo 2

Suponha que você tenha a seguinte coleção:

{
  'nestedItems': [
    {'x': 2},
    {'x': 1},
    {'x': 3}
  ]
}

Este exemplo gera uma nova coleção classificada com base na propriedade object x

sortBy(nestedItems, 'x')

E retorna o resultado:

{
  'nestedItems': [
    {'x': 1},
    {'x': 2},
    {'x': 3}
  ]
}

sortByDescending

Classificar elementos na coleção em ordem decrescente e retornar a coleção classificada.

sortBy([<collection>], '<property>')

Parâmetro	Obrigatório	Type	Descrição
<collection>	Sim	cadeia de caracteres ou matriz	A coleção a ser classificada
<property>	Não	string	Classificar por essa propriedade específica do elemento object na coleção, se definido

Valor retornado	Type	Descrição
<new-collection>	matriz	A nova coleção cujos elementos foram classificados

Exemplo 1

Este exemplo gera uma nova coleção classificada:

sortByDescending(createArray(1, 2, 0, 3))

E retorna o resultado [3, 2, 1, 0].

Exemplo 2

Suponha que você tenha a seguinte coleção:

{
  'nestedItems': [
    {'x': 2},
    {'x': 1},
    {'x': 3}
  ]
}

Este exemplo gera uma nova coleção classificada com base na propriedade object x:

sortByDescending(nestedItems, 'x')

E retorna este resultado:

{
  'nestedItems': [
    {'x': 3},
    {'x': 2},
    {'x': 1}
  ]
}

split

Retorna uma matriz que contém substrings separadas por vírgulas com base no caractere delimitador especificado na cadeia de caracteres original.

split('<text>', '<delimiter>'?)

Parâmetro	Obrigatório	Type	Descrição
<text>	Sim	string	A cadeia de caracteres para separar em substrings com base no delimitador especificado na cadeia de caracteres original. Se o texto for um valor nulo, ele será considerado uma cadeia de caracteres vazia.
<delimiter>	Não	string	O caractere na cadeia de caracteres original para usar como delimitador. Se o delimitador não for fornecido ou se ele for um valor nulo, o valor padrão será uma cadeia de caracteres vazia.

Valor retornado	Type	Descrição
[<subcadeia-de-caracteres1>,<subcadeia-de-caracteres2>,...]	matriz	Uma matriz contendo subcadeias de caracteres da cadeia de caracteres original, separadas por vírgulas

Exemplos

Estes exemplos criam uma matriz com substrings da cadeia de caracteres especificada com base no caractere delimitador especificado:

split('a**b**c', '**')
split('hello', '')
split('', 'e')
split('', '')
split('hello')

E retornam as seguintes matrizes como resultados, respectivamente:

• ["a", "b", "c"]
• ["h", "e", "l", "l", "o"]
• [""], [ ]
• ["h", "e", "l", "l", "o"]

sqrt

Retornar a raiz quadrada de um número especificado.

sqrt(<number>)

Parâmetro	Obrigatório	Type	Descrição
<number>	Sim	número	Número para obter a raiz quadrada de

Valor retornado	Type	Description
<result>	número	O resultado do cálculo da raiz quadrada.

Exemplos

Estes exemplos calculam a raiz quadrada de números especificados:

sqrt(9)
sqrt(0)

E retornam os seguintes resultados, respectivamente:

• 3
• 0

startOfDay

Retornar o início do dia para um carimbo de data/hora em um formato de localidade opcional.

startOfDay('<timestamp>', '<format>'?, '<locale>'?)

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	string	Uma cadeia de caracteres que contém o carimbo de data/hora
<format>	Não	string	Um padrão de formato personalizado. O formato padrão do carimbo de data/hora é o UTC ISO, AAAA-MM-DDTHH:mm:ss.fffZ, compatível com a ISO 8601.
<locale>	Não	string	Um local de informações de cultura opcional

Valor retornado	Type	Descrição
'<updated-timestamp>'	string	O carimbo de data/hora especificado começando na marca de zero hora para o dia

Exemplo 1

Este exemplo localiza o início do dia:

startOfDay('2018-03-15T13:30:30.000Z')

E retorna o resultado 2018-03-15T00:00:00.000Z.

Exemplo 2

Este exemplo localiza o início do dia com a localidade fr-FR:

startOfDay('2018-03-15T13:30:30.000Z', '', 'fr-FR')

E retorna o resultado 15/03/2018 00:00:00.

startOfHour

Retornar o início da hora para um carimbo de data/hora em um formato de localidade opcional.

startOfHour('<timestamp>', '<format>'?, '<locale>'?)

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	string	Uma cadeia de caracteres que contém o carimbo de data/hora
<format>	Não	string	Um padrão de formato personalizado. O formato padrão do carimbo de data/hora é o UTC ISO, AAAA-MM-DDTHH:mm:ss.fffZ, compatível com a ISO 8601.
<locale>	Não	string	Um local de informações de cultura opcional

Valor retornado	Type	Descrição
'<updated-timestamp>'	string	O carimbo de data/hora especificado começando na marca de zero minuto para o dia

Exemplo 1

Este exemplo localiza o início da hora:

startOfHour('2018-03-15T13:30:30.000Z')

E retorna o resultado 2018-03-15T13:00:00.000Z.

Exemplo 2

Este exemplo localiza o início da hora com a localidade fr-FR:

startOfHour('2018-03-15T13:30:30.000Z', '', 'fr-FR')

E retorna o resultado 15/03/2018 13:00:00.

startOfMonth

Retornar o início do mês de um carimbo de data/hora em um formato de localidade opcional.

startOfMonth('<timestamp>', '<format>'?, '<locale>'?)

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	string	Uma cadeia de caracteres que contém o carimbo de data/hora
<format>	Não	string	Um padrão de formato personalizado. O formato padrão do carimbo de data/hora é o UTC ISO, AAAA-MM-DDTHH:mm:ss.fffZ, compatível com a ISO 8601.
<locale>	Não	string	Um local de informações de cultura opcional

Valor retornado	Type	Descrição
'<updated-timestamp>'	string	O carimbo de data/hora especificado começando no primeiro dia do mês na marca de zero hora

Exemplo 1

Este exemplo localiza o início do mês:

startOfMonth('2018-03-15T13:30:30.000Z')

E retorna o resultado 2018-03-01T00:00:00.000Z.

Exemplo 2

Este exemplo localiza o início do mês com a localidade fr-FR:

startOfMonth('2018-03-15T13:30:30.000Z', '', 'fr-FR')

E retorna o resultado 01/03/2018 00:00:00.

startsWith

Verificar se uma cadeia de caracteres começa com uma subcadeia de caracteres específica. Retornar true se a substring for encontrada ou retornar false se não for encontrada. Essa função não diferencia maiúsculas de minúsculas.

startsWith('<text>', '<searchText>')

Parâmetro	Obrigatório	Type	Descrição
<text>	Sim	string	A cadeia de caracteres a ser verificada
<searchText>	Sim	string	A substring inicial a ser localizada

Valor retornado	Type	Descrição
true ou false	Booliano	Retornar true quando a substring inicial for localizada. Retornar false se não for encontrada

Exemplo 1

Este exemplo verifica se a cadeia de caracteres hello world começa com a cadeia de caracteres hello:

startsWith('hello world', 'hello')

E retorna o resultado true.

Exemplo 2

Este exemplo verifica se a cadeia de caracteres hello world começa com a cadeia de caracteres greeting:

startsWith('hello world', 'greeting')

E retorna o resultado false.

string

Retornar a versão da cadeia de caracteres de um valor em um formato de localidade opcional.

string(<value>, '<locale>'?)

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	qualquer	O valor a ser convertido
<locale>	Não	string	Um local de informações de cultura opcional

Valor retornado	Type	Descrição
<string-value>	string	A versão de cadeia de caracteres do valor especificado

Exemplo 1

Este exemplo cria uma versão de cadeia de caracteres para o número 10:

string(10)

E retorna o resultado da cadeia de caracteres 10.

Exemplo 2

Este exemplo cria uma cadeia de caracteres para o objeto JSON especificado e usa o caractere de barra invertida,\\, como o caractere de escape para o caractere de aspas duplas ".

string( { "name": "Sophie Owen" } )

E retorna o resultado { "name": "Sophie Owen" }

Exemplo 3

Este exemplo cria uma versão de cadeia de caracteres do número 10 em uma localidade específica:

string(100.1, 'fr-FR')
string(100.1, 'en-US')

E retorna as seguintes cadeias de caracteres, respectivamente:

• 100,1
• 100.1

stringOrValue

Envolve a interpolação de cadeia de caracteres para obter o valor real. Por exemplo, stringOrValue('${1}') retorna o número 1, enquanto stringOrValue('${1} item') retorna a cadeia de caracteres "item 1".

stringOrValue(<string>)

Parâmetro	Obrigatório	Type	Descrição
<cadeia de caracteres>	Sim	string	A cadeia de caracteres da qual obter o valor real.

Valor retornado	Type	Description
<result>	qualquer	O resultado de obter o valor real da cadeia de caracteres especificada.

Exemplos

Estes exemplos obtêm o valor real da cadeia de caracteres:

stringOrValue('${one}')
stringOrValue('${one} item')

E retornam os seguintes resultados, respectivamente:

• O número 1.0.
• O item 1 da cadeia de caracteres.

sub

Retornar o resultado da subtração do segundo número do primeiro.

sub(<minuend>, <subtrahend>)

Parâmetro	Obrigatório	Type	Descrição
<minuend>	Sim	número	O número do qual subtrair o subtraendo
<subtrahend>	Sim	número	O número a ser subtraído do minuendo

Valor retornado	Type	Description
<result>	número	O resultado da subtração do segundo número do primeiro

Exemplo

Esse exemplo subtrai o segundo número do primeiro:

sub(10.3, .3)

E retorna o resultado 10.

subArray

Retornar uma submatriz das posições inicial e final especificadas. Os valores de índice começam com o número 0.

subArray(<Array>, <startIndex>, <endIndex>)

Parâmetro	Obrigatório	Type	Descrição
<array>	Sim	matriz	A matriz da qual criar a submatriz
<startIndex>	Sim	Número inteiro	Um número positivo igual ou maior que 0 a ser usado como a posição inicial ou o valor do índice
<endIndex>	Sim	Número inteiro	Um número positivo igual ou maior que 0 a ser usado como a posição final ou o valor do índice

Valor retornado	Type	Descrição
<subarray-result>	matriz	Uma submatriz com o número especificado de itens, começando na posição de índice especificada na cadeia de caracteres de origem

Exemplo

Este exemplo cria uma submatriz a partir da matriz especificada:

subArray(createArray('H','e','l','l','o'), 2, 5)

E retorna o resultado ["l", "l", "o"].

substring

Retornar caracteres de uma cadeia de caracteres, começando na posição especificada ou índice. Os valores de índice começam com o número 0.

substring('<text>', <startIndex>, <length>)

Parâmetro	Obrigatório	Type	Descrição
<text>	Sim	string	A cadeia de caracteres da qual criar a substring
<startIndex>	Sim	Número inteiro	Um número positivo igual ou maior que 0 da submatriz a ser usado como a posição inicial ou o valor do índice
<length>	Sim	Número inteiro	Um número positivo de caracteres da submatriz na substring

Valor retornado	Type	Descrição
<substring-result>	string	Uma subcadeia de caracteres com o número de caracteres especificado, começando na posição de índice especificada na cadeia de caracteres de origem

Exemplo

Esse exemplo cria uma subcadeia de caracteres de cinco caracteres com base na cadeia de caracteres especificada, começando no valor de índice 6:

substring('hello world', 6, 5)

E retorna o resultado world.

subtractFromTime

Subtrair um número de unidades de tempo de um carimbo de data/hora em um formato de localidade opcional. Confira também getPastTime().

subtractFromTime('<timestamp>', <interval>, '<timeUnit>', '<format>'?, '<locale>'?)

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	string	Uma cadeia de caracteres que contém o carimbo de data/hora
<interval>	Sim	Número inteiro	O número de unidades de tempo especificadas a serem subtraídas
<timeUnit>	Sim	string	A unidade de tempo a ser usada com interval. As unidades possíveis são "Second", "Minute", "Hour", "Day", "Week", "Month" e "Year".
<format>	Não	string	Um padrão de formato personalizado. O formato padrão do carimbo de data/hora é o UTC ISO, AAAA-MM-DDTHH:mm:ss.fffZ, compatível com a ISO 8601.
<locale>	Não	string	Um local de informações de cultura opcional

Valor retornado	Type	Descrição
<updated-timestamp>	string	O carimbo de data/hora menos o número de unidades de tempo especificado

Exemplo 1

Este exemplo subtrai um dia do seguinte carimbo de data/hora:

subtractFromTime('2018-01-02T00:00.000Z', 1, 'Day')

E retorna o resultado 2018-01-01T00:00:00.000Z.

Exemplo 2

Este exemplo subtrai um dia de um carimbo de data/hora usando o formato D:

subtractFromTime('2018-01-02T00:00.000Z', 1, 'Day', 'D')

E retorna o resultado segunda-feira, 1º de janeiro de 2018.

Exemplo 3

Este exemplo subtrai 1 hora de um carimbo de data/hora na localidade de-DE:

subtractFromTime('2018-03-15T13:00:00.000Z', 1, 'Hour', '', 'de-DE')

E retorna o resultado 15.03.18 12:00:00.

Sum

Retornar o resultado da adição de números em uma lista.

sum([<list of numbers>])

Parâmetro	Obrigatório	Type	Descrição
[<list of numbers>]	Sim	matriz de números	Os números a serem adicionados

Valor retornado	Type	Descrição
<result-sum>	número	O resultado da adição dos números especificados

Exemplo

Esse exemplo adiciona os números especificados:

sum(createArray(1, 1.5))

E retorna o resultado 2,5.

take

Retornar itens do início de uma coleção.

take('<collection>', <count>)
take([<collection>], <count>)

Parâmetro	Obrigatório	Type	Descrição
<collection>	Sim	cadeia de caracteres ou matriz	A coleção cujos itens você deseja
<count>	Sim	Número inteiro	Um inteiro positivo para o número de itens que você deseja no início

Valor retornado	Type	Descrição
<subconjunto> ou [<subconjunto>]	String ou Array, respectivamente	Uma cadeia de caracteres ou matriz que tem o número de itens especificado extraído do início da coleção original

Exemplo

Esses exemplos obtêm o número de itens especificado no início destas coleções:

take('abcde', 3)
take(createArray(0, 1, 2, 3, 4), 3)

E retornam os seguintes resultados, respectivamente:

• abc
• [0, 1, 2]

ticks

Retornar o valor de propriedade ticks de um carimbo de data/hora especificado. Um tique é um intervalo de 100 nanossegundos.

ticks('<timestamp>')

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	string	A cadeia de caracteres de um carimbo de data/hora

Valor retornado	Type	Descrição
<ticks-number>	inteiro (bigint em JavaScript)	O número de tiques desde o carimbo de data/hora especificado

Exemplo

Este exemplo converte um carimbo de data/hora em sua propriedade ticks:

ticks('2018-01-01T08:00:00.000Z')

E retorna o resultado 636503904000000000.

ticksToDays

Converter um valor da propriedade ticks para o número de dias.

ticksToDays('ticks')

Parâmetro	Obrigatório	Type	Descrição
<ticks>	Sim	Número inteiro	O valor da propriedade ticks a ser convertida

Valor retornado	Type	Descrição
<Número de dias>	número	O número de dias convertidos do valor da propriedade ticks

Exemplo

Este exemplo converte um valor de propriedade ticks em um número de dias:

ticksToDays(2193385800000000)

E retorna o número 2538.64097222.

ticksToHours

Converter um valor da propriedade ticks para o número de horas.

ticksToHours('ticks')

Parâmetro	Obrigatório	Type	Descrição
<ticks>	Sim	Inteiro	O valor da propriedade ticks a ser convertida

Valor retornado	Type	Descrição
<number-of-hours>	número	O número de horas convertidas do valor da propriedade ticks

Exemplo

Este exemplo converte um valor de propriedade ticks em um número de horas:

ticksToHours(2193385800000000)

E retorna o número 60927.383333333331.

ticksToMinutes

Converter um valor da propriedade ticks para o número de minutos.

ticksToMinutes('ticks')

Parâmetro	Obrigatório	Type	Descrição
<ticks>	Sim	Número inteiro	O valor da propriedade ticks a ser convertida

Valor retornado	Type	Descrição
<number-of-minutes>	número	O número de minutos convertidos do valor da propriedade ticks

Exemplo

Este exemplo converte um valor de propriedade ticks em um número de minutos:

ticksToMinutes(2193385800000000)

E retorna o número 3655643.0185.

titleCase

Coloca a primeira letra de cada palavra em maiúscula em uma cadeia de caracteres em um formato local opcional.

titleCase('<text>', '<locale>'?)

Parâmetro	Obrigatório	Type	Descrição
<text>	Sim	string	A cadeia de caracteres original
<locale>	Não	string	Um local de informações de cultura opcional

Valor retornado	Type	Descrição
cadeia de caracteres de resultado	string	O resultado da capitalização de título

Exemplo 1

Estes exemplos colocam em maiúsculas a primeira letra de cada palavra em uma cadeia de caracteres:

titleCase('a')
titleCase('abc def')
titleCase('aBC dEF')

E retornam os seguintes resultados, respectivamente:

• A
• Abc Def
• Abc Def

Exemplo 2

Estes exemplos colocam em maiúscula a primeira letra em uma cadeia de caracteres no formato en-US:

titleCase('a', 'en-US')
titleCase('aBC dEF', 'en-US')

E retornam os seguintes resultados, respectivamente:

• A
• Abc Def

toLower

Retornar uma cadeia de caracteres em minúsculas em um formato de localidade opcional. Se um caractere na cadeia de caracteres não tiver uma versão em minúsculas, esse caractere permanecerá inalterado na cadeia de caracteres retornada.

toLower('<text>', '<locale>'?)

Parâmetro	Obrigatório	Type	Descrição
<text>	Sim	string	A cadeia de caracteres a ser retornada no formato em minúsculas
<locale>	Não	string	Um local de informações de cultura opcional

Valor retornado	Type	Descrição
<lowercase-text>	string	A cadeia de caracteres original no formato em minúsculas

Exemplo 1

Este exemplo converte uma cadeia de caracteres em minúsculas:

toLower('Hello World')

E retorna o resultado hello world.

Exemplo 2

Este exemplo converte em minúsculas uma cadeia de caracteres no formato fr-FR:

toUpper('Hello World', 'fr-FR')

E retorna o resultado hello world.

toUpper

Retornar uma cadeia de caracteres em maiúsculas em um formato de localidade opcional. Se um caractere na cadeia de caracteres não tiver uma versão em maiúsculas, esse caractere permanecerá inalterado na cadeia de caracteres retornada.

toUpper('<text>', '<locale>'?)

Parâmetro	Obrigatório	Type	Descrição
<text>	Sim	string	A cadeia de caracteres a ser retornada no formato em maiúsculas
<locale>	Não	string	Um local de informações de cultura opcional

Valor retornado	Type	Descrição
<uppercase-text>	string	A cadeia de caracteres original no formato em maiúsculas

Exemplo 1

Este exemplo converte uma cadeia de caracteres em maiúsculas:

toUpper('Hello World')

E retorna o resultado HELLO WORLD.

Exemplo 2

Este exemplo converte em maiúsculas uma cadeia de caracteres no formato fr-FR:

toUpper('Hello World', 'fr-FR')

E retorna o resultado HELLO WORLD.

cortar

Remover espaços em branco à esquerda e à direita de uma cadeia de caracteres e retornar a cadeia de caracteres atualizada.

trim('<text>')

Parâmetro	Obrigatório	Type	Descrição
<text>	Sim	string	A cadeia de caracteres que tem o espaço em branco à esquerda e à direita a ser removida

Valor retornado	Type	Descrição
<updatedText>	string	Uma versão atualizada da cadeia de caracteres original sem espaço em branco à esquerda ou à direita

Exemplo

Este exemplo remove o espaço em branco à esquerda e à direita da cadeia de caracteres " Hello World ":

trim(' Hello World  ')

E retorna o resultado aparado Hello World.

union

Retornar uma coleção que tem todos os itens das coleções especificadas. Para aparecer no resultado, um item pode ser exibido em qualquer coleção passada para essa função. Se um ou mais itens tiverem o mesmo nome, o último item com o nome será exibido neste resultado.

union('<collection1>', '<collection2>', ...)
union([<collection1>], [<collection2>], ...)

Parâmetro	Obrigatório	Type	Descrição
<colleção1>, <colleção2>, ...	Sim	matriz ou objeto, mas não ambos	As coleções das quais você deseja todos os itens

Valor retornado	Type	Descrição
<updatedCollection>	matriz ou objeto, respectivamente	Uma coleção com todos os itens das coleções especificadas. Nenhuma duplicata adicionada.

Exemplo

Este exemplo obtém todos os itens das seguintes coleções:

union(createArray(1, 2, 3), createArray(1, 2, 10, 101))

E retorna o resultado [1, 2, 3, 10, 101].

unique

Remover todas as duplicatas de uma matriz.

unique([<collection>])

Parâmetro	Obrigatório	Type	Descrição
<collection>	Sim	matriz	A coleção a ser modificada

Valor retornado	Type	Descrição
<new-collection>	matriz	Nova coleção com elementos duplicados removidos

Exemplo 1

Este exemplo remove os elementos duplicados da seguinte matriz:

unique(createArray(1, 2, 1))

E retorna o resultado [1, 2].

uriComponent

Retornar a versão binária de um componente URI (Uniform Resource Identifier).

uriComponent('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	string	A cadeia de caracteres a ser convertida em um formato codificado para URI

Valor retornado	Type	Descrição
<encoded-uri>	string	A cadeia de caracteres codificada para URI com caracteres de escape

Exemplo

Este exemplo cria uma versão codificada para URI de uma cadeia de caracteres:

uriComponent('https://contoso.com')

E retorna o resultado http%3A%2F%2Fcontoso.com.

uriComponentToString

Retornar a versão de cadeia de caracteres de uma cadeia de caracteres codificada para URI (Uniform Resource Identifier), decodificando com eficácia a cadeia de caracteres codificada para URI.

uriComponentToString('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	string	A cadeia de caracteres codificada para URI a ser decodificada

Valor retornado	Type	Descrição
<binary-for-encoded-uri>	string	A versão decodificada para a cadeia de caracteres codificada para URI

Exemplo

Este exemplo cria a versão de cadeia de caracteres decodificada de uma cadeia de caracteres codificada para URI:

uriComponentToString('http%3A%2F%2Fcontoso.com')

E retorna o resultado https://contoso.com.

uriHost

Retornar o valor de host de um URI (Uniform Resource Identifier).

uriHost('<uri>')

Parâmetro	Obrigatório	Type	Descrição
<uri>	Sim	string	O URI cujo valor de host você deseja

Valor retornado	Type	Descrição
<host-value>	string	O valor de host do URI especificado

Exemplo

Este exemplo localiza o valor de host do seguinte URI:

uriHost('https://www.localhost.com:8080')

E retorna o resultado www.localhost.com.

uriPath

Retornar o valor de caminho de um URI (Uniform Resource Identifier).

uriPath('<uri>')

Parâmetro	Obrigatório	Type	Descrição
<uri>	Sim	string	O URI cujo valor de caminho você deseja

Valor retornado	Type	Descrição
<path-value>	string	O valor de caminho do URI especificado

Exemplo

Este exemplo localiza o valor de caminho do seguinte URI:

uriPath('http://www.contoso.com/catalog/shownew.htm?date=today')

E retorna o resultado /catalog/shownew.htm.

uriPathAndQuery

Retornar o valor de caminho e consulta de um URI (Uniform Resource Identifier).

uriPathAndQuery('<uri>')

Parâmetro	Obrigatório	Type	Descrição
<uri>	Sim	string	O URI cujo valor de caminho e consulta você deseja

Valor retornado	Type	Descrição
<path-query-value>	string	O valor de caminho e consulta do URI especificado

Exemplo

Este exemplo localiza o valor de caminho e consulta do seguinte URI:

uriPathAndQuery('http://www.contoso.com/catalog/shownew.htm?date=today')

E retorna o resultado /catalog/shownew.htm?date=today.

uriPort

Retornar o valor de porta de um URI (Uniform Resource Identifier).

uriPort('<uri>')

Parâmetro	Obrigatório	Type	Descrição
<uri>	Sim	string	O URI cujo valor de caminho você deseja

Valor retornado	Type	Descrição
<port-value>	string	O valor de porta do URI especificado

Exemplo

Este exemplo localiza o valor de porta do seguinte URI:

uriPort('http://www.localhost:8080')

E retorna o resultado 8080.

uriQuery

Retornar o valor de consulta de um URI (Uniform Resource Identifier).

uriQuery('<uri>')

Parâmetro	Obrigatório	Type	Descrição
<uri>	Sim	string	O URI cujo valor de consulta você deseja

Valor retornado	Type	Descrição
<query-value>	string	O valor de consulta do URI especificado

Exemplo

Este exemplo localiza o valor de consulta do seguinte URI:

uriQuery('http://www.contoso.com/catalog/shownew.htm?date=today')

E retorna o resultado ?date=today.

uriScheme

Retornar o valor de esquema de um URI (Uniform Resource Identifier).

uriScheme('<uri>')

Parâmetro	Obrigatório	Type	Descrição
<uri>	Sim	string	O URI cujo valor de consulta você deseja

Valor retornado	Type	Descrição
<scheme-value>	string	O valor de esquema do URI especificado

Exemplo

Este exemplo localiza o valor de esquema do seguinte URI:

uriQuery('http://www.contoso.com/catalog/shownew.htm?date=today')

E retorna o resultado http.

utcNow

Retornar o carimbo de data/hora atual em um formato de localidade opcional como uma cadeia de caracteres.

utcNow('<format>', '<locale>'?)

Opcionalmente, é possível especificar um formato diferente com o parâmetro <formato>.

Parâmetro	Obrigatório	Type	Descrição
<format>	Não	string	Um padrão de formato personalizado. O formato padrão do carimbo de data/hora é o UTC ISO, AAAA-MM-DDTHH:mm:ss.fffZ, compatível com a ISO 8601.
<locale>	Não	string	Um local de informações de cultura opcional

Valor retornado	Type	Descrição
<current-timestamp>	string	A data e hora atual

Exemplo 1

Suponha que a data seja April 15, 2018 às 1:00:00 PM. Este exemplo obtém o carimbo de data/hora:

utcNow()

E retorna o resultado 2018-04-15T13:00:00.000Z.

Exemplo 2

Suponha que a data seja April 15, 2018 às 1:00:00 PM. Este exemplo obtém o carimbo de data/hora atual usando o formato D opcional:

utcNow('D')

E retorna o resultado Sunday, April 15, 2018.

Exemplo 3

Suponha que a data seja April 15, 2018 às 1:00:00 PM. Este exemplo obtém o carimbo de data/hora atual usando a localidade de-DE:

utcNow('', 'de-DE')

E retorna o resultado 15.04.18 13:00:00.

where

Filtrar em cada elemento e retornar a nova coleção de elementos filtrados que correspondem a uma condição específica.

where([<collection/instance>], <iteratorName>, <function>)

Parâmetro	Obrigatório	Type	Descrição
<collection/instance>	Sim	matriz	A coleção com os itens
<iteratorName>	Sim	Nome do iterador	O item chave
<function>	Sim	expressão	Função Condition usada para filtrar itens

Valor retornado	Type	Descrição
<new-collection/new-object>	matriz/objeto	A nova coleção na qual cada elemento foi filtrado com a função

Exemplo 1

Este exemplo gera uma nova coleção:

where(createArray(0, 1, 2, 3), x, x > 1)

E retorna o resultado [2, 3].

Exemplo 2

Estes exemplos geram uma nova coleção:

where(json("{'name': 'jack', 'age': '15'}"), x, x.value == 'jack')
where(json("{'name': 'jack', 'age': '15'}"), x=> x.value == 'jack')

E retorna o resultado ['name:jack', 'age:15']. Observe que a segunda expressão é uma expressão lambda, que alguns acham mais legível.

xml

Retornar a versão XML de uma cadeia de caracteres que contém um objeto JSON.

xml('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	string	A cadeia de caracteres com o objeto JSON a ser convertido. O objeto JSON deve ter apenas uma propriedade raiz, que não pode ser uma matriz. Use \ como um caractere de escape para aspas duplas (").

Valor retornado	Type	Descrição
<xml-version>	objeto	O XML codificado para a cadeia de caracteres ou objeto JSON especificado

Exemplo 1

Este exemplo cria a versão XML para uma cadeia de caracteres, que contém um objeto JSON:

xml(json('{ \"name\": \"Sophia Owen\" }'))

E retorna o resultado XML:

<name>Sophia Owen</name>

Exemplo 2

Suponha que você tenha um objeto JSON person, visto abaixo:

{
  "person": {
    "name": "Sophia Owen",
    "city": "Seattle"
  }
}

Este exemplo cria o XML para uma cadeia de caracteres que contém esse objeto JSON:

xml(json('{\"person\": {\"name\": \"Sophia Owen\", \"city\": \"Seattle\"}}'))

E retorna o resultado XML:

<person>
  <name>Sophia Owen</name>
  <city>Seattle</city>
<person

xPath

Verificar o XML em busca de nós ou valores correspondentes a uma expressão XPath (Linguagem XPath) e retornar esses nós ou valores. Uma expressão XPath (conhecida como XPath), ajuda você a navegar por uma estrutura de documento XML para poder selecionar nós ou calcular valores no conteúdo XML.

xPath('<xml>', '<xpath>')

Parâmetro	Obrigatório	Type	Descrição
<xml>	Sim	qualquer	A cadeia de caracteres XML na qual pesquisar nós ou valores correspondentes a um valor de expressão XPath
<xPath>	Sim	qualquer	A expressão XPath usada para localizar valores ou nós XML correspondentes

Valor retornado	Type	Descrição
<xml-node>	XML	Um nó XML quando um único nó corresponde à expressão XPath especificada
<value>	qualquer	O valor de um nó XML quando apenas um único valor corresponde à expressão XPath especificada
<[<nó-xml1>, <nó-xml2>, ...] -ou- [<valor1>, <valor2>, ...]>	matriz	Uma matriz com valores ou nós XML correspondentes à expressão XPath especificada

Exemplo 1

Esse exemplo localiza nós correspondentes ao nó <name></name> nos argumentos especificados e retorna uma matriz com estes valores de nós:

xPath(items, '/produce/item/name')

Os argumentos incluem a cadeia de caracteres items, que contém esse XML:

"<?xml version="1.0"?> <produce> <item> <name>Gala</name> <type>apple</type> <count>20</count> </item> <item> <name>Honeycrisp</name> <type>apple</type> <count>10</count> </item> </produce>"

Confira a matriz de resultado com os nós correspondentes a <name></name>:

[ <name>Gala</name>, <name>Honeycrisp</name> ]

Exemplo 2

Seguindo o exemplo 1, este exemplo localiza nós correspondentes ao nó <count></count> e adiciona esses valores de nó com a função sum():

xPath(xml(parameters('items')), 'sum(/produce/item/count)')

E retorna o resultado 30.

ano

Retornar o ano do carimbo de data/hora especificado.

year('<timestamp>')

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	string	Uma cadeia de caracteres que contém o carimbo de data/hora

Valor retornado	Type	Descrição
<year>	Número inteiro	O ano no carimbo de data/hora especificado

Exemplo

Este exemplo avalia o carimbo de data/hora do ano:

year('2018-03-15T00:00:00.000Z')

E retorna o resultado 2018.