Démarrage

Installez la CLI, élaborez un projet de fonction JavaScript ou TypeScript et exécutez votre première fonction localement.

Cette page vous guide à travers l’installation de la CLI, l’élaboration d’un projet et l’exécution locale de votre première fonction JavaScript.

Prérequis

• Node.js 20 ou version ultérieure.
• La CLI uip avec l'outil Fonctions:

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

• Un compte UiPath avec accès à Orchestrator, pour la publication et l’invocation.

Élaborer un projet

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

TypeScript est la valeur par défaut; saisissez -l js pour JavaScript, ou --empty pour ignorer l'exemple de fonction.

L'élaboration du processus crée:

Fichier	Objectif
functions/hello.ts	Votre logique de fonction — une fonction par fichier. Démarre en tant qu’exemple exécutable.
functions/_*.ts	Assistants partagés. Un trait de soulignement de début marque un fichier comme un outil d’aide, de sorte qu’il n’a aucun point d’entrée et aucun déclencheur.
uipath.json	Associe les noms de fonction à leurs points d'entrée.
package.json, tsconfig.json	Fichiers de projet standard.

Écrivez votre première fonction

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>() dérive le schéma JSON de votre interface TypeScript, de sorte que le même type déclare le contrat et saisit le gestionnaire. Dans les projets JavaScript, transmettez plutôt un objet Schéma JSON.

Les valeurs method et path rendent cette fonction appelable via HTTP. Omettez les deux pour qu'elle ne s'exécute qu'en tant que tâche. Consultez Création de fonctions JavaScript.

L’exécuter localement

uip function serve

Un serveur de rechargement automatique démarre sur http://localhost:7070. Appelez la fonction:

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

Pour accéder à Orchestrator à partir d'une exécution locale, placez UIPATH_ACCESS_TOKEN, UIPATH_BASE_URL, UIPATH_ORG_ID et UIPATH_TENANT_ID dans un fichier .env à la racine du projet. serve le charge sur les deux runtimes pris en charge.

Prochaines étapes

• Construire des fonctions JavaScript — les contrats, les erreurs et les deux formes de fonctions.
• Déclencheurs et routage HTTP — routage, paramètres de chemin et appel d'une fonction déployée.
• Empaquetage et publication — déployer dans Orchestrator.
• Référence CLI — chaque commande et indicateur.