Introdução

Instale a CLI, estruture um projeto de função JavaScript ou TypeScript e execute sua primeira função localmente.

Esta página orienta você pela instalação da CLI, estruturando um projeto e executando sua primeira função JavaScript localmente.

Pré-requisitos

• Node.js 20 ou posterior.
• A CLI uip com a ferramenta de funções:

npm install -g @uipath/cli
uip tools install @uipath/function-tool

• Uma conta da UiPath com acesso ao Orchestrator, para publicação e invocação.

Estruturar um projeto

uip function new my-functions -l ts
cd my-functions

TypeScript é o padrão; passe -l js para JavaScript ou --empty para ignorar a função de exemplo.

O framework cria:

de transações	Finalidade
functions/hello.ts	Sua lógica de função — uma função por arquivo. Inicia como um exemplo executável.
functions/_*.ts	Ajudantes compartilhados. Um sublinhado à esquerda marca um arquivo como auxiliar, portanto, ele não recebe nenhum ponto de entrada nem gatilho.
uipath.json	Mapeia nomes de funções para seus pontos de entrada.
package.json, tsconfig.json	Arquivos de projeto padrão.

Escreva sua primeira função

import { defineFunction, defineSchema } from "@uipath/coded-functions-js-sdk";

interface HelloInput {
  name: string;
}

interface HelloOutput {
  message: string;
}

export default defineFunction({
  name: "hello",
  method: "POST",
  path: "/hello",
  input: defineSchema<HelloInput>(),
  output: defineSchema<HelloOutput>(),
  handler: async (input) => ({ message: `Hello, ${input.name}!` }),
});

defineSchema<T>() deriva o Esquema JSON da sua interface TypeScript, então o mesmo tipo declara o contrato e digita o manipulador. Em projetos JavaScript, passe um objeto Esquema JSON.

O method e path tornam essa função chamável por HTTP. Omita ambos e ele será executado apenas como um trabalho — consulte Criação de funções JavaScript.

Executar localmente

uip function serve

Isso inicia um servidor de recarregamento dinâmico em http://localhost:7070. Chame a função:

curl -X POST http://localhost:7070/hello \
  -H "Content-Type: application/json" \
  -d '{"name":"Alice"}'
# {"message":"Hello, Alice!"}

Para alcançar o Orchestrator a partir de uma execução local, coloque UIPATH_ACCESS_TOKEN, UIPATH_BASE_URL, UIPATH_ORG_ID e UIPATH_TENANT_ID em um arquivo .env na raiz do projeto. serve o carrega em ambos os runtimes compatíveis.

Próximas Etapas

• Criação de funções JavaScript — contratos, erros e as duas formas de função.
• Gatilhos HTTP e roteamento — rotas, parâmetros de caminho e chamada de uma função implantada.
• Pacotes e publicação — implante no Orchestrator.
• Referência da CLI — cada comando e sinalizador.