- __type__
__error__
Ce module ne peut pas être installé car il inclut un
type de noeud qui a déjà été installé
Conflits avec __module__
Échec du chargement du catalogue de noeuds.
Vérifier la console du navigateur pour plus d'informations
", + "installFailed": "Échec lors de l'installation : __module__
__message__
Consulter le journal pour plus d'informations
", + "removeFailed": "Échec lors de la suppression : __module__
__message__
Consulter le journal pour plus d'informations
", + "updateFailed": "Échec lors de la mise à jour : __module__
__message__
Consulter le journal pour plus d'informations
", + "enableFailed": "Échec lors de l'activation : __module__
__message__
Consulter le journal pour plus d'informations
", + "disableFailed": "Échec lors de la désactivation : __module__
__message__
Consulter le journal pour plus d'informations
" + }, + "confirm": { + "install": { + "body": "Installation de '__module__'
Avant l'installation, veuiller lire la documentation du noeud. Certains noeuds ont des dépendances qui ne peuvent pas être résolues automatiquement et peuvent nécessiter un redémarrage de Node-RED.
", + "title": "Installer les noeuds" + }, + "remove": { + "body": "Suppression de '__module__'
La suppression du noeud le désinstallera de Node-RED. Le noeud peut continuer à utiliser des ressources jusqu'au redémarrage de Node-RED.
", + "title": "Supprimer les noeuds" + }, + "update": { + "body": "Mise à jour de '__module__'
La mise à jour du noeud nécessitera un redémarrage de Node-RED pour terminer la mise à jour. Cela doit être fait manuellement.
", + "title": "Mettre à jour les noeuds" + }, + "cannotUpdate": { + "body": "Une mise à jour pour ce noeud est disponible, mais il n'est pas installé dans un emplacement que le gestionnaire de palette peut mettre à jour.Veuiller vous référer à la documentation pour savoir comment mettre à jour ce noeud." + }, + "button": { + "review": "Ouvrir la documentation", + "install": "Installer", + "remove": "Supprimer", + "update": "Mettre à jour" + } + } + } + }, + "sidebar": { + "info": { + "name": "Information", + "tabName": "Nom", + "label": "info", + "node": "Noeud", + "type": "Type", + "group": "Groupe", + "module": "Module", + "id": "ID (identifiant)", + "status": "Statut", + "enabled": "Activé", + "disabled": "Désactivé", + "subflow": "Sous-flux", + "instances": "Instances", + "properties": "Propriétés", + "info": "Information", + "desc": "Description", + "blank": "vide", + "null": "nul", + "showMore": "afficher en plus", + "showLess": "afficher en moins", + "flow": "Flux", + "selection": "Sélection", + "nodes": "__count__ noeuds", + "flowDesc": "Description du flux", + "subflowDesc": "Description du sous-flux", + "nodeHelp": "Aide sur les noeuds", + "none": "Aucun", + "arrayItems": "__count__ éléments", + "showTips": "Vous pouvez ouvrir les astuces à partir du panneau des paramètres", + "outline": "Plan", + "empty": "vide", + "globalConfig": "Noeuds de configuration globale", + "triggerAction": "Déclencher une action", + "find": "Rechercher dans l'espace de travail", + "copyItemUrl": "Copier l'URL de l'élément", + "copyURL2Clipboard": "URL copiée dans le presse-papiers", + "showFlow": "Afficher", + "hideFlow": "Masquer" + }, + "help": { + "name": "Aide", + "label": "aide", + "search": "Aide à la recherche", + "nodeHelp": "Aide sur les noeuds", + "showHelp": "Afficher l'aide", + "showInOutline": "Afficher dans les grandes lignes", + "showTopics": "Afficher les sujets", + "noHelp": "Aucune rubrique d'aide sélectionnée", + "changeLog": "Journal des modifications" + }, + "config": { + "name": "Noeuds de configuration", + "label": "configuration", + "global": "Tous les flux", + "none": "aucun", + "subflows": "sous-flux", + "flows": "flux", + "filterAll": "tout", + "showAllConfigNodes": "Afficher tous les noeuds de configuration", + "filterUnused": "inutilisé", + "showAllUnusedConfigNodes": "Afficher tous les noeuds de configuration inutilisés", + "filtered": "__count__ caché(s)" + }, + "context": { + "name": "Données contextuelles", + "label": "contexte", + "none": "aucune sélection", + "refresh": "actualiser pour charger", + "empty": "vide", + "node": "Noeud", + "flow": "Flux", + "global": "Global", + "deleteConfirm": "Êtes-vous sûr de vouloir supprimer cet élément ?", + "autoRefresh": "Rafraîchir si la sélection change", + "refrsh": "Rafraîchir", + "delete": "Supprimer" + }, + "palette": { + "name": "Gestion des palettes", + "label": "palette" + }, + "project": { + "label": "projet", + "name": "Projet", + "description": "Description", + "dependencies": "Dépendances", + "settings": "Paramètres", + "noSummaryAvailable": "Aucun résumé disponible", + "editDescription": "Modifier la description du projet", + "editDependencies": "Modifier les dépendances du projet", + "noDescriptionAvailable": "Pas de description disponible", + "editReadme": "Modifier le fichier README.md", + "showProjectSettings": "Afficher les paramètres du projet", + "projectSettings": { + "title": "Paramètres du projet", + "edit": "modifier", + "none": "Vide", + "install": "installer", + "removeFromProject": "supprimer du projet", + "addToProject": "ajouter au projet", + "files": "Fichiers", + "flow": "Flux", + "credentials": "Identifiants", + "package": "Paquets", + "packageCreate": "Le fichier sera créé lorsque les modifications seront enregistrées", + "fileNotExist": "Le fichier n'existe pas", + "selectFile": "Choisir le dossier", + "invalidEncryptionKey": "Clé de chiffrement invalide", + "encryptionEnabled": "Chiffrement activé", + "encryptionDisabled": "Chiffrement désactivé", + "setTheEncryptionKey": "Définir la clé de chiffrement", + "resetTheEncryptionKey": "Réinitialiser la clé de chiffrement", + "changeTheEncryptionKey": "Changer la clé de chiffrement", + "currentKey": "Clé actuelle", + "newKey": "Nouvelle clé", + "credentialsAlert": "Cela supprimera tous les identifiants existants", + "versionControl": "Contrôle de version", + "branches": "Branches", + "noBranches": "Pas de branche", + "deleteConfirm": "Êtes-vous sûr de vouloir supprimer la branche locale '__name__' ? Ça ne peut pas être annulé.", + "unmergedConfirm": "La branche locale '__name__' contient des modifications non fusionnées qui seront perdues. Etes-vous sûr de vouloir la supprimer?", + "deleteUnmergedBranch": "Supprimer la branche non fusionnée", + "gitRemotes": "Git distant", + "addRemote": "Ajout distant", + "addRemote2": "Ajout distant", + "remoteName": "Nom distant", + "nameRule": "Doit contenir uniquement A-Z 0-9 _ -", + "url": "URL", + "urlRule": "https://, ssh:// ou file://", + "urlRule2": "Ne pas inclure le nom d'utilisateur/mot de passe dans l'URL", + "noRemotes": "Pas distant", + "deleteRemoteConfrim": "Êtes-vous sûr de vouloir supprimer '__name__' distant ?", + "deleteRemote": "Supprimer distant" + }, + "userSettings": { + "committerDetail": "Détails de l'auteur de la validation (commit)", + "committerTip": "Laisser vide pour utiliser la valeur par défaut du système", + "userName": "Nom d'utilisateur", + "email": "e-mail", + "workflow": "Flux de travail", + "workfowTip": "Choisisser votre flux de travail Git préféré", + "workflowManual": "Manuel", + "workflowManualTip": "Toutes les modifications doivent être validées manuellement dans la barre latérale 'historique'", + "workflowAuto": "Automatique", + "workflowAutoTip": "Les modifications sont validées automatiquement à chaque déploiement", + "sshKeys": "Clés SSH", + "sshKeysTip": "Vous permet de créer des connexions sécurisées aux référentiels Git distants.", + "add": "ajouter une clé", + "addSshKey": "Ajouter une clé SSH", + "addSshKeyTip": "Générer une nouvelle paire de clés publique/privée", + "name": "Nom", + "nameRule": "Doit contenir uniquement A-Z 0-9 _ -", + "passphrase": "Phrase de mot de passe", + "passphraseShort": "Phrase de mot de passe trop courte", + "optional": "Facultatif", + "cancel": "Annuler", + "generate": "Générer une clé", + "noSshKeys": "Pas de clé SSH", + "copyPublicKey": "Copier la clé publique dans le presse-papiers", + "delete": "Supprimer une clé", + "gitConfig": "Configuration Git", + "deleteConfirm": "Êtes-vous sûr de vouloir supprimer la clé SSH __nom__ ? Ça ne peut pas être annulé." + }, + "versionControl": { + "unstagedChanges": "Abandon des changements", + "stagedChanges": "Changement mis en place", + "unstageChange": "Ne pas mettre en place le changement", + "stageChange": "Mettre en place le changement", + "unstageAllChange": "Ne pas mettre en place tous les changements", + "stageAllChange": "Mettre en place tous les changements", + "commitChanges": "Valider les changements", + "resolveConflicts": "Résoudre les conflits", + "head": "En-tête", + "staged": "Mis en place", + "unstaged": "Non mis en place", + "local": "Local", + "remote": "Distant", + "revert": "Voulez-vous vraiment annuler les modifications apportées à '__file__' ? Ça ne peut pas être annulé.", + "revertChanges": "Rétablir les changements", + "localChanges": "Modifications locales", + "none": "Vide", + "conflictResolve": "Tous les conflits ont été résolus. Valider les modifications pour terminer la fusion.", + "localFiles": "Fichiers locaux", + "all": "tout", + "unmergedChanges": "Modifications non fusionnées", + "abortMerge": "Abandonner la fusion", + "commit": "Valider", + "changeToCommit": "Modifications à valider", + "commitPlaceholder": "Entrer votre message de validation", + "cancelCapital": "Annuler", + "commitCapital": "Valider", + "commitHistory": "Historique des validations", + "branch": "Branche :", + "moreCommits": "Davantage de validations", + "changeLocalBranch": "Changer de branche locale", + "createBranchPlaceholder": "Trouver où créer une branche", + "upstream": "en amont", + "localOverwrite": "Vous avez des modifications locales qui seraient écrasées en changeant la branche. Vous devez d'abord valider ou annuler ces modifications.", + "manageRemoteBranch": "Gérer une branche distante", + "unableToAccess": "Impossible d'accéder au référentiel distant", + "retry": "Recommencer", + "setUpstreamBranch": "Définir comme branche en amont", + "createRemoteBranchPlaceholder": "Trouver ou créer une branche distante", + "trackedUpstreamBranch": "La branche créée sera définie comme la branche en amont suivie.", + "selectUpstreamBranch": "La branche sera créée. Sélectionner ci-dessous pour la définir comme branche en amont suivie.", + "pushFailed": "L'envoi a échoué car la branche a des validations plus récentes. Tirer et fusionner d'abord, puis envoyer à nouveau.", + "push": "Envoyer", + "pull": "Tirer", + "unablePull": "
Impossible d'extraire les modifications à distance ; vos modifications locales non mises en place seraient écrasées.
Valider vos modifications et réessayer.
", + "showUnstagedChanges": "Afficher les modifications non mise en place", + "connectionFailed": "Impossible de se connecter au référentiel distant: ", + "pullUnrelatedHistory": "Le réferentiel distant a un historique de validations sans rapport.
Êtes-vous sûr de vouloir extraire les modifications dans votre référentiel local ?
", + "pullChanges": "Tirer les changements", + "history": "Historique", + "projectHistory": "Historique du projet", + "daysAgo": "il y a __count__ jour", + "daysAgo_plural": "il y a __count__ jours", + "hoursAgo": "il y a __count__ heure", + "hoursAgo_plural": "il y a __count__ heures", + "minsAgo": "il y a __count__ minute", + "minsAgo_plural": "il y a __count__ minutes", + "secondsAgo": "Il y a quelques instants", + "notTracking": "Votre branche locale ne suit pas actuellement une branche distante.", + "statusUnmergedChanged": "Votre référentiel contient des modifications non fusionnées. Vous devez résoudre les conflits et valider le résultat.", + "repositoryUpToDate": "Votre référentiel est à jour.", + "commitsAhead": "Votre référentiel a __count__ validation d'avance sur le référentiel distant. Vous pouvez pousser cette validation maintenant.", + "commitsAhead_plural": "Votre référentiel a __count__ validations d'avance sur le référentiel distant. Vous pouvez pousser ces validations maintenant.", + "commitsBehind": "Votre référentiel a __count__ validation de retard sur le référentiel distant. Vous pouvez pousser cette validation maintenant.", + "commitsBehind_plural": "Votre référentiel a __count__ validations de retard sur le référentiel distant. Vous pouvez pousser ces validations maintenant.", + "commitsAheadAndBehind1": "Votre référentiel a __count__ validation derrière et ", + "commitsAheadAndBehind1_plural": "Votre référentiel est __count__ validations derrière et ", + "commitsAheadAndBehind2": "__count__ validation avant le référentiel distant. ", + "validationsAheadAndBehind2_plural": "__count__ commits avant le référentiel distant. ", + "commitsAheadAndBehind3": "Vous devez retirer la validation à distance avant de pousser la modification.", + "commitsAheadAndBehind3_plural": "Vous devez retirer les validations à distance avant de pousser les modifications.", + "refreshCommitHistory": "Actualiser l'historique des validations", + "refreshChanges": "Actualiser les modifications" + } + } + }, + "typedInput": { + "type": { + "str": "chaîne de caractères", + "num": "nombre", + "re": "expression régulière", + "bool": "booléen", + "json": "JSON", + "bin": "tampon", + "date": "horodatage", + "jsonata": "expression", + "env": "variable d'environnement", + "cred": "identifiant" + } + }, + "editableList": { + "add": "Ajouter", + "addTitle": "Ajouter un élément" + }, + "search": { + "history": "Historique des recherches", + "clear": "Tout effacer", + "empty": "Aucun résultat", + "addNode": "Ajouter un noeud...", + "options": { + "configNodes": "Noeuds de configuration", + "unusedConfigNodes": "Noeuds de configuration inutilisés", + "invalidNodes": "Noeuds invalides", + "uknownNodes": "Noeuds inconnus", + "unusedSubflows": "Sous-flux inutilisés", + "hiddenFlows": "Flux cachés", + "modifiedNodes": "Noeuds et flux modifiés", + "thisFlow": "Flux courant" + } + }, + "expressionEditor": { + "functions": "Fonctions", + "functionReference": "Fonction de référence", + "insert": "Insérer", + "title": "Éditeur d'expressions JSONata", + "test": "Test", + "data": "Exemple de message", + "result": "Résultat", + "format": "Format", + "compatMode": "Mode de compatibilité activé", + "compatModeDesc": "Mode de compatibilité JSONata
L'expression actuelle semble toujours faire référence à msg et sera donc évaluée en mode de compatibilité. Veuiller mettre à jour l'expression pour ne pas utiliser msg car ce mode sera supprimé à l'avenir.
Lorsque la prise en charge de JSONata a été ajoutée pour la première fois à Node-RED, il fallait que l'expression référencie l'objet msg. Par exemple, msg.payload serait utilisé pour accéder à la charge utile.
Cela n'est plus nécessaire car l'expression sera évaluée directement par rapport au message. Pour accéder à la charge utile, l'expression doit être simplement charge utile.
Éditeur de tampon
Le type de tampon est stocké sous la forme d'un tableau JSON de valeurs d'octets. L'éditeur tentera d'analyser la valeur saisie en tant que tableau JSON. S'il ne s'agit pas d'un JSON valide, il sera traité comme une chaîne UTF-8 et converti en un tableau de points de code de caractères individuels.
Par exemple, une valeur de Hello World sera converti en tableau JSON :
[72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100]" + }, + "projects": { + "config-git": "Configurer le client Git", + "welcome": { + "hello": "Bonjour! Nous avons introduit des 'projets' dans Node-RED.", + "desc0": "Il s'agit d'une nouvelle façon pour vous de gérer vos fichiers de flux, cela inclut le contrôle de version de vos flux.", + "desc1": "Pour commencer, vous pouvez créer votre premier projet ou cloner un projet existant à partir d'un référentiel git.", + "desc2": "Si vous n'êtes pas sûr, vous pouvez ignorer ceci pour le moment. Vous pourrez toujours créer votre premier projet à partir du menu 'Projets' à tout moment.", + "create": "Créer un projet", + "clone": "Cloner un référentiel", + "openExistingProject": "Ouvrir un projet existant", + "not-right-now": "Pas maintenant" + }, + "git-config": { + "setup": "Configurer votre version du client Git", + "desc0": "Node-RED utilise l'outil open source Git pour le contrôle de version. Il suit les modifications apportées à vos fichiers de projet et vous permet de les transférer vers des référentiels distants.", + "desc1": "Lorsque vous validez un ensemble de modifications, Git enregistre l'auteur qui a effectué les modifications avec un nom d'utilisateur et une adresse e-mail. Le nom d'utilisateur peut être ce que vous voulez - il n'est pas nécessaire que ce soit votre vrai nom.", + "desc2": "Votre client Git est déjà configuré avec les détails ci-dessous.", + "desc3": "Vous pouvez modifier ces paramètres ultérieurement sous l'onglet 'Configuration Git' de la boîte de dialogue des paramètres.", + "username": "Nom d'utilisateur", + "email": "e-mail" + }, + "project-details": { + "create": "Créer votre projet", + "desc0": "Un projet est maintenu en tant que référentiel Git. Il est beaucoup plus facile de partager vos flux et de collaborer avec les autres grâce à ce référentiel.", + "desc1": "Vous pouvez créer plusieurs projets et basculer rapidement entre eux depuis l'éditeur.", + "desc2": "Pour commencer, votre projet a besoin d'un nom et facultativement d'une description.", + "already-exists": "Le projet existe déjà", + "must-contain": "Doit contenir uniquement A-Z 0-9 _ -", + "project-name": "Nom du projet", + "desc": "Description", + "opt": "Facultatif" + }, + "clone-project": { + "clone": "Cloner un projet", + "desc0": "Si vous avez déjà un dépôt Git contenant un projet, vous pouvez le cloner pour commencer.", + "already-exists": "Le projet existe déjà", + "must-contain": "Doit contenir uniquement A-Z 0-9 _ -", + "project-name": "Nom du projet", + "no-info-in-url": "Ne pas inclure le nom d'utilisateur/mot de passe dans l'URL", + "git-url": "URL du dépôt Git", + "protocols": "https://, ssh:// ou file://", + "auth-failed": "L'authentification a échoué", + "username": "Nom d'utilisateur", + "passwd": "Mot de passe", + "ssh-key": "Clé SSH", + "passphrase": "Phrase de mot de passe", + "ssh-key-desc": "Avant de pouvoir cloner un référentiel avec ssh, vous devez ajouter une clé SSH pour y accéder.", + "ssh-key-add": "Ajouter une clé ssh", + "credential-key": "Clé de chiffrement des identifiants", + "cant-get-ssh-key": "Erreur! Impossible d'obtenir le chemin de la clé SSH sélectionnée.", + "already-exists2": "Existe déjà", + "git-error": "Erreur git", + "connection-failed": "La connexion a échoué", + "not-git-repo": "Ce n'est pas un dépôt Git", + "repo-not-found": "Référentiel introuvable" + }, + "default-files": { + "create": "Créer vos fichiers de projet", + "desc0": "Un projet contient vos fichiers de flux, un fichier README et un fichier package.json.", + "desc1": "Il peut contenir tous les autres fichiers que vous souhaitez conserver dans le référentiel Git.", + "desc2": "Vos fichiers de flux et identifiants existants seront copiés dans le projet.", + "flow-file": "Fichier de flux", + "credentials-file": "Fichier d'identifiants" + }, + "encryption-config": { + "setup": "Configuration du chiffrage de votre fichier d'informations d'identification", + "desc0": "Votre fichier d'informations d'identification de flux peut être chiffré pour sécuriser son contenu.", + "desc1": "Si vous souhaitez stocker ces identifiants dans un référentiel Git public, vous devez les chiffrer en fournissant une phrase clé secrète.", + "desc2": "Votre fichier d'identifiants de flux n'est actuellement pas chiffré.", + "desc3": "Cela signifie que son contenu, tel que les mots de passe et les jetons d'accès, peut être lu par toute personne ayant accès au fichier.", + "desc4": "Si vous souhaitez stocker ces identifiants dans un référentiel Git public, vous devez les chiffrer en fournissant une phrase clé secrète.", + "desc5": "Votre fichier contenant les identifiants de flux est actuellement chiffré à l'aide de la propriété credentialSecret de votre fichier de paramètres comme clé.", + "desc6": "Votre fichier contenant les identifiants de flux est actuellement chiffré à l'aide d'une clé générée par le système. Vous devez fournir une nouvelle clé secrète pour ce projet.", + "desc7": "La clé sera stockée séparément de vos fichiers de projet. Vous devrez fournir la clé pour utiliser ce projet dans une autre instance de Node-RED.", + "credentials": "Identifiants", + "enable": "Activer le chiffrement", + "disable": "Désactiver le chiffrement", + "disabled": "Désactivé", + "copy": "Remplacer la clé existante", + "use-custom": "Utiliser la clé personnalisée", + "desc8": "Le fichier contenant les identifiants ne sera pas crypté et son contenu sera facilement lisible", + "create-project-files": "Créer des fichiers de projet", + "create-project": "Créer un projet", + "already-exists": "existe déjà", + "git-error": "Erreur Git", + "git-auth-error": "erreur d'authentification Git" + }, + "create-success": { + "success": "Vous avez créé avec succès votre premier projet !", + "desc0": "Vous pouvez maintenant continuer à utiliser Node-RED comme vous l'avez toujours fait.", + "desc1": "L'onglet 'info' dans la barre latérale vous montre quel est votre projet actif actuel. Le bouton à côté du nom peut être utilisé pour accéder à la vue des paramètres du projet.", + "desc2": "L'onglet 'historique' dans la barre latérale peut être utilisé pour afficher les fichiers qui ont changé dans votre projet et pour les valider. Il vous montre un historique complet de vos validations (commits) et vous permet de pousser vos modifications vers un référentiel distant." + }, + "create": { + "projects": "Projets", + "already-exists": "Le projet existe déjà", + "must-contain": "Doit contenir uniquement A-Z 0-9 _ -", + "no-info-in-url": "Ne pas inclure le nom d'utilisateur/mot de passe dans l'URL", + "open": "Projet ouvert", + "create": "Créer un projet", + "clone": "Cloner un référentiel", + "project-name": "Nom du projet", + "desc": "Description", + "opt": "Facultatif", + "flow-file": "Fichier de flux", + "credentials": "Identifiants", + "enable-encryption": "Activer le chiffrement", + "disable-encryption": "Désactiver le chiffrement", + "encryption-key": "Clé de chiffrement", + "desc0": "Une phrase pour sécuriser vos identifiants", + "desc1": "Le fichier contenant les identifiants ne sera pas crypté et son contenu sera facilement lisible", + "git-url": "URL du dépôt Git", + "protocols": "https://, ssh:// ou file://", + "auth-failed": "L'authentification a échoué", + "username": "Nom d'utilisateur", + "password": "Mot de passe", + "ssh-key": "Clé SSH", + "passphrase": "Phrase de mot de passe", + "desc2": "Avant de pouvoir cloner un référentiel sur ssh, vous devez ajouter une clé SSH pour y accéder.", + "add-ssh-key": "Ajouter une clé ssh", + "credentials-encryption-key": "Clé de chiffrement des identifiants", + "already-exists-2": "existe déjà", + "git-error": "erreur git", + "con-failed": "La connexion a échoué", + "not-git": "Ce n'est pas un dépôt git", + "no-resource": "Référentiel introuvable", + "cant-get-ssh-key-path": "Erreur! Impossible d'obtenir le chemin de la clé SSH sélectionnée.", + "unexpected_error": "Erreur inattendue", + "clearContext": "Effacer le contexte lors du changement de projet" + }, + "delete": { + "confirm": "Voulez-vous vraiment supprimer ce projet ?" + }, + "create-project-list": { + "search": "rechercher vos projets", + "current": "actuel" + }, + "require-clean": { + "confirm": "
Vous avez des modifications non déployées qui seront perdues.
Voulez-vous continuer ?
" + }, + "send-req": { + "auth-req": "Authentification requise pour le référentiel", + "username": "Nom d'utilisateur", + "password": "Mot de passe", + "passphrase": "Phrase de mot de passe", + "retry": "Recommencer", + "update-failed": "La mise à jour a échoué", + "unhandled": "Code d'erreur non géré", + "host-key-verify-failed": "La vérification de la clé d'hôte a échoué.
La clé d'hôte du référentiel n'a pas pu être vérifiée. Veuillez mettre à jour votre fichier known_hosts et réessayer.
타입이 없는 노드로인해 플로우가 중지되었습니다
", + "missing-modules": "누락된 모듈로 인해 플로우가 중지되었습니다.
", "safe-mode": "[안전모드] 플로우가 정지되었습니다.
플로우의 수정과 배포가 가능합니다. 다시 배포버튼을 누르세요.
", "restartRequired": "업그레이드한 모듈을 유효화하기 위해 Node-RED를 재시작 합니다 ", "credentials_load_failed": "인증정보 복호화에 실패하여 플로우가 멈췄습니다.
인증정보는 암호화 되어있습니다. 프로젝트의 암호화 키가 깨졌거나 정상적이지 않습니다.
", @@ -132,7 +177,12 @@ "updated": "'__project__'가 변경 되었습니다", "pull": "'__project__'를 다시 가져왔습니다", "revert": "'__project__'를 취소했습니다", - "merge-complete": "Git 병합이 완료되었습니다" + "merge-complete": "Git 병합이 완료되었습니다", + "setupCredentials": "자격 증명 설정", + "setupProjectFiles": "프로젝트 파일 설정", + "no": "취소", + "createDefault": "기본 프로젝트 파일 만들기", + "mergeConflict": "병합 충돌 표시" }, "label": { "manage-project-dep": "프로젝트 의존성 관리", @@ -152,10 +202,14 @@ "node_plural": "__count__ 개의 노드", "configNode": "__count__ 개의 설정 노드", "configNode_plural": "__count__ 개의 설정 노드", + "group": "__count__ 개의 그룹", + "group_plural": "__count__ 개의 그룹", "flow": "__count__ 개의 플로우", "flow_plural": "__count__ 개의 플로우", "subflow": "__count__ 개의 서브 플로우", "subflow_plural": "__count__ 개의 서브 플로우", + "replacedNodes": "__count__ 개의 교체된 노드", + "replacedNodes_plural": "__count__ 개의 교체된 노드", "pasteNodes": "여기에 노드를 붙여넣기 하세요", "selectFile": "불러올 파일을 선택하세요", "importNodes": "노드 불러오기", @@ -163,28 +217,46 @@ "download": "다운로드", "importUnrecognised": "알 수 없는 형식 :", "importUnrecognised_plural": "알 수 없는 형식 :", + "importDuplicate": "가져온 중복 노드:", + "importDuplicate_plural": "가져온 중복 노드:", "nodesExported": "클립보드에 노드 내보내기", "nodesImported": "불러오기 : ", - "nodeCopied": "__count__개의 노드가 복사 되었습니다", - "nodeCopied_plural": "__count__개의 노드가 복사 되었습니다", + "nodeCopied": "__count__개의 노드가 복사되었습니다", + "nodeCopied_plural": "__count__개의 노드가 복사되었습니다", + "groupCopied": "__count__ 개의 그룹이 복사되었습니다", + "groupCopied_plural": "__count__ 개의 그룹이 복사되었습니다", + "groupStyleCopied": "그룹 스타일이 복사되었습니다", "invalidFlow": "정상적지 않은 플로우 : __message__", + "recoveredNodes": "복구된 노드", + "recoveredNodesInfo": "이 플로우의 노드를 가져올 때 유효한 플로우 ID가 누락되었습니다. 해당 플로우에 추가되었으므로 복원하거나 삭제할 수 있습니다.", + "recoveredNodesNotification": "유효하지 않은 플로우 ID를 가진 노드입니다.
'__flowName__' 라는 플로우에 추가되었습니다.
", "export": { "selected": "선택된 노드", "current": "현재 플로우", "all": "모든 플로우", "compact": "압축형식", "formatted": "서식유지", - "copy": "클립보드로 내보내기" + "copy": "클립보드로 내보내기", + "export": "라이브러리로 내보내기", + "exportAs": "내보내기", + "overwrite": "확인", + "exists": "\"__file__\" 이미 존재합니다.
교체하시겠습니까?
" }, "import": { "import": "가져올 위치 : ", + "importSelected": "선택 항목 가져오기", + "importCopy": "사본 가져오기", + "viewNodes": "노드 보기...", "newFlow": "새로운 플로우", + "replace": "교체", "errors": { "notArray": "입력이 JSON 배열이 아닙니다", "itemNotObject": "입력이 올바른 플로우가 아닙니다 - __index__는 노드 오브젝트가 아닙니다", "missingId": "입력이 올바른 플로우가 아닙니다 - __index__의 'id' 속성이 없습니다", "missingType": "입력이 올바른 플로우가 아닙니다 - __index__의 'type' 속성이 없습니다" - } + }, + "conflictNotification1": "가져오는 노드 중 일부가 이미 작업 공간에 있습니다..", + "conflictNotification2": "가져올 노드와 기존 노드를 바꿀지 아니면 복사본을 가져올지 선택합니다." }, "copyMessagePath": "Path가 복사 되었습니다", "copyMessageValue": "Value가 복사 되었습니다", @@ -198,6 +270,10 @@ "modifiedFlowsDesc": "변경사항이 있는 플로우만 배포합니다", "modifiedNodes": "변경된 노드", "modifiedNodesDesc": "변경사항이 있는 노드만 배포합니다", + "startFlows": "시작", + "startFlowsDesc": "플로우를 시작합니다", + "stopFlows": "중지", + "stopFlowsDesc": "플로우를 중지합니다", "restartFlows": "플로우 재시작", "restartFlowsDesc": "현재 배포된 플로우를 재시작합니다", "successfulDeploy": "배포가 성공했습니다", @@ -266,6 +342,7 @@ "newVersionError": "New Version의 JSON 형식이 올바르지 않습니다 :" }, "subflow": { + "editSubflowInstance": "서브 플로우 인스턴스 수정: __name__", "editSubflow": "플로우 템플릿 수정 : __name__", "edit": "플로우 템플릿 수정", "subflowInstances": "서브 플로우 템플릿에 __count__개의 인스턴스가 있습니다", @@ -273,14 +350,39 @@ "editSubflowProperties": "속성 수정", "input": "입력:", "output": "출력:", + "status": "상태 노드", "deleteSubflow": "서브 플로우 삭제", + "confirmDelete": "서브 플로우를 삭제하시겠습니까?", "info": "상세내역", "category": "카테고리", + "module": "모듈", + "license": "라이선스", + "licenseNone": "없음", + "licenseOther": "Other", + "type": "노드", + "version": "버전", + "versionPlaceholder": "x.y.z", + "keys": "키워드", + "keysPlaceholder": "키워드(쉼표로 구분)를 입력해주세요", + "author": "이름", + "authorPlaceholder": "이름 또는 이메일을 입력해주세요", + "desc": "설명", + "env": { + "restore": "서브 플로우 기본값으로 복원", + "remove": "환경 변수 제거" + }, "errors": { "noNodesSelected": "서브 플로우를 생성할 수 없습니다 : 노드가 선택되지 않았습니다", "multipleInputsToSelection": "서브 플로우를 생성할 수 없습니다 : 복수의 입력이 선택되었습니다" } }, + "group": { + "editGroup": "그룹 수정: __name__", + "errors": { + "cannotCreateDiffGroups": "다른 그룹의 노드를 사용하여 그룹을 생성할 수 없습니다", + "cannotAddSubflowPorts": "그룹에 서브 플로우 포트를 추가할 수 없습니다" + } + }, "editor": { "configEdit": "수정", "configAdd": "추가", @@ -294,19 +396,20 @@ "addNewType": "__type__의 노드타입 추가 ...", "nodeProperties": "노드 속성", "label": "명칭", + "color": "Color", "portLabels": "포트 설정", "labelInputs": "입력", "labelOutputs": "출력", "settingIcon": "아이콘", + "default": "default", "noDefaultLabel": "없음", "defaultLabel": "기본 명칭", "searchIcons": "아이콘 조회", "useDefault": "기본설정 사용", "description": "상세 내역", - "show": "보이기", - "hide": "숨기기", "errors": { - "scopeChange": "범위를 변경하게 되면 다른 플로우의 노드가 사용이 불가능해 집니다." + "scopeChange": "범위를 변경하게 되면 다른 플로우의 노드가 사용이 불가능해 집니다.", + "invalidProperties": "유효하지 않은 속성:" } }, "keyboard": { @@ -319,10 +422,11 @@ "global": "글로벌", "workspace": "작업공간", "selectAll": "모든 노드 선택", - "selectAllConnected": "모든 연결된 노드 선택", + "selectNone": "노드 선택 취소", + "selectAllConnected": "연결된 모든 노드 선택", "addRemoveNode": "노드 추가/삭제", "editSelected": "선택된 노드 수정", - "deleteSelected": "선택된 노드나 링크를 삭제", + "deleteSelected": "선택된 노드 또는 링크 삭제", "importNode": "노드 불러오기", "exportNode": "노드 내보내기", "nudgeNode": "선택된 노드 이동 (1px)", @@ -332,9 +436,14 @@ "copyNode": "선택된 노드 복사", "cutNode": "선택된 노드 잘라내기", "pasteNode": "노드 붙여넣기", + "copyGroupStyle": "그룹 스타일 복사하기", + "pasteGroupStyle": "그룹 스타일 붙여넣기", "undoChange": "마지막 변경 되돌리기", + "redoChange": "다시 실행하기", "searchBox": "검색창 열기", - "managePalette": "팔렛트 관리" + "managePalette": "팔렛트 관리", + "actionList": "액션 목록", + "splitWireWithLinks": "링크 노드로 선택 항목 분할" }, "library": { "library": "라이브러리", @@ -342,13 +451,16 @@ "saveToLibrary": "라이브러리로 저장...", "typeLibrary": "__type__ 라이브러리", "unnamedType": "이름없는 __type__", + "exportedToLibrary": "노드를 라이브러리로 내보냈습니다.", "dialogSaveOverwrite": "__libraryType__이 __libraryName__으로 이미 등록되어있습니다. 덮어쓸까요?", "invalidFilename": "파일명이 올바르지 않습니다", "savedNodes": "저장된 노드", "savedType": "저장된 __type__", "saveFailed": "저장 실패 : __message__", + "newFolder": "새로운 폴더", "types": { - "examples": "예시" + "local": "로컬", + "examples": "예시" } }, "palette": { @@ -358,9 +470,13 @@ "addCategory": "추가 ...", "label": { "subflows": "서브 플로우", + "network": "네트워크", + "common": "일반", "input": "입력", "output": "출력", "function": "기능", + "sequence": "sequence", + "parser": "parser", "social": "소셜", "storage": "저장", "analysis": "분석", @@ -379,7 +495,8 @@ "nodeEnabled_plural": "노드가 활성화 되었습니다:", "nodeDisabled": "노드가 비활성화 되었습니다:", "nodeDisabled_plural": "노드가 비활성화 되었습니다:", - "nodeUpgraded": "__module__ 노드모듈이 __version__으로 업그레이드 되었습니다" + "nodeUpgraded": "__module__ 노드모듈이 __version__으로 업그레이드 되었습니다", + "unknownNodeRegistered": "Error loading node:- __type__
__error__
노드 카탈로그를 설치하지 못했습니다.
브라우저 콘솔로그를 참고하세요.
", "installFailed": "설치 실패 : __module__
__message__
브라우저 콘솔로그를 참고하세요.
", @@ -466,6 +585,7 @@ "label": "정보", "node": "노드", "type": "타입", + "group": "Group", "module": "모듈", "id": "ID", "status": "상태", @@ -488,7 +608,23 @@ "nodeHelp": "노드 도움말", "none": "없음", "arrayItems": "__count__ 개의 항목", - "showTips": "설정에서 도움말을 열 수 있습니다. " + "showTips": "설정에서 도움말을 열 수 있습니다. ", + "outline": "개요", + "empty": "비우기", + "globalConfig": "전역 설정 노드", + "triggerAction": "트리거 작업", + "find": "작업 공간에서 찾기" + }, + "help": { + "name": "도움말", + "label": "도움말", + "search": "도움말 검색", + "nodeHelp": "노드 도움말 보기", + "showHelp": "도움말 보기", + "showInOutline": "요약 보기", + "showTopics": "토픽 보기", + "noHelp": "선택한 도움말 항목이 없습니다", + "changeLog": "릴리즈 정보" }, "config": { "name": "노드 설정", @@ -498,7 +634,9 @@ "subflows": "보조 플로우", "flows": "플로우", "filterAll": "전체", + "showAllConfigNodes": "모든 설정 노드 보기", "filterUnused": "미사용", + "showAllUnusedConfigNodes": "사용하지 않는 모든 설정 노드 보기", "filtered": "__count__ 개 숨김" }, "context": { @@ -509,8 +647,11 @@ "empty": "공백", "node": "노드", "flow": "플로우", - "global": "Global", - "deleteConfirm": "정말로 이 아이템을 지우시겠습니까?" + "global": "글로벌", + "deleteConfirm": "정말로 이 아이템을 지우시겠습니까?", + "autoRefresh": "선택 변경 시 새로 고침", + "refrsh": "새로고침", + "delete": "삭제" }, "palette": { "name": "팔레트 관리", @@ -525,6 +666,7 @@ "noSummaryAvailable": "요약 없음", "editDescription": "프로젝트 상세내역 수정", "editDependencies": "프로젝트 의존성 수정", + "noDescriptionAvailable": "설명 없음", "editReadme": "README.md 수정", "showProjectSettings": "프로젝트 설정 보이기", "projectSettings": { @@ -537,6 +679,10 @@ "files": "파일", "flow": "플로우", "credentials": "인증정보", + "package": "Package", + "packageCreate": "변경 내용이 저장될 때 파일이 생성됩니다", + "fileNotExist": "파일이 존재하지 않습니다", + "selectFile": "파일 선택", "invalidEncryptionKey": "잘못된 암호화 키", "encryptionEnabled": "암호화 활성화", "encryptionDisabled": "암호화 비활성화", @@ -674,15 +820,29 @@ "bin": "buffer", "date": "timestamp", "jsonata": "expression", - "env": "env variable" + "env": "env variable", + "cred": "credential" } }, "editableList": { - "add": "추가" + "add": "추가", + "addTitle": "add an item" }, "search": { + "history": "Search history", + "clear": "clear all", "empty": "결과 없음", - "addNode": "노드 추가 ..." + "addNode": "노드 추가 ...", + "options": { + "configNodes": "설정 노드", + "unusedConfigNodes": "사용되지 않는 설정 노드", + "invalidNodes": "잘못된 노드", + "uknownNodes": "알 수 없는 노드", + "unusedSubflows": "사용되지 않는 서브 플로우", + "hiddenFlows": "숨겨진 플로우", + "modifiedNodes": "수정된 노드 및 플로우", + "thisFlow": "현재 플로우" + } }, "expressionEditor": { "functions": "기능", @@ -703,15 +863,36 @@ "eval": "형식 오류 :\n __message__" } }, + "monaco": { + "setTheme": "테마 설정" + }, "jsEditor": { "title": "자바스크립트 에디터" }, + "textEditor": { + "title": "텍스트 에디터" + }, "jsonEditor": { "title": "JSON 에디터", - "format": "JSON 형식" + "format": "JSON 형식", + "rawMode": "JSON 수정", + "uiMode": "비주얼 편집기", + "rawMode-readonly": "JSON", + "uiMode-readonly": "비주얼", + "insertAbove": "위로 삽입", + "insertBelow": "아래로 삽입", + "addItem": "속성 추가", + "copyPath": "속성의 키값 복사", + "expandItems": "속성 펼치기", + "collapseItems": "속성 접기", + "duplicate": "복사", + "error": { + "invalidJSON": "비유효한 JSON: " + } }, "markdownEditor": { "title": "Markdown 에디터", + "expand": "Expand", "format": "Markdown 형식", "heading1": "제목 레벨1", "heading2": "제목 레벨2", @@ -741,6 +922,7 @@ "desc2": "이 기능을 건너뛰어도 상관없습니다. 언제든지 프로젝트 메뉴에서 첫번째 프로젝트를 만들 수 있습니다.", "create": "프로젝트 생성", "clone": "프로젝트 복제", + "openExistingProject": "기존 프로젝트 열기", "not-right-now": "나중에" }, "git-config": { @@ -858,7 +1040,8 @@ "not-git": "git 저장소가 아닙니다", "no-resource": "저장소아 없습니다", "cant-get-ssh-key-path": "에러! 선택한 SSH키 경로를 가져올 수 없습니다.", - "unexpected_error": "예기치 않은 에러" + "unexpected_error": "예기치 않은 에러", + "clearContext": "프로젝트 전환 시 context 삭제" }, "delete": { "confirm": "프로젝트를 정말 지우시겠습니까?" @@ -897,7 +1080,26 @@ }, "editor-tab": { "properties": "속성", + "envProperties": "환경 변수", + "module": "모듈 속성", "description": "상세 내역", - "appearance": "모양" + "appearance": "모양", + "preview": "UI 프리뷰", + "defaultValue": "기본값" + }, + "tourGuide": { + "takeATour": "둘러보기", + "start": "시작", + "next": "다음", + "welcomeTours": "버전 별 릴리즈 정보" + }, + "diagnostics": { + "title": "시스템 정보" + }, + "contextMenu": { + "insert": "삽입", + "node": "노드", + "junction": "접합", + "linkNodes": "링크 노드" } } diff --git a/packages/node_modules/@node-red/editor-client/locales/pt-BR/editor.json b/packages/node_modules/@node-red/editor-client/locales/pt-BR/editor.json new file mode 100644 index 000000000..6e20bc32d --- /dev/null +++ b/packages/node_modules/@node-red/editor-client/locales/pt-BR/editor.json @@ -0,0 +1,1208 @@ +{ + "common": { + "label": { + "name": "Nome", + "ok": "O.K.", + "done": "Feito", + "cancel": "Cancelar", + "delete": "Deletar", + "close": "Fechar", + "load": "Carregar", + "save": "Salvar", + "import": "Importar", + "export": "Exportar", + "back": "Voltar", + "next": "Próximo", + "clone": "Clonar", + "cont": "Continuar", + "style": "Estilo", + "line": "Contorno", + "fill": "Preenchido", + "label": "Etiqueta", + "color": "Cor", + "position": "Posição", + "enable": "Habilitado", + "disable": "Desabilitado", + "upload": "Subir" + }, + "type": { + "string": "cadeia de caracteres", + "number": "numero", + "boolean": "booliano", + "array": "matriz", + "buffer": "armazenamento temporário", + "object": "objeto", + "jsonString": "cadeia de caracteres JSON", + "undefined": "indefinido", + "null": "nulo" + } + }, + "event": { + "loadPlugins": "Carregando programas adicionais", + "loadPalette": "Carregando Paleta", + "loadNodeCatalogs": "Carregando Catálogo de Nós", + "loadNodes": "Carregando Nós __count__", + "loadFlows": "Carregando Fluxos", + "importFlows": "Adicionar Fluxos ao espaço de trabalho", + "importError": "Erro ao adicionar fluxos
__message__
", + "loadingProject": "Carregando projeto" + }, + "workspace": { + "defaultName": "Fluxo __number__", + "editFlow": "Editar Fluxo: __name__", + "confirmDelete": "Confirmar exclusão", + "delete": "Tem certeza de que deseja excluir '__label__'?", + "dropFlowHere": "Solte o fluxo aqui", + "addFlow": "Adicionar fluxo", + "addFlowToRight": "Adicionar fluxo à direita", + "hideFlow": "Esconder fluxo", + "hideOtherFlows": "Esconder outros fluxos", + "showAllFlows": "Mostrar todos os fluxos", + "hideAllFlows": "Esconder todos os fluxos", + "hiddenFlows": "Listar __count__ fluxo escondido", + "hiddenFlows_plural": "Listar __count__ fluxos escondidos", + "showLastHiddenFlow": "Mostrar último fluxo escondido", + "listFlows": "Listar Fluxos", + "listSubflows": "Listar subfluxos", + "status": "Estado", + "enabled": "Habilitar", + "disabled": "Desabilitar", + "info": "Descrição", + "selectNodes": "Clique em nós para selecionar" + }, + "menu": { + "label": { + "view": { + "view": "Visão", + "grid": "Grade", + "storeZoom": "Restaura nível do zoom ao carregar", + "storePosition": "Restaura posição de rolamento ao carregar", + "showGrid": "Mostre as grades", + "snapGrid": "Ajustar à grade", + "gridSize": "Tamanho da grade", + "textDir": "Direção do texto", + "defaultDir": "Padrão", + "ltr": "Esquerta-para-direita", + "rtl": "Direita-para-esquerda", + "auto": "Contextual", + "language": "Linguagem", + "browserDefault": "Padrão do navegador" + }, + "sidebar": { + "show": "Mostrar barra lateral" + }, + "palette": { + "show": "Mostrar paleta" + }, + "edit": "Editar", + "settings": "Configurações", + "userSettings": "Configurações do usuário", + "nodes": "Nós", + "displayStatus": "Mostrar estados do nó", + "displayConfig": "Configuração dos nós", + "import": "Importar", + "export": "Exportar", + "search": "Procurar fluxos", + "searchInput": "procure seus fluxos", + "subflows": "subfluxos", + "createSubflow": "Criar Subfluxo", + "selectionToSubflow": "Seleção para subfluxo", + "flows": "Fluxos", + "add": "Adicionar", + "rename": "Renomear", + "delete": "Apagar", + "keyboardShortcuts": "Atalhos do teclado", + "login": "Ingressar", + "logout": "Sair", + "editPalette": "Gerenciar paleta", + "other": "Outro", + "showTips": "Mostre as dicas", + "showWelcomeTours": "Mostrar excursão guiada para novas versões", + "help": "sítio do Node-RED", + "projects": "Projetos", + "projects-new": "Novo", + "projects-open": "Abrir", + "projects-settings": "Configurações do projeto", + "showNodeLabelDefault": "Mostrar rótulo de nós recém-adicionados", + "codeEditor": "Editor de código", + "groups": "Grupos", + "groupSelection": "Agrupar seleção", + "ungroupSelection": "Desagrupar seleção", + "groupMergeSelection": "Mesclar seleção", + "groupRemoveSelection": "Remover do grupo", + "arrange": "Organizar", + "alignLeft": "Alinhar à esquerda", + "alignCenter": "Alinhar ao centro", + "alignRight": "Alinhar à direita", + "alignTop": "Alinhar ao início", + "alignMiddle": "Alinhar ao meio", + "alignBottom": "Alinhar ao final ", + "distributeHorizontally": "Distribuir horizontalmente", + "distributeVertically": "Distribuir verticalmente", + "moveToBack": "Mover para detrás", + "moveToFront": "Mover para a frente", + "moveBackwards": "Volta", + "moveForwards": "Avança" + } + }, + "actions": { + "toggle-navigator": "Alternar navegador", + "zoom-out": "Diminuir zoom ", + "zoom-reset": "Reiniciar zoom", + "zoom-in": "Aumentar zoom", + "search-flows": "Procura fluxos", + "search-prev": "Anterior", + "search-next": "Próximo", + "search-counter": "\"__term__\" __result__ of __count__" + }, + "user": { + "loggedInAs": "Acessado como __name__", + "username": "Nome do Usuário", + "password": "Senha", + "login": "Ingressar", + "loginFailed": "Falha ao ingressar", + "notAuthorized": "Não autorizado", + "errors": { + "settings": "Você deve ingressar para acessar as configurações", + "deploy": "Você deve ingressar para implementar mudanças", + "notAuthorized": "Você precisa ter ingressado para realizar esta ação" + } + }, + "notification": { + "state": { + "flowsStopped": "Fluxos parados", + "flowsStarted": "Fluxos iniciados" + }, + "warning": "Aviso: __message__", + "warnings": { + "undeployedChanges": "o nó tem mudanças não implementadas", + "nodeActionDisabled": "ações do nó desabilitadas", + "nodeActionDisabledSubflow": "ações do nó desabilitadas dentro do subfluxo", + "missing-types": "Fluxos parados devido a tipos de nós ausentes.
", + "missing-modules": "Os fluxos pararam devido à falta de módulos.
", + "safe-mode": "Fluxos parados no modo de segurança.
Você pode modificar seus fluxos e implementar as mudanças para reiniciar.
", + "restartRequired": "O Node-RED deve ser reiniciado para habilitar os módulos atualizados", + "credentials_load_failed": "Os fluxos pararam porque as credenciais não puderam ser descriptografadas.
O arquivo de credencial de fluxo está criptografado, mas a chave de criptografia do projeto está ausente ou é inválida.
", + "credentials_load_failed_reset": "As credenciais não puderam ser descriptografadas
O arquivo de credencial do fluxo está criptografado, mas a chave de criptografia do projeto está ausente ou é inválida.
O arquivo de credencial de fluxo será redefinido na próxima implantação. Todas as credenciais de fluxo existentes serão apagadas.
", + "missing_flow_file": "Arquivo de fluxo de projeto não encontrado.
O projeto não está configurado com um arquivo de fluxo.
", + "missing_package_file": "Arquivo de pacote de projeto não encontrado.
O projeto está sem um arquivo package.json.
", + "project_empty": "O projeto está vazio.
Você deseja criar um conjunto padrão de arquivos de projeto?
Caso contrário, você terá que adicionar arquivos manualmente ao projeto fora do editor.
Projeto '__project__' não encontrado.
", + "git_merge_conflict": "A mesclagem automática de alterações falhou.
Corrija os conflitos não mesclados e confirme os resultados.
" + }, + "error": "Erro: __message__", + "errors": { + "lostConnection": "Conexão perdida com o servidor, reconectando...", + "lostConnectionReconnect": "Conexão perdida com o servidor, reconectando em __time__s.", + "lostConnectionTry": "Tentar novamente", + "cannotAddSubflowToItself": "Não é possível adicionar subfluxo a si mesmo", + "cannotAddCircularReference": "Não é possível adicionar subfluxo - referência circular detectada", + "unsupportedVersion": "Usando uma versão não suportada do Node.js
Você deve atualizar para a versão mais recente do Node.js LTS
", + "failedToAppendNode": "Falha ao carregar '__module__'
__error__
" + }, + "project": { + "change-branch": "Mudar para ramo local'__project__'", + "merge-abort": "Mesclagem Git abortada", + "loaded": "Projeto '__project__' carregado", + "updated": "Projeto '__project__' atualizado", + "pull": "Projeto '__project__' recarregado", + "revert": "Projeto '__project__' revertido", + "merge-complete": "Mesclagem Git completa", + "setupCredentials": "Configurar credenciais", + "setupProjectFiles": "Configurar arquivos de projeto", + "no": "Não obrigado", + "createDefault": "Criar arquivos de projeto padrão", + "mergeConflict": "Mostrar conflitos de mesclagem" + }, + "label": { + "manage-project-dep": "Gerenciar dependências do projeto", + "setup-cred": "Configurar credenciais", + "setup-project": "Arquivos de projeto de instalação", + "create-default-package": "Criar arquivo de pacote padrão", + "no-thanks": "Não obrigado", + "create-default-project": "Crie arquivos de projeto padrão", + "show-merge-conflicts": "Mostrar conflitos de mesclagem", + "unknownNodesButton": "Procura por nós desconhecidos" + } + }, + "clipboard": { + "clipboard": "Área de transferência", + "nodes": "Nós", + "node": "__count__ nó", + "node_plural": "__count__ nós", + "configNode": "__count__ nó de configuração", + "configNode_plural": "__count__ nós de configuração", + "group": "__count__ grupo", + "group_plural": "__count__ grupos", + "flow": "__count__ fluxo", + "flow_plural": "__count__ fluxos", + "subflow": "__count__ subfluxo", + "subflow_plural": "__count__ subfluxos", + "replacedNodes": "__count__ nó substituído", + "replacedNodes_plural": "__count__ nós substituídos", + "pasteNodes": "Colar fluxo JSON ou", + "selectFile": "selecione um arquivo para importar", + "importNodes": "Importar nós", + "exportNodes": "Exportar nós", + "download": "Baixar", + "importUnrecognised": "Tipo não reconhecido importado:", + "importUnrecognised_plural": "Tipos não reconhecidos importados:", + "importDuplicate": "Nó duplicado importado:", + "importDuplicate_plural": "Nós duplicados importados:", + "nodesExported": "Nós exportados para a área de transferência", + "nodesImported": "Importado:", + "nodeCopied": "__count__ nó copiado", + "nodeCopied_plural": "__count__ nós copiados", + "groupCopied": "__count__ grupo copiado", + "groupCopied_plural": "__count__ grupos copiados", + "groupStyleCopied": "Estilo de grupo copiado", + "invalidFlow": "Fluxo inválido: __message__", + "recoveredNodes": "Nós recuperados", + "recoveredNodesInfo": "Os nós neste fluxo não tinham um ID de fluxo válido quando foram importados. Eles foram adicionados a este fluxo para que você possa restaurá-los ou excluí-los.", + "recoveredNodesNotification": "Nós importados sem um ID de fluxo válido
Eles foram adicionados a um novo fluxo chamado '__flowName__'.
", + "export": { + "selected": "nós selecionados", + "current": "fluxo corrente", + "all": "todos os fluxos", + "compact": "compactar", + "formatted": "formatado", + "copy": "Copiar para área de transferência", + "export": "Exportar biblioteca", + "exportAs": "Exportar como", + "overwrite": "Substituir", + "exists": "\"__file__\" já existe.
Deseja substituir?
" + }, + "import": { + "import": "Importar para", + "importSelected": "Importar selecionado", + "importCopy": "Importar cópia", + "viewNodes": "Ver nós...", + "newFlow": "novo fluxo", + "replace": "substituir", + "errors": { + "notArray": "A entrada não é uma matriz JSON", + "itemNotObject": "A entrada não é um fluxo válido - o item __index__ não é um objeto de nó", + "missingId": "A entrada não é um fluxo válido - item __index__ faltando propriedade 'id'", + "missingType": "A entrada não é um fluxo válido - item __index__ faltando propriedade 'type'" + }, + "conflictNotification1": "Alguns dos nós que você está importando já existem em sua área de trabalho.", + "conflictNotification2": "Selecione quais nós importar e se deseja substituir os nós existentes ou importar uma cópia deles." + }, + "copyMessagePath": "Caminho copiado", + "copyMessageValue": "Valor copiado", + "copyMessageValue_truncated": "Valor truncado copiado" + }, + "deploy": { + "deploy": "implementar", + "full": "Cheio", + "fullDesc": "Implementar tudo no espaço de trabalho", + "modifiedFlows": "Fluxos Modificados", + "modifiedFlowsDesc": "Implantar apenas fluxos que contêm nós alterados", + "modifiedNodes": "Nós Modificados", + "modifiedNodesDesc": "Implantar apenas nós que mudaram", + "startFlows": "Iniciar", + "startFlowsDesc": "Iniciar Fluxos", + "stopFlows": "Parar", + "stopFlowsDesc": "Parar Fluxos", + "restartFlows": "Reiniciar Fluxos", + "restartFlowsDesc": "Reinicia os fluxos atuais implantados", + "successfulDeploy": "Implementado com sucesso", + "successfulRestart": "Fluxos reiniciados com sucesso", + "deployFailed": "Implementação falhou: __message__", + "unusedConfigNodes": "Você tem alguns nós de configuração não utilizados.", + "unusedConfigNodesButton": "Procurar por nós de configuração não utilizados", + "unknownNodesButton": "Procurar por nós desconhecidos", + "invalidNodesButton": "Procurar por nós inválidos", + "errors": { + "noResponse": "sem resposta do servidor" + }, + "confirm": { + "button": { + "ignore": "Ignorar", + "confirm": "Confirmar implantação", + "review": "Rever alterações", + "cancel": "Cancelar", + "merge": "Mesclar", + "overwrite": "Ignorar e implantar" + }, + "undeployedChanges": "Você tem alterações não implementadas. \n\n Se sair desta página, essas alterações serão perdidas.", + "improperlyConfigured": "O espaço de trabalho contém alguns nós que não estão configurados corretamente:", + "unknown": "O espaço de trabalho contém alguns tipos de nós desconhecidos:", + "confirm": "Tem certeza que deseja implantar?", + "doNotWarn": "não avisar sobre isso de novo ", + "conflict": "O servidor está executando um conjunto de fluxos mais recente.", + "backgroundUpdate": "Os fluxos no servidor foram atualizados.", + "conflictChecking": "Verificando se as alterações podem ser mescladas automaticamente", + "conflictAutoMerge": "As alterações não incluem conflitos e podem ser mescladas automaticamente.", + "conflictManualMerge": "As mudanças incluem conflitos que devem ser resolvidos antes de serem implantados.", + "plusNMore": "+ __count__ mais" + } + }, + "eventLog": { + "title": "Registro de Eventos", + "view": "Registro de visão" + }, + "diff": { + "unresolvedCount": "__count__ conflito não resolvido ", + "unresolvedCount_plural": "__count__ conflitos não resolvidos ", + "globalNodes": "Nós globais ", + "flowProperties": "Propriedades de fluxo ", + "type": { + "added": "adicionado", + "changed": "alterado", + "unchanged": "inalterado ", + "deleted": "Excluído", + "flowDeleted": "fluxo excluído ", + "flowAdded": "fluxo adicionado ", + "movedTo": "movido para __id__ ", + "movedFrom": "movido de __id__" + }, + "nodeCount": "__count__ nó", + "nodeCount_plural": "__count__ nós", + "local": "Mudanças locais ", + "remote": "Mudanças remotas ", + "reviewChanges": "Rever alterações ", + "noBinaryFileShowed": "Não é possível mostrar o conteúdo do arquivo binário ", + "viewCommitDiff": "Ver alterações de confirmação ", + "compareChanges": "Compare as alterações ", + "saveConflict": "Salvar resolução de conflito ", + "conflictHeader": "__resolved__ of __unresolved__ conflitos resolvidos", + "commonVersionError": "A versão comum não contém JSON válido: ", + "oldVersionError": "A versão antiga não contém JSON válido: ", + "newVersionError": "A nova versão não contém JSON válido: " + }, + "subflow": { + "editSubflowInstance": "Editar instância de subfluxo: __name__", + "editSubflow": "Editar modelo de subfluxo: __name__", + "edit": "Editar modelo de subfluxo", + "subflowInstances": "Existe uma instância __count__ deste modelo de subfluxo", + "subflowInstances_plural": "Existem __count__ instâncias deste modelo de subfluxo", + "editSubflowProperties": "editar propriedades", + "input": "entradas:", + "output": "saídas:", + "status": "estados do nó", + "deleteSubflow": "excluir subfluxo", + "confirmDelete": "Tem certeza de que deseja excluir este subfluxo?", + "info": "Descrição", + "category": "Categoria", + "module": "Módulo", + "license": "Licença", + "licenseNone": "Nenhum", + "licenseOther": "Outro", + "type": "Tipo de nó", + "version": "Versão", + "versionPlaceholder": "x.y.z", + "keys": "Palavras-chave", + "keysPlaceholder": "Palavras-chave separadas por vírgulas", + "author": "Autor", + "authorPlaceholder": "Seu nome- __type__
__error__
Este módulo não pode ser instalado porque inclui um
tipo de nó que já foi instalado
Conflitos com __module__
Falha ao carregar o catálogo de nós.
Verifique o console do navegador para obter mais informações
", + "installFailed": "Falha ao instalar: __module__
__message__
Verifique o log para obter mais informações
", + "removeFailed": "Falha ao remover: __module__
__message__
Verifique o log para obter mais informações
", + "updateFailed": "Falha ao atualizar: __module__
__message__
Verifique o log para obter mais informações
", + "enableFailed": "Falha ao ativar: __module__
__message__
Verifique o log para obter mais informações
", + "disableFailed": "Falha ao desativar: __module__
__message__
Verifique o log para obter mais informações
" + }, + "confirm": { + "install": { + "body": "Instalando '__module__'
Antes de instalar, leia a documentação do nó. Alguns nós têm dependências que não podem ser resolvidas automaticamente e podem exigir a reinicialização do Node-RED.
", + "title": "Instalar nós" + }, + "remove": { + "body": "Remover '__module__'
Remover o nó irá desinstalá-lo do Node-RED. O nó pode continuar a usar recursos até que o Node-RED seja reiniciado.
", + "title": "Remover nós" + }, + "update": { + "body": "Atualizar '__module__'
Atualizar o nó exigirá a reinicialização do Node-RED para concluir a atualização. Isso deve ser feito manualmente.
", + "title": "Atualizar nós" + }, + "cannotUpdate": { + "body": "Uma atualização para este nó está disponível, mas não está instalada em um local que o gerenciador de paletas possa atualizar.Consulte a documentação para saber como atualizar este nó." + }, + "button": { + "review": "Abrir informação do nó", + "install": "Instalar", + "remove": "Remover", + "update": "Atualizar" + } + } + } + }, + "sidebar": { + "info": { + "name": "Informação", + "tabName": "Nome", + "label": "informações", + "node": "Nó", + "type": "Tipo", + "group": "Grupo", + "module": "Módulo", + "id": "ID", + "status": "Estado", + "enabled": "Habilitado", + "disabled": "Desabilitado", + "subflow": "Subfluxo", + "instances": "Instâncias", + "properties": "Propriedades", + "info": "Informação", + "desc": "Descrição", + "blank": "branco", + "null": "nulo", + "showMore": "mostrar mais", + "showLess": "mostrar menos", + "flow": "Fluxo", + "selection": "Seleção", + "nodes": "__count__ nós", + "flowDesc": "Descrição do Fluxo", + "subflowDesc": "Descrição do Subfluxo", + "nodeHelp": "Ajuda do Nó", + "none": "Nenhum", + "arrayItems": "__count__ items", + "showTips": "Você pode abrir as dicas a partir do painel de configurações", + "outline": "Contorno", + "empty": "vazio", + "globalConfig": "Nós de configuração global", + "triggerAction": "Ação de gatilho", + "find": "Encontre no espaço de trabalho" + }, + "help": { + "name": "Ajuda", + "label": "ajuda", + "search": "Ajuda sobre a procura", + "nodeHelp": "Ajuda sobre o nó", + "showHelp": "Mostrar ajuda", + "showInOutline": "Mostrar no contorno", + "showTopics": "Mostrar tópicos", + "noHelp": "Nenhum tópico de ajuda selecionado", + "changeLog": "Log de alteração" + }, + "config": { + "name": "Configuração dos nós", + "label": "configuração", + "global": "Em todos os fluxos", + "none": "nenhum", + "subflows": "subfluxos", + "flows": "fluxos", + "filterAll": "todos", + "showAllConfigNodes": "Ver todas as configurações dos nós", + "filterUnused": "não utilizados", + "showAllUnusedConfigNodes": "Mostrar todas os nós de configuração não usados", + "filtered": "__count__ hidden" + }, + "context": { + "name": "Contexto dos Dados", + "label": "contexto", + "none": "nenhum selecionado", + "refresh": "atualize para carregar", + "empty": "vazio", + "node": "Nó", + "flow": "Fluxo", + "global": "Global", + "deleteConfirm": "Você tem certeza que deseja remover este item?", + "autoRefresh": "Atualizar na mudança de seleção", + "refrsh": "Atualizar", + "delete": "Remover" + }, + "palette": { + "name": "Gerenciamento de paleta", + "label": "paleta" + }, + "project": { + "label": "projeto", + "name": "Projeto", + "description": "Descrição", + "dependencies": "Dependências", + "settings": "Configurações", + "noSummaryAvailable": "Nenhum resumo disponível", + "editDescription": "Editar a descrição do projeto", + "editDependencies": "Editar dependências do projeto", + "noDescriptionAvailable": "Descrição não disponível", + "editReadme": "Editar README.md", + "showProjectSettings": "Mostrar configurações do projeto", + "projectSettings": { + "title": "Configurações do Projeto", + "edit": "editar", + "none": "Nenhum", + "install": "instalar", + "removeFromProject": "remover do projeto", + "addToProject": "adicionar ao projeto", + "files": "Arquivos", + "flow": "Fluxos", + "credentials": "Credenciais", + "package": "Pacote", + "packageCreate": "O arquivo será criado quando as alterações forem salvas", + "fileNotExist": "Arquivo não existe", + "selectFile": "Selecione o arquivo", + "invalidEncryptionKey": "Chave de criptografia inválida", + "encryptionEnabled": "Criptografia habilitada", + "encryptionDisabled": "Criptografia desabilitada", + "setTheEncryptionKey": "Defina a chave de criptografia", + "resetTheEncryptionKey": "Redefina a chave de criptografia", + "changeTheEncryptionKey": "Troque a chave de criptografia", + "currentKey": "Chave atual", + "newKey": "Nova chave", + "credentialsAlert": "Isso excluirá todas as credenciais existentes", + "versionControl": "Controle de versão", + "branches": "Ramos", + "noBranches": "Sem ramos", + "deleteConfirm": "Tem certeza de que deseja excluir o ramo local '__name__'? Isto não pode ser desfeito.", + "unmergedConfirm": "O ramo local '__name__' tem alterações não mescladas que serão perdidas. Tem certeza que deseja excluir?", + "deleteUnmergedBranch": "Excluir ramo não mesclado", + "gitRemotes": "Git remoto", + "addRemote": "adicionar remoto", + "addRemote2": "Adicionar remoto", + "remoteName": "Nome do remoto", + "nameRule": "Deve conter apenas A-Z 0-9 _ -", + "url": "URL", + "urlRule": "https://, ssh:// ou file://", + "urlRule2": "Não inclua o nome de usuário / senha na URL", + "noRemotes": "Sem remotos", + "deleteRemoteConfrim": "Tem certeza de que deseja excluir o remoto '__name__'?", + "deleteRemote": "Excluir remoto" + }, + "userSettings": { + "committerDetail": "Detalhes do Cometedor", + "committerTip": "Deixe em branco para usar o padrão do sistema", + "userName": "Nome de usuário", + "email": "Email", + "workflow": "Fluxo de trabalho", + "workfowTip": "Escolha seu fluxo de trabalho git preferido", + "workflowManual": "Manual", + "workflowManualTip": "Todas as alterações devem ser confirmadas manualmente na barra lateral 'histórico'", + "workflowAuto": "Automático", + "workflowAutoTip": "As alterações são confirmadas automaticamente a cada implantação", + "sshKeys": "Chaves SSH", + "sshKeysTip": "Permite que você crie conexões seguras para repositórios git remotos.", + "add": "adicionar chave", + "addSshKey": "Adicionar chave SSH", + "addSshKeyTip": "Gerar um novo par de chaves públicas / privadas", + "name": "Nome", + "nameRule": "Deve conter apenas A-Z 0-9 _ -", + "passphrase": "Frase de passe", + "passphraseShort": "Frase de passe muito curta", + "optional": "Opcional", + "cancel": "Cancelar", + "generate": "Gerar chave", + "noSshKeys": "Sem chaves SSH", + "copyPublicKey": "Copiar chave pública para a área de transferência", + "delete": "Excluir chave key", + "gitConfig": "Configuração do Git", + "deleteConfirm": "Tem certeza de que deseja excluir a chave SSH __name__? Isso não pode ser desfeito." + }, + "versionControl": { + "unstagedChanges": "Alterações não realizadas", + "stagedChanges": "Alterações realizadas", + "unstageChange": "Desfazer alteração", + "stageChange": "Realizar alteração", + "unstageAllChange": "Desfazer todas as alterações", + "stageAllChange": "Realizar todas as alterações", + "commitChanges": "Cometer alterações", + "resolveConflicts": "Resolver conflitos", + "head": "CABEÇA", + "staged": "Alterado", + "unstaged": "Desfeita Alteração", + "local": "Local", + "remote": "Remoto", + "revert": "Tem certeza de que deseja reverter as alterações para '__file__'? Essa ação não poderá ser desfeita.", + "revertChanges": "Reverter alterações", + "localChanges": "Mudanças locais", + "none": "Nenhum", + "conflictResolve": "Todos os conflitos resolvidos. Cometa as alterações para concluir a mesclagem.", + "localFiles": "Arquivos locais", + "all": "todos", + "unmergedChanges": "Alterações não mescladas", + "abortMerge": "interromper mesclagem", + "commit": "cometer", + "changeToCommit": "Alterações para cometer", + "commitPlaceholder": "Digite sua mensagem de cometimento", + "cancelCapital": "Cancelar", + "commitCapital": "Cometer", + "commitHistory": "Histórico do cometimento", + "branch": "Ramo:", + "moreCommits": "mais cometimentos", + "changeLocalBranch": "Alterar ramo local", + "createBranchPlaceholder": "Encontrar ou criar um ramo", + "upstream": "subir do cliente ao servidor", + "localOverwrite": "Você tem alterações locais que seriam sobrescritas alterando o ramo. Você deve cometer ou desfazer essas alterações primeiro.", + "manageRemoteBranch": "Gerenciar ramo remoto", + "unableToAccess": "Incapaz de acessar o repositório remoto", + "retry": "Tentar novamente", + "setUpstreamBranch": "Definir como ramo de subida do cliente para o servidor", + "createRemoteBranchPlaceholder": "Encontrar ou criar um ramo remoto", + "trackedUpstreamBranch": "O ramo criado será definido como o ramo de subida do cliente para o servidor rastreado.", + "selectUpstreamBranch": "O ramo será criado. Selecione abaixo para defini-lo como o ramo de subida do cliente para o servidor rastreado.", + "pushFailed": "falha ao empurrar porque o remoto tem cometimentos mais recentes. Puxe e mescle primeiro, depois empurre novamente.", + "push": "empurrar", + "pull": "puxar", + "unablePull": "
Incapaz de puxar as alterações remotas; suas alterações locais não realizadas seriam sobrescritas.
Cometa suas alterações e tente novamente.
", + "showUnstagedChanges": "Mostrar alterações não realizadas", + "connectionFailed": "Não foi possível conectar ao repositório remoto:", + "pullUnrelatedHistory": "O remoto tem um histórico não relacionado de cometimentos.
Tem certeza que deseja puxar as mudanças para o seu repositório local?
", + "pullChanges": "Puxar modificações", + "history": "histórico", + "projectHistory": "Histórico do Projeto", + "daysAgo": "__count__ dia atrás", + "daysAgo_plural": "__count__ dias atrás", + "hoursAgo": "__count__ hora atrás", + "hoursAgo_plural": "__count__ horas atrás", + "minsAgo": "__count__ min ago", + "minsAgo_plural": "__count__ minutos atrás", + "secondsAgo": "Segundos atrás", + "notTracking": "Seu ramo local não está atualmente rastreando um ramo remoto.", + "statusUnmergedChanged": "Seu repositório tem alterações não mescladas. Você precisa corrigir os conflitos e enviar o resultado.", + "repositoryUpToDate": "Seu repositório está atualizado.", + "commitsAhead": "Seu repositório está __count__ cometimento à frente do remoto. Você pode empurrar este cometimento agora.", + "commitsAhead_plural": "Seu repositório está __count__ cometimentos à frente do remoto. Você pode empurrar estes cometimentos agora.", + "commitsBehind": "Seu repositório está __count__ cometimento atrás do remoto. Você pode puxar este cometimento agora.", + "commitsBehind_plural": "Seu repositório está __count__ cometimentos atrás do remoto. Você pode puxar esses cometimentos agora.", + "commitsAheadAndBehind1": "Seu repositório está __count__ cometimento atrás e", + "commitsAheadAndBehind1_plural": "Seu repositório está __count__ cometimentos atrás e", + "commitsAheadAndBehind2": "__count__ cometimento à frente do remoto.", + "commitsAheadAndBehind2_plural": "__count__ cometimentos à frente do remoto.", + "commitsAheadAndBehind3": "Você deve baixar o cometimento remoto antes de empurrar.", + "commitsAheadAndBehind3_plural": "Você deve baixar os cometimentos remotos antes de empurrar.", + "refreshCommitHistory": "Atualizar histórico de cometimentos", + "refreshChanges": "Atualizar alterações" + } + } + }, + "typedInput": { + "type": { + "str": "cadeia de caracteres", + "num": "número", + "re": "expressão regular", + "bool": "booliano", + "json": "JSON", + "bin": "armazenamento temporário", + "date": "registro de tempo", + "jsonata": "expressão", + "env": "variável de ambiente", + "cred": "credencial" + } + }, + "editableList": { + "add": "adicionar", + "addTitle": "adicionar um item" + }, + "search": { + "history": "Histórico da procura", + "clear": "limpar tudo", + "empty": "Nenhuma equivalência encontrada", + "addNode": "adicionar um nó...", + "options": { + "configNodes": "Configuração de nós", + "unusedConfigNodes": "Configuração de nós não utilizadas", + "invalidNodes": "Nós inválidos", + "uknownNodes": "Nós desconhecidos", + "unusedSubflows": "Subfluxos não utilizados", + "hiddenFlows": "Flux escondidos", + "modifiedNodes": "Nós e Fluxos Modificados", + "thisFlow": "Fluxo atual" + } + }, + "expressionEditor": { + "functions": "Funções", + "functionReference": "Referência de função", + "insert": "Inserir", + "title": "Editor de Expressões JSONata", + "test": "Teste", + "data": "Mensagem de exemplo", + "result": "Resultado", + "format": "expressão de formato", + "compatMode": "Modo de compatibilidade habilitado", + "compatModeDesc": "Modo de compatibilidade JSONata
A expressão atual parece ainda fazer referência a msg , então será avaliada no modo de compatibilidade. Atualize a expressão para não usar msg , pois este modo será removido no futuro.
Quando o suporte JSONata foi adicionado pela primeira vez ao Node-RED, era necessária a expressão para fazer referência ao objeto msg . Por exemplo, msg.payload seria usado para acessar a carga útil.
Isso não é mais necessário, pois a expressão será avaliada em relação à mensagem diretamente. Para acessar a carga útil, a expressão deve ser apenas payload.
Editor de armazenamento temporário
O tipo de armazenamento temporário é armazenado como uma matriz JSON de valores de bytes. O editor tentará analisar o valor inserido como uma matriz JSON. Se não for um JSON válido, será tratada como uma cadeia de caracteres UTF-8 e convertida em uma matriz de pontos de código de caractere individual.
Por exemplo, um valor de Hello World será convertido na matriz JSON:
[72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100]" + }, + "projects": { + "config-git": "Configurar cliente Git", + "welcome": { + "hello": "Olá! Introduzimos 'projetos' no Node-RED.", + "desc0": "Esta é uma nova maneira de gerenciar seus arquivos de fluxo e incluir controle de versão de seus fluxos.", + "desc1": "Para começar, você pode criar seu primeiro projeto ou clonar um projeto existente de um repositório git.", + "desc2": "Se você não tiver certeza, pode pular isso por enquanto. Você ainda poderá criar seu primeiro projeto a partir do menu 'Projetos' a qualquer momento.", + "create": "Criar Projeto", + "clone": "Repositório de clones", + "openExistingProject": "Abrir projeto existente", + "not-right-now": "Não nesse exato momento" + }, + "git-config": { + "setup": "Configure seu cliente de controle de versão", + "desc0": "O Node-RED usa a ferramenta de código aberto Git para controle de versão. Ele rastreia as alterações em seus arquivos de projeto e permite enviá-los para repositórios remotos.", + "desc1": "Quando você confirma um conjunto de alterações, o Git registra quem fez as alterações com um nome de usuário e endereço de e-mail. O nome de usuário pode ser o que você quiser - não precisa ser seu nome real.", + "desc2": "Seu cliente Git já está configurado com os detalhes abaixo.", + "desc3": "Você pode alterar essas configurações mais tarde na guia 'Git config' da caixa de diálogo de configurações.", + "username": "Nome do usuário", + "email": "E-mail" + }, + "project-details": { + "create": "Crie seu projeto", + "desc0": "Um projeto é mantido como um repositório Git. Isso torna muito mais fácil compartilhar seus fluxos com outras pessoas e colaborar neles.", + "desc1": "Você pode criar vários projetos e alternar rapidamente entre eles no editor.", + "desc2": "Para começar, seu projeto precisa de um nome e uma descrição opcional.", + "already-exists": "Projeto já existe", + "must-contain": "Deve conter apenas A-Z 0-9 _ -", + "project-name": "Nome do Projeto", + "desc": "Descrição", + "opt": "Opcional" + }, + "clone-project": { + "clone": "Clonar um projeto", + "desc0": "Se você já tem um repositório git contendo um projeto, pode cloná-lo para começar.", + "already-exists": "Projeto já existe", + "must-contain": "Deve conter apenas A-Z 0-9 _ -", + "project-name": "Nome do projeto", + "no-info-in-url": "Não inclua o nome de usuário / senha no url", + "git-url": "Git repository URL", + "protocols": "https: //, ssh: // ou file://", + "auth-failed": "Autenticação falhou", + "username": "Nome de usuário", + "passwd": "Senha", + "ssh-key": "Chave SSH", + "passphrase": "Frase de Passe", + "ssh-key-desc": "Antes de clonar um repositório usando ssh, você deve adicionar uma chave SSH para acessá-lo.", + "ssh-key-add": "Adicionar uma chave ssh", + "credential-key": "Chave de criptografia de credenciais", + "cant-get-ssh-key": "Erro! Não é possível obter o caminho da chave SSH selecionada.", + "already-exists2": "já existe", + "git-error": "git error", + "connection-failed": "Conexão falhou", + "not-git-repo": "Não é um repositório git", + "repo-not-found": "Repositório não encontrado" + }, + "default-files": { + "create": "Crie seus arquivos de projeto", + "desc0": "Um projeto contém seus arquivos de fluxo, um arquivo README e um arquivo package.json.", + "desc1": "Pode conter quaisquer outros arquivos que você deseja manter no repositório Git.", + "desc2": "Seus arquivos de fluxo e credenciais existentes serão copiados para o projeto.", + "flow-file": "Arquivo de fluxo", + "credentials-file": "Arquivo de credenciais" + }, + "encryption-config": { + "setup": "Configure a criptografia do seu arquivo de credenciais", + "desc0": "Seu arquivo de credenciais de fluxo pode ser criptografado para manter seu conteúdo seguro.", + "desc1": "Se você deseja armazenar essas credenciais em um repositório Git público, deve criptografá-las fornecendo uma frase-chave secreta.", + "desc2": "Seu arquivo de credenciais de fluxo não está criptografado no momento.", + "desc3": "Isso significa que seu conteúdo, como senhas e fichas de acesso, pode ser lido por qualquer pessoa com acesso ao arquivo.", + "desc4": "Se você deseja armazenar essas credenciais em um repositório Git público, deve criptografá-las fornecendo uma frase-chave secreta.", + "desc5": "Seu arquivo de credenciais de fluxo está atualmente criptografado usando a propriedade credentialSecret de seu arquivo de configurações como a chave.", + "desc6": "Seu arquivo de credenciais de fluxo está criptografado usando uma chave gerada pelo sistema. Você deve fornecer uma nova chave secreta para este projeto.", + "desc7": "A chave será armazenada separadamente dos arquivos do seu projeto. Você precisará fornecer a chave para usar este projeto em outra instância do Node-RED.", + "credentials": "Credenciais", + "enable": "Habilitar criptografia", + "disable": "Desabilitar criptografia", + "disabled": "desabilitado", + "copy": "Copiar sobre a chave existente", + "use-custom": "Usar chave personalizada", + "desc8": "O arquivo de credenciais não será criptografado e seu conteúdo será lido facilmente", + "create-project-files": "Criar arquivos de projeto", + "create-project": "Criar projeto", + "already-exists": "já existe", + "git-error": "erro no git", + "git-auth-error": "git erro de autenticação" + }, + "create-success": { + "success": "Você criou com sucesso o seu primeiro projeto!", + "desc0": "Agora você pode continuar usando o Node-RED como sempre fez.", + "desc1": "A guia 'informações' na barra lateral mostra qual é o seu projeto ativo atual. O botão ao lado do nome pode ser usado para acessar a visualização das configurações do projeto.", + "desc2": "A guia 'histórico' na barra lateral pode ser usada para ver os arquivos que foram alterados no seu projeto e para submetê-los. Ela mostra um histórico completo de seus cometimentos e permite que você envie suas alterações para um repositório remoto . " + }, + "create": { + "projects": "Projetos", + "already-exists": "Projeto já existe", + "must-contain": "Deve conter apenas A-Z 0-9 _ -", + "no-info-in-url": "Não inclua o nome de usuário/senha no url", + "open": "Abrir projeto", + "create": "Criar Projeto", + "clone": "Clone Repositório", + "project-name": "Nome do projeto", + "desc": "Descrição", + "opt": "Opcional", + "flow-file": "Arquivo de fluxo", + "credentials": "Credenciais", + "enable-encryption": "Habilitar criptografia", + "disable-encryption": "Desabilitar criptografia", + "encryption-key": "Chave de criptografia", + "desc0": "Uma frase para proteger suas credenciais com", + "desc1": "O arquivo de credenciais não será criptografado e seu conteúdo poderá ser lido facilmente", + "git-url": "URL do repositório Git", + "protocols": "https://, ssh:// or file://", + "auth-failed": "Falha na autenticação", + "username": "Nome do usuário", + "password": "Senha", + "ssh-key": "Chave SSH", + "passphrase": "Frase de Passe", + "desc2": "Antes de clonar um repositório usando ssh, você deve adicionar uma chave SSH para acessá-lo.", + "add-ssh-key": "Adicionar uma chave ssh", + "credentials-encryption-key": "Chave de criptografia de credenciais", + "already-exists-2": "já existe", + "git-error": "erro de git", + "con-failed": "Conexão falhou", + "not-git": "Não é um repositório git", + "no-resource": "Repositório não encontrado", + "cant-get-ssh-key-path": "Erro! Não é possível obter o caminho da chave SSH selecionado.", + "unexpected_error": "erro_inesperado", + "clearContext": "Limpar contexto quando ocorrer troca de projetos" + }, + "delete": { + "confirm": "Tem certeza de que deseja excluir este projeto?" + }, + "create-project-list": { + "search": "procure seus projetos", + "current": "atual" + }, + "require-clean": { + "confirm": "
Você tem alterações não implantadas que serão perdidas.
Deseja continuar?
" + }, + "send-req": { + "auth-req": "Autenticação necessária para repositório", + "username": "Nome do usuário", + "password": "Senha", + "passphrase": "Frase de Passe", + "retry": "Tentar novamente", + "update-failed": "Falha ao atualizar autenticação", + "unhandled": "Resposta de erro não tratada", + "host-key-verify-failed": "Falha na verificação da chave do servidor anfitrião.
A chave do servidor anfitrião do repositório não pôde ser verificada. Atualize seu arquivo known_hosts e tente novamente.
加载流程错误
__message__
", + "loadingProject": "加载项目" + }, + "workspace": { + "defaultName": "流程 __number__", + "editFlow": "编辑流程: __name__", + "confirmDelete": "确认删除", + "delete": "你确定要删除 __label__ ?", + "dropFlowHere": "把流程放到这里", + "addFlow": "添加流程", + "addFlowToRight": "在右侧新增流程", + "hideFlow": "隐藏流程", + "hideOtherFlows": "隐藏其它流程", + "showAllFlows": "显示所有流程", + "hideAllFlows": "隐藏所有流程", + "hiddenFlows": "列出 __count__ 个隐藏流程", + "hiddenFlows_plural": "列出 __count__ 个隐藏流程", + "showLastHiddenFlow": "显示最后一个隐藏流程", + "listFlows": "流程一览", + "listSubflows": "列出子流程", + "status": "状态", + "enabled": "有效", + "disabled": "无效", + "info": "详细描述", + "selectNodes": "点击节点来选择" + }, + "menu": { + "label": { + "view": { + "view": "显示", + "grid": "网格", + "storeZoom": "加载时还原缩放尺寸", + "storePosition": "加载时还原滚动位置", + "showGrid": "显示网格", + "snapGrid": "对齐网格", + "gridSize": "网格尺寸", + "textDir": "文本方向", + "defaultDir": "默认方向", + "ltr": "从左到右", + "rtl": "从右到左", + "auto": "上下文", + "language": "语言", + "browserDefault": "浏览器默认" + }, + "sidebar": { + "show": "显示侧边栏" + }, + "palette": { + "show": "显示控制板" + }, + "edit": "编辑", + "settings": "设置", + "userSettings": "用户设置", + "nodes": "节点", + "displayStatus": "显示节点状态", + "displayConfig": "修改节点配置", + "import": "导入", + "export": "导出", + "search": "查找流程", + "searchInput": "查找流程", + "subflows": "子流程", + "createSubflow": "新建子流程", + "selectionToSubflow": "将选择部分更改为子流程", + "flows": "流程", + "add": "增加", + "rename": "重命名", + "delete": "删除", + "keyboardShortcuts": "键盘快捷方式", + "login": "登录", + "logout": "退出", + "editPalette": "节点管理", + "other": "其他", + "showTips": "显示小提示", + "showWelcomeTours": "显示新版本向导", + "help": "Node-RED 文档主页", + "projects": "项目", + "projects-new": "新建", + "projects-open": "打开", + "projects-settings": "项目设定", + "showNodeLabelDefault": "显示新添加的节点的标签", + "codeEditor": "代码编辑器", + "groups": "组", + "groupSelection": "选择组", + "ungroupSelection": "取消选择组", + "groupMergeSelection": "合并选择", + "groupRemoveSelection": "从组中移除", + "arrange": "布局", + "alignLeft": "左对齐", + "alignCenter": "居中对齐", + "alignRight": "右对齐", + "alignTop": "顶部对齐", + "alignMiddle": "垂直居中对齐", + "alignBottom": "底部对齐", + "distributeHorizontally": "横向分布", + "distributeVertically": "垂直分布", + "moveToBack": "置于底层", + "moveToFront": "置于顶层", + "moveBackwards": "向后移动", + "moveForwards": "向前移动" + } + }, + "actions": { + "toggle-navigator": "切换导航器", + "zoom-out": "缩小", + "zoom-reset": "重设缩放", + "zoom-in": "放大", + "search-flows": "搜索流程", + "search-prev": "上一个", + "search-next": "下一个", + "search-counter": "\"__term__\" __result__ of __count__" + }, + "user": { + "loggedInAs": "作为 __name__ 登录", + "username": "账号", + "password": "密码", + "login": "登录", + "loginFailed": "登录失败", + "notAuthorized": "未授权", + "errors": { + "settings": "设置信息需要登录后才能访问", + "deploy": "改动需要登录后才能部署", + "notAuthorized": "此操作需要登录后才能执行" + } + }, + "notification": { + "state": { + "flowsStopped": "流程已停止", + "flowsStarted": "流程已启动" }, - "workspace": { - "defaultName": "流程 __number__", - "editFlow": "编辑流程: __name__", - "confirmDelete": "确认删除", - "delete": "你确定要删除 __label__ ?", - "dropFlowHere": "把流程放到这里", - "addFlow": "添加流程", - "listFlows": "流程一览", - "status": "状态", - "enabled": "有效", - "disabled": "无效", - "info": "详细描述", - "selectNodes": "点击节点来选择" + "warning": "警告: __message__", + "warnings": { + "undeployedChanges": "节点中存在未部署的更改", + "nodeActionDisabled": "节点操作已禁用", + "nodeActionDisabledSubflow": "节点动作在子流程中被禁用", + "missing-types": "流程由于缺少节点类型而停止。请检查日志的详细信息", + "missing-modules": "流程因缺少模块而停止。
", + "safe-mode": "流程以安全模式停止。
您可以修改流程并部署更改以重新启动。
", + "restartRequired": "Node-RED必须重新启动，以启用升级的模块", + "credentials_load_failed": "由于无法解密凭据，因此流程停止。
流程凭据文件已加密，但是项目的加密密钥丢失或无效。
", + "credentials_load_failed_reset": "凭据无法解密
流凭据文件已加密，但是项目的加密密钥丢失或无效。
流凭据文件将在下一次部署时重置。任何现有的流凭证将被清除。
", + "missing_flow_file": "找不到项目流程文件。
该项目未配置流程文件。
", + "missing_package_file": "找不到项目包文件。
项目缺少package.json文件。
", + "project_empty": "该项目为空。
是否要创建一组默认的项目文件？
否则，您将必须在编辑器外部手动将文件添加到项目中。
未找到项目 __project__ 。
", + "git_merge_conflict": "自动合并更改失败。
修复未合并的冲突，然后提交结果。
" + }, + "error": "错误: __message__", + "errors": { + "lostConnection": "丢失与服务器的连接，重新连接...", + "lostConnectionReconnect": "丢失与服务器的连接， __time__ 秒后重新连接", + "lostConnectionTry": "现在尝试", + "cannotAddSubflowToItself": "无法向其自身添加子流程", + "cannotAddCircularReference": "无法添加子流程 - 循环引用", + "unsupportedVersion": "您正在使用不受支持的Node.js版本请升级到最新版本的Node.js LTS", + "failedToAppendNode": "
'__module__'加载失败
__error__
" + }, + "project": { + "change-branch": "转到本地分支'__project__'", + "merge-abort": "Git合并中止", + "loaded": "项目'__project__'已加载", + "updated": "项目'__project__'已更新", + "pull": "项目'__project__'已重新加载", + "revert": "项目 '__project__'已还原", + "merge-complete": "Git合并完成", + "setupCredentials": "设定证书", + "setupProjectFiles": "设置项目文件", + "no": "不了，谢谢", + "createDefault": "创建默认项目文件", + "mergeConflict": "显示合并冲突" + }, + "label": { + "manage-project-dep": "管理项目依赖性", + "setup-cred": "设定证书", + "setup-project": "设置项目文件", + "create-default-package": "创建默认的包文件", + "no-thanks": "不了，谢谢", + "create-default-project": "创建默认项目文件", + "show-merge-conflicts": "显示合并冲突", + "unknownNodesButton": "搜索未知节点" + } + }, + "clipboard": { + "clipboard": "剪贴板", + "nodes": "节点", + "node": "__count__ 个节点", + "node_plural": "__count__ 个节点", + "configNode": "__count__ 个配置节点", + "configNode_plural": "__count__ 个配置节点", + "group": "__count__ 个组", + "group_plural": "__count__ 个组", + "flow": "__count__ 个流程", + "flow_plural": "__count__ 个流程", + "subflow": "__count__ 个子流程", + "subflow_plural": "__count__ 子流程", + "replacedNodes": "__count__ 个节点被置换", + "replacedNodes_plural": "__count__ 个节点被置换", + "pasteNodes": "在下方粘贴节点 ", + "selectFile": "导入节点文件", + "importNodes": "导入节点", + "exportNodes": "导出节点至剪贴板", + "download": "下载", + "importUnrecognised": "导入了无法识别的类型:", + "importUnrecognised_plural": "导入了无法识别的类型:", + "importDuplicate": "导入了重复节点：", + "importDuplicate_plural": "导入了重复节点：", + "nodesExported": "节点导出到了剪贴板", + "nodesImported": "导入：", + "nodeCopied": "已复制 __count__ 个节点", + "nodeCopied_plural": "已复制 __count__ 个节点", + "groupCopied": "复制 __count__ 个组", + "groupCopied_plural": "已复制 __count__ 个groups", + "groupStyleCopied": "已复制组风格", + "invalidFlow": "无效的流程: __message__", + "recoveredNodes": "复原的节点", + "recoveredNodesInfo": "导入节点时，此流上的节点缺少有效的流ID。 它们已被添加到此流中，您可以复原或删除它们。", + "recoveredNodesNotification": "导入的节点缺少有效的流ID
已将它们添加到名为 '__flowName__'的新流中。
", + "export": { + "selected": "已选择的节点", + "current": "当前节点", + "all": "所有流程", + "compact": "紧凑", + "formatted": "已格式化", + "copy": "导出到剪贴板", + "export": "导出到库", + "exportAs": "导出为", + "overwrite": "替换", + "exists": "\"__file__\"已存在
是否要替换它？
" + }, + "import": { + "import": "导入到", + "importSelected": "导入所选项", + "importCopy": "导入副本", + "viewNodes": "查看节点", + "newFlow": "新流程", + "replace": "置换", + "errors": { + "notArray": "输入的不是JSON数组", + "itemNotObject": "输入的流无效 - 项目 __index__ 不是节点对象", + "missingId": "输入的流无效-项 __index__ 缺少'id'属性", + "missingType": "输入的流程无效-项 __index__ 缺少'类型'属性" + }, + "conflictNotification1": "您要导入的某些节点已经存在于工作空间中。", + "conflictNotification2": "选择要导入的节点，并确认要替换现有的节点还是导入它们的副本" + }, + "copyMessagePath": "已复制路径", + "copyMessageValue": "已复制数值", + "copyMessageValue_truncated": "已复制舍弃的数值" + }, + "deploy": { + "deploy": "部署", + "full": "全部", + "fullDesc": "在工作区中部署所有内容", + "modifiedFlows": "已修改的流程", + "modifiedFlowsDesc": "只部署包含已更改节点的流", + "modifiedNodes": "已更改的节点", + "modifiedNodesDesc": "只部署已经更改的节点", + "startFlows": "启动", + "startFlowsDesc": "启动流程", + "stopFlows": "停止", + "stopFlowsDesc": "停止流程", + "restartFlows": "重启流程", + "restartFlowsDesc": "重新启动当前部署的流程", + "successfulDeploy": "部署成功", + "successfulRestart": "成功重启流程", + "deployFailed": "部署失败: __message__", + "unusedConfigNodes": "您有一些未使用的配置节点", + "unusedConfigNodesButton": "搜索未使用的配置节点", + "unknownNodesButton": "查找未知节点", + "invalidNodesButton": "查找无效节点", + "errors": { + "noResponse": "服务器没有响应" + }, + "confirm": { + "button": { + "ignore": "忽略", + "confirm": "确认部署", + "review": "查看更改", + "cancel": "取消", + "merge": "合并", + "overwrite": "忽略 & 部署" + }, + "undeployedChanges": "您有未部署的更改。\n\n离开此页面将丢失这些更改。", + "improperlyConfigured": "工作区包含一些未正确配置的节点:", + "unknown": "工作区包含一些未知的节点类型:", + "confirm": "你确定要部署吗?", + "doNotWarn": "不要再对此发出警告", + "conflict": "服务器正在运行较新的一组流程。", + "backgroundUpdate": "服务器上的流程已更新。", + "conflictChecking": "检查是否可以自动合并更改", + "conflictAutoMerge": "此更改不包括冲突，可以自动合并", + "conflictManualMerge": "这些更改包括了在部署之前必须解决的冲突。", + "plusNMore": "+ __count__ 更多" + } + }, + "eventLog": { + "title": "事件记录日志", + "view": "查看日志" + }, + "diff": { + "unresolvedCount": "__count__个未解决的冲突", + "unresolvedCount_plural": "__count__个未解决的冲突", + "globalNodes": "全局节点", + "flowProperties": "流程属性", + "type": { + "added": "已添加", + "changed": "已更改", + "unchanged": "未更改", + "deleted": "已删除", + "flowDeleted": "已删除流程", + "flowAdded": "已添加流程", + "movedTo": "移动至__id__", + "movedFrom": "从__id__移动" + }, + "nodeCount": "__count__个节点", + "nodeCount_plural": "__count__个节点", + "local": "本地", + "remote": "远程", + "reviewChanges": "查看变更", + "noBinaryFileShowed": "无法显示二进制文件内容", + "viewCommitDiff": "查看提交更改", + "compareChanges": "比较变更", + "saveConflict": "保存冲突解决", + "conflictHeader": "已解决__unresolved__中的__resolved__个冲突", + "commonVersionError": "通用版本不包含有效的JSON：", + "oldVersionError": "旧版本不包含有效的JSON：", + "newVersionError": "新版本不包含有效的JSON：" + }, + "subflow": { + "editSubflowInstance": "编辑子流实例： __name__", + "editSubflow": "编辑流程模板： __name__", + "edit": "编辑流程模板", + "subflowInstances": "这个子流程模板有 __count__ 个实例", + "subflowInstances_plural": "这个子流程模板有 __count__ 个实例", + "editSubflowProperties": "编辑属性", + "input": "输入:", + "output": "输出:", + "status": "状态节点", + "deleteSubflow": "删除子流程", + "confirmDelete": "您确定要删除此子流程？", + "info": "详细描述", + "category": "类别", + "module": "模块", + "license": "许可", + "licenseNone": "无", + "licenseOther": "其它", + "type": "节点类型", + "version": "版本", + "versionPlaceholder": "x.y.z", + "keys": "关键字", + "keysPlaceholder": "使用英文逗号分隔关键字", + "author": "作者", + "authorPlaceholder": "名字流程以安全模式停止。
您可以修改流程并部署更改以重新启动。
", - "restartRequired": "Node-RED必须重新启动，以启用升级的模块", - "credentials_load_failed": "由于无法解密凭据，因此流程停止。
流程凭据文件已加密，但是项目的加密密钥丢失或无效。
", - "credentials_load_failed_reset": "凭据无法解密
流凭据文件已加密，但是项目的加密密钥丢失或无效。
流凭据文件将在下一次部署时重置。任何现有的流凭证将被清除。
", - "missing_flow_file": "找不到项目流程文件。
该项目未配置流程文件。
", - "missing_package_file": "找不到项目包文件。
项目缺少package.json文件。
", - "project_empty": "该项目为空。
是否要创建一组默认的项目文件？
否则，您将必须在编辑器外部手动将文件添加到项目中。
未找到项目 __project__ 。
", - "git_merge_conflict": "自动合并更改失败。
修复未合并的冲突，然后提交结果。
" - }, - "error": "错误: __message__", - "errors": { - "lostConnection": "丢失与服务器的连接，重新连接...", - "lostConnectionReconnect": "丢失与服务器的连接， __time__ 秒后重新连接", - "lostConnectionTry": "现在尝试", - "cannotAddSubflowToItself": "无法向其自身添加子流程", - "cannotAddCircularReference": "无法添加子流程 - 循环引用", - "unsupportedVersion": "您正在使用不受支持的Node.js版本请升级到最新版本的Node.js LTS", - "failedToAppendNode": "
'__module__'加载失败
__error__
" - }, - "project": { - "change-branch": "转到本地分支'__project__'", - "merge-abort": "Git合并中止", - "loaded": "项目'__project__'已加载", - "updated": "项目'__project__'已更新", - "pull": "项目'__project__'已重新加载", - "revert": "项目 '__project__'已还原", - "merge-complete": "Git合并完成", - "setupCredentials": "设定证书", - "setupProjectFiles": "设置项目文件", - "no": "不了，谢谢", - "createDefault": "创建默认项目文件", - "mergeConflict": "显示合并冲突" - }, - "label": { - "manage-project-dep": "管理项目依赖性", - "setup-cred": "设定证书", - "setup-project": "设置项目文件", - "create-default-package": "创建默认的包文件", - "no-thanks": "不了，谢谢", - "create-default-project": "创建默认项目文件", - "show-merge-conflicts": "显示合并冲突", - "unknownNodesButton": "搜索未知节点" - } - }, - "clipboard": { - "clipboard": "剪贴板", - "nodes": "节点", - "node": "__count__ 个节点", - "node_plural": "__count__ 个节点", - "configNode": "__count__ 个配置节点", - "configNode_plural": "__count__ 个配置节点", - "group": "__count__ 个组", - "group_plural": "__count__ 个组", - "flow": "__count__ 个流程", - "flow_plural": "__count__ 个流程", - "subflow": "__count__ 个子流程", - "subflow_plural": "__count__ 子流程", - "replacedNodes": "__count__ 个节点被置换", - "replacedNodes_plural": "__count__ 个节点被置换", - "pasteNodes": "在这里粘贴节点", - "selectFile": "选择要导入的文件", - "importNodes": "导入节点", - "exportNodes": "导出节点至剪贴板", - "download": "下载", - "importUnrecognised": "导入了无法识别的类型:", - "importUnrecognised_plural": "导入了无法识别的类型:", - "nodesExported": "节点导出到了剪贴板", - "nodesImported": "导入：", - "nodeCopied": "已复制 __count__ 个节点", - "nodeCopied_plural": "已复制 __count__ 个节点", - "groupCopied": "复制 __count__ 个组", - "groupCopied_plural": "已复制 __count__ 个groups", - "groupStyleCopied": "已复制组风格", - "invalidFlow": "无效的流程: __message__", - "recoveredNodes": "复原的节点", - "recoveredNodesInfo": "导入节点时，此流上的节点缺少有效的流ID。 它们已被添加到此流中，您可以复原或删除它们。", - "recoveredNodesNotification": "导入的节点缺少有效的流ID
已将它们添加到名为 '__flowName__'的新流中。
", - "export": { - "selected": "已选择的节点", - "current": "现在的节点", - "all": "所有流程", - "compact": "紧凑", - "formatted": "已格式化", - "copy": "导出到剪贴板", - "export": "导出到库", - "exportAs": "导出为", - "overwrite": "替换", - "exists": "\"__file__\"已存在
是否要替换它？
" - }, - "import": { - "import": "导入到", - "importSelected": "导入所选项", - "importCopy": "导入副本", - "viewNodes": "查看节点", - "newFlow": "新流程", - "replace": "置换", - "errors": { - "notArray": "输入的不是JSON数组", - "itemNotObject": "输入的流无效 - 项目 __index__ 不是节点对象", - "missingId": "输入的流无效-项 __index__ 缺少'id'属性", - "missingType": "输入的流程无效-项 __index__ 缺少'类型'属性" - }, - "conflictNotification1": "您要导入的某些节点已经存在于工作空间中。", - "conflictNotification2": "选择要导入的节点，并确认要替换现有的节点还是导入它们的副本" - }, - "copyMessagePath": "已复制路径", - "copyMessageValue": "已复制数值", - "copyMessageValue_truncated": "已复制舍弃的数值" - }, - "deploy": { - "deploy": "部署", - "full": "全面", - "fullDesc": "在工作区中部署所有内容", - "modifiedFlows": "已修改的流程", - "modifiedFlowsDesc": "只部署包含已更改节点的流", - "modifiedNodes": "已更改的节点", - "modifiedNodesDesc": "只部署已经更改的节点", - "restartFlows": "重启流程", - "restartFlowsDesc": "重新启动当前部署的流程", - "successfulDeploy": "部署成功", - "successfulRestart": "成功重启流程", - "deployFailed": "部署失败: __message__", - "unusedConfigNodes": "您有一些未使用的配置节点", - "unusedConfigNodesButton":"搜索未使用的配置节点", - "unknownNodesButton":"搜索未知节点", - "invalidNodesButton":"搜索无效节点", - "errors": { - "noResponse": "服务器没有响应" - }, - "confirm": { - "button": { - "ignore": "忽略", - "confirm": "确认部署", - "review": "查看更改", - "cancel": "取消", - "merge": "合并", - "overwrite": "忽略 & 部署" - }, - "undeployedChanges": "您有未部署的更改。\n\n离开此页面将丢失这些更改。", - "improperlyConfigured": "工作区包含一些未正确配置的节点:", - "unknown": "工作区包含一些未知的节点类型:", - "confirm": "你确定要部署吗?", - "doNotWarn": "不要再对此发出警告", - "conflict": "服务器正在运行较新的一组流程。", - "backgroundUpdate": "服务器上的流程已更新。", - "conflictChecking": "检查是否可以自动合并更改", - "conflictAutoMerge": "此更改不包括冲突，可以自动合并", - "conflictManualMerge": "这些更改包括了在部署之前必须解决的冲突。", - "plusNMore": "+ __count__ 更多" - } - }, - "eventLog": { - "title": "事件记录日志", - "view": "查看日志" - }, - "diff": { - "unresolvedCount": "__count__个未解决的冲突", - "unresolvedCount_plural": "__count__个未解决的冲突", - "globalNodes": "全局节点", - "flowProperties": "流程属性", - "type": { - "added": "已添加", - "changed": "已更改", - "unchanged": "未更改", - "deleted": "已删除", - "flowDeleted": "已删除流程", - "flowAdded": "已添加流程", - "movedTo": "移动至__id__", - "movedFrom": "从__id__移动" - }, - "nodeCount": "__count__个节点", - "nodeCount_plural": "__count__个节点", - "local": "本地", - "remote": "远程", - "reviewChanges": "查看变更", - "noBinaryFileShowed": "无法显示二进制文件内容", - "viewCommitDiff": "查看提交更改", - "compareChanges": "比较变更", - "saveConflict": "保存冲突解决", - "conflictHeader": "已解决__unresolved__中的__resolved__个冲突", - "commonVersionError": "通用版本不包含有效的JSON：", - "oldVersionError": "旧版本不包含有效的JSON：", - "newVersionError": "新版本不包含有效的JSON：" - }, - "subflow": { - "editSubflowInstance": "编辑子流实例： __name__", - "editSubflow": "编辑流程模板： __name__", - "edit": "编辑流程模板", - "subflowInstances": "这个子流程模板有 __count__ 个实例", - "subflowInstances_plural": "这个子流程模板有 __count__ 个实例", - "editSubflowProperties": "编辑属性", - "input": "输入:", - "output": "输出:", - "status": "状态节点", - "deleteSubflow": "删除子流程", - "info": "详细描述", - "category": "类别", - "env": { - "restore": "恢复为默认子流", - "remove": "删除环境变量" - }, - "errors": { - "noNodesSelected": "无法创建子流程: 未选择节点", - "multipleInputsToSelection": "无法创建子流程: 多个输入到了选择" - } - }, - "group": { - "editGroup": "编辑组： __name__", - "errors": { - "cannotCreateDiffGroups": "无法使用来自不同组的节点创建组", - "cannotAddSubflowPorts": "无法将子流程的端口添加到组" - } + "event": { + "nodeAdded": "添加到面板中的节点:", + "nodeAdded_plural": "添加到面板中的多个节点", + "nodeRemoved": "从面板中删除的节点:", + "nodeRemoved_plural": "从面板中删除的多个节点:", + "nodeEnabled": "启用节点:", + "nodeEnabled_plural": "启用多个节点:", + "nodeDisabled": "禁用节点:", + "nodeDisabled_plural": "禁用多个节点:", + "nodeUpgraded": "节点模块__module__升级到__version__版本", + "unknownNodeRegistered": "加载节点错误：- __type__
__error__
无法安装此模块，因为它包含已安装的
节点类型
与__module__冲突
查看浏览器控制台了解更多信息", + "installFailed": "无法安装: __module__
__message__
查看日志了解更多信息", + "removeFailed": "无法删除: __module__
__message__
查看日志了解更多信息", + "updateFailed": "无法更新: __module__
__message__
查看日志了解更多信息", + "enableFailed": "无法启用: __module__
__message__
查看日志了解更多信息", + "disableFailed": "无法禁用: __module__
__message__
查看日志了解更多信息" + }, + "confirm": { + "install": { + "body": "在安装之前，请阅读节点的文档，某些节点的依赖关系不能自动解决，可能需要重新启动Node-RED。", + "title": "安装节点" }, - "types": { - "str": "字符串", - "num": "数字", - "bool": "布尔", - "json": "JSON", - "bin": "buffer", - "env": "环境变量", - "cred": "证书" + "remove": { + "body": "删除节点将从Node-RED卸载它。节点可能会继续使用资源，直到重新启动Node-RED。", + "title": "删除节点" }, - "menu": { - "input": "输入", - "select": "选择", - "checkbox": "复选框", - "spinner": "微调器", - "hidden": "仅标签" + "update": { + "body": "更新节点将需要重新启动Node-RED来完成更新，该过程必须由手动完成。", + "title": "更新节点" }, - "select": { - "label": "标签", - "value": "值" + "cannotUpdate": { + "body": "此节点的更新可用，但不会安装在面板管理器可以更新的位置。
请参阅有关如何更新此节点的文档。" }, - "spinner": { - "min": "最小值", - "max": "最大值" - }, - "errors": { - "scopeChange": "更改范围将使其他流中的节点无法使用", - "invalidProperties": "无效的属性：" + "button": { + "review": "打开节点信息", + "install": "安装", + "remove": "删除", + "update": "更新" } + } + } + }, + "sidebar": { + "info": { + "name": "节点信息", + "tabName": "名称", + "label": "信息", + "node": "节点", + "type": "类型", + "group": "组", + "module": "模组", + "id": "ID", + "status": "状态", + "enabled": "启用", + "disabled": "禁用", + "subflow": "子流程", + "instances": "实例", + "properties": "属性", + "info": "信息", + "desc": "描述", + "blank": "空白", + "null": "空", + "showMore": "展开", + "showLess": "收起", + "flow": "流程", + "selection": "选择", + "nodes": "__count__ 个节点", + "flowDesc": "流程描述", + "subflowDesc": "子流程描述", + "nodeHelp": "节点帮助", + "none": "无", + "arrayItems": "__count__ 个项目", + "showTips": "您可以从设置面板启用提示信息", + "outline": "大纲", + "empty": "空的", + "globalConfig": "全局配置节点", + "triggerAction": "触发动作", + "find": "在工作区中查找" }, - "keyboard": { - "title": "键盘快捷键", - "keyboard": "键盘", - "filterActions": "筛选动作", - "shortcut": "快捷键", - "scope": "范围", - "unassigned": "未分配", - "global": "全局", - "workspace": "工作区", - "selectAll": "选择所有节点", - "selectAllConnected": "选择所有连接的节点", - "addRemoveNode": "从选择中添加/删除节点", - "editSelected": "编辑选定节点", - "deleteSelected": "删除选定节点或链接", - "importNode": "导入节点", - "exportNode": "导出节点", - "nudgeNode": "移动所选节点(1px)", - "moveNode": "移动所选节点(20px)", - "toggleSidebar": "切换侧边栏", - "togglePalette": "切换控制板", - "copyNode": "复制所选节点", - "cutNode": "剪切所选节点", - "pasteNode": "粘贴节点", - "undoChange": "撤消上次执行的更改", - "searchBox": "打开搜索框", - "managePalette": "管理面板", - "actionList": "动作列表" + "help": { + "name": "帮助", + "label": "帮助", + "search": "搜索帮助", + "nodeHelp": "节点帮助", + "showHelp": "显示帮助", + "showInOutline": "在大纲中显示", + "showTopics": "显示主题", + "noHelp": "未选择帮助主题", + "changeLog": "更新日志" }, - "library": { - "library": "库", - "openLibrary": "打开库...", - "saveToLibrary": "保存到库...", - "typeLibrary": "__type__类型库", - "unnamedType": "无名__type__", - "exportedToLibrary": "节点导出到库", - "dialogSaveOverwrite": "一个叫做__libraryName__的__libraryType__已经存在，您需要覆盖么？", - "invalidFilename": "无效的文件名", - "savedNodes": "保存的节点", - "savedType": "已保存__type__", - "saveFailed": "保存失败: __message__", - "newFolder": "新文件夹", - "types": { - "local": "本地的", - "examples": "例子" - }, - "exportToLibrary": "将节点导出到库" + "config": { + "name": "配置节点", + "label": "配置", + "global": "所有流程", + "none": "无", + "subflows": "子流程", + "flows": "流程", + "filterAll": "所有", + "showAllConfigNodes": "显示所有配置节点", + "filterUnused": "未使用", + "showAllUnusedConfigNodes": "显示所有未使用的配置节点", + "filtered": "__count__ 个隐藏" + }, + "context": { + "name": "上下文数据", + "label": "上下文", + "none": "未选择", + "refresh": "刷新以加载", + "empty": "空", + "node": "节点", + "flow": "流程", + "global": "全局", + "deleteConfirm": "确定要删除这个项目吗？", + "autoRefresh": "刷新选择更改", + "refrsh": "刷新", + "delete": "删除" }, "palette": { - "noInfo": "无可用信息", - "filter": "过滤节点", - "search": "搜索模块", - "addCategory": "添加新的...", - "label": { - "subflows": "子流程", - "network": "网络", - "common": "共通", - "input": "输入", - "output": "输出", - "function": "功能", - "sequence": "序列", - "parser": "解析", - "social": "社交", - "storage": "存储", - "analysis": "分析", - "advanced": "高级" - }, - "actions": { - "collapse-all": "收起所有类别", - "expand-all": "展开所有类别" - }, - "event": { - "nodeAdded": "添加到面板中的节点:", - "nodeAdded_plural": "添加到面板中的多个节点", - "nodeRemoved": "从面板中删除的节点:", - "nodeRemoved_plural": "从面板中删除的多个节点:", - "nodeEnabled": "启用节点:", - "nodeEnabled_plural": "启用多个节点:", - "nodeDisabled": "禁用节点:", - "nodeDisabled_plural": "禁用多个节点:", - "nodeUpgraded": "节点模块__module__升级到__version__版本" - }, - "editor": { - "title": "面板管理", - "palette": "控制板", - "times": { - "seconds": "秒前", - "minutes": "分前", - "minutesV": "__count__ 分前", - "hoursV": "__count__ 小时前", - "hoursV_plural": "__count__ 小时前", - "daysV": "__count__ 天前", - "daysV_plural": "__count__ 天前", - "weeksV": "__count__ 周前", - "weeksV_plural": "__count__ 周前", - "monthsV": "__count__ 月前", - "monthsV_plural": "__count__ 月前", - "yearsV": "__count__ 年前", - "yearsV_plural": "__count__ 年前", - "yearMonthsV": "__y__ 年, __count__ 月前", - "yearMonthsV_plural": "__y__ 年, __count__ 月前", - "yearsMonthsV": "__y__ 年, __count__ 月前", - "yearsMonthsV_plural": "__y__ 年, __count__ 月前" - }, - "nodeCount": "__label__ 个节点", - "nodeCount_plural": "__label__ 个节点", - "moduleCount": "__count__ 个可用模块", - "moduleCount_plural": "__count__ 个可用模块", - "inuse": "使用中", - "enableall": "全部启用", - "disableall": "全部禁用", - "enable": "启用", - "disable": "禁用", - "remove": "移除", - "update": "更新至 __version__ 版本", - "updated": "已更新", - "install": "安装", - "installed": "已安装", - "conflict": "冲突", - "conflictTip": "
无法安装此模块，因为它包含已安装的
节点类型
与__module__冲突
查看浏览器控制台了解更多信息", - "installFailed": "无法安装: __module__
__message__
查看日志了解更多信息", - "removeFailed": "无法删除: __module__
__message__
查看日志了解更多信息", - "updateFailed": "无法更新: __module__
__message__
查看日志了解更多信息", - "enableFailed": "无法启用: __module__
__message__
查看日志了解更多信息", - "disableFailed": "无法禁用: __module__
__message__
查看日志了解更多信息" - }, - "confirm": { - "install": { - "body": "在安装之前，请阅读节点的文档，某些节点的依赖关系不能自动解决，可能需要重新启动Node-RED。", - "title": "安装节点" - }, - "remove": { - "body": "删除节点将从Node-RED卸载它。节点可能会继续使用资源，直到重新启动Node-RED。", - "title": "删除节点" - }, - "update": { - "body": "更新节点将需要重新启动Node-RED来完成更新，该过程必须由手动完成。", - "title": "更新节点" - }, - "cannotUpdate": { - "body": "此节点的更新可用，但不会安装在面板管理器可以更新的位置。
请参阅有关如何更新此节点的文档。" - }, - "button": { - "review": "打开节点信息", - "install": "安装", - "remove": "删除", - "update": "更新" - } - } - } + "name": "模块管理", + "label": "模块" }, - "sidebar": { - "info": { - "name": "节点信息", - "tabName": "名称", - "label": "信息", - "node": "节点", - "type": "类型", - "group": "组", - "module": "模组", - "id": "ID", - "status": "状态", - "enabled": "启用", - "disabled": "禁用", - "subflow": "子流程", - "instances": "实例", - "properties": "属性", - "info": "信息", - "desc": "描述", - "blank": "空白", - "null": "空", - "showMore": "展开", - "showLess": "收起", - "flow": "流程", - "selection": "选择", - "nodes": "__count__ 个节点", - "flowDesc": "流程描述", - "subflowDesc": "子流程描述", - "nodeHelp": "节点帮助", - "none": "无", - "arrayItems": "__count__ 个项目", - "showTips": "您可以从设置面板启用提示信息", - "outline": "大纲", - "empty": "空的", - "globalConfig": "全局配置节点", - "triggerAction": "触发动作", - "find": "在工作区中查找" - }, - "help": { - "name": "帮助", - "label": "帮助", - "search": "搜索帮助", - "nodeHelp": "节点帮助", - "showHelp": "显示帮助", - "showInOutline": "在大纲中显示", - "showTopics": "显示主题", - "noHelp": "未选择帮助主题" - }, - "config": { - "name": "配置节点", - "label": "配置", - "global": "所有流程", - "none": "无", - "subflows": "子流程", - "flows": "流程", - "filterAll": "所有", - "showAllConfigNodes": "显示所有配置节点", - "filterUnused": "未使用", - "showAllUnusedConfigNodes": "显示所有未使用的配置节点", - "filtered": "__count__ 个隐藏" - }, - "context": { - "name": "上下文数据", - "label": "上下文", - "none": "未选择", - "refresh": "刷新以加载", - "empty": "空", - "node": "节点", - "flow": "流程", - "global": "全局", - "deleteConfirm": "你确定要删除这个项目吗？", - "autoRefresh": "刷新选择更改", - "refrsh": "刷新", - "delete": "删除" - }, - "palette": { - "name": "节点管理", - "label": "节点" - }, - "project": { - "label": "项目", - "name": "项目", - "description": "描述", - "dependencies": "依赖", - "settings": "设置", - "noSummaryAvailable": "无可用摘要", - "editDescription": "编辑项目描述", - "editDependencies": "编辑项目依赖", - "noDescriptionAvailable": "没有可用的描述", - "editReadme": "编辑README.md", - "showProjectSettings": "显示项目设置", - "projectSettings": { - "title": "项目设置", - "edit": "编辑", - "none": "空", - "install": "安装", - "removeFromProject": "从项目中删除", - "addToProject": "添加到项目", - "files": "文件", - "flow": "流程", - "credentials": "证书", - "package": "包", - "packageCreate": "保存更改后将创建文件", - "fileNotExist": "文件不存在", - "selectFile": "选择文件", - "invalidEncryptionKey": "无效的加密密钥", - "encryptionEnabled": "启用加密", - "encryptionDisabled": "加密已禁用", - "setTheEncryptionKey": "设置加密密钥", - "resetTheEncryptionKey": "重置加密密钥", - "changeTheEncryptionKey": "更改加密密钥", - "currentKey": "当前密钥", - "newKey": "新密钥", - "credentialsAlert": "这将删除所有现有证书", - "versionControl": "版本控制", - "branches": "分支", - "noBranches": "没有分支", - "deleteConfirm": "您确定要删除本地分支'__name__'吗？ 这不能被撤消。", - "unmergedConfirm": "本地分支'__name__'具有未合并的更改，这些更改将丢失。你确定要删除吗？", - "deleteUnmergedBranch": "删除未合并的分支", - "gitRemotes": "Git远程仓库", - "addRemote": "添加远程仓库", - "addRemote2": "添加远程仓库", - "remoteName": "远程仓库名", - "nameRule": "只能包含A-Z 0-9 _ -", - "url": "URL", - "urlRule": "https://, ssh:// or file://", - "urlRule2": "网址中不能包含用户名/密码", - "noRemotes": "没有远程仓库", - "deleteRemoteConfrim": "您确定要删除远程仓库'__name__'吗？", - "deleteRemote": "删除远程仓库" - }, - "userSettings": { - "committerDetail": "提交者详细信息", - "committerTip": "保留空白以使用系统默认值", - "userName": "用户名", - "email": "电子邮件", - "workflow": "工作流", - "workfowTip": "选择您偏好的工作流", - "workflowManual": "手动", - "workflowManualTip": "所有更改都必须在“历史记录”侧边栏中手动提交", - "workflowAuto": "自动", - "workflowAutoTip": "每次部署后都会自动提交更改", - "sshKeys": "SSH密钥", - "sshKeysTip": "允许您创建到远程git存储库的安全连接。", - "add": "添加密钥", - "addSshKey": "添加SSH密钥", - "addSshKeyTip": "生成新的公钥/私钥对", - "name": "名字", - "nameRule": "只能包含A-Z 0-9 _ -", - "passphrase": "密码短语", - "passphraseShort": "密码短语过短", - "optional": "可选的", - "cancel": "取消", - "generate": "生成密钥", - "noSshKeys": "没有SSH密钥", - "copyPublicKey": "将公钥复制到剪贴板", - "delete": "删除密钥", - "gitConfig": "Git配置", - "deleteConfirm": "您确定要删除SSH密钥 __name__ 吗？这不能被撤消。" - }, - "versionControl": { - "unstagedChanges": "未暂存的变更", - "stagedChanges": "暂存的变更", - "unstageChange": "取消变更的暂存", - "stageChange": "暂存变更", - "unstageAllChange": "取消所有变更的暂存", - "stageAllChange": "暂存所有变更", - "commitChanges": "提交变更", - "resolveConflicts": "解决冲突", - "head": "HEAD", - "staged": "暂存的", - "unstaged": "未暂存的", - "local": "本地的", - "remote": "远程的", - "revert": "您确定要将更改恢复为'__file__'吗？这不能被撤消。", - "revertChanges": "还原变更", - "localChanges": "本地变更", - "none": "None", - "conflictResolve": "解决所有冲突。提交更改以完成合并。", - "localFiles": "本地文件", - "all": "所有的", - "unmergedChanges": "未合并的更改", - "abortMerge": "中止合并", - "commit": "提交", - "changeToCommit": "提交变更", - "commitPlaceholder": "输入您的提交信息", - "cancelCapital": "取消", - "commitCapital": "提交", - "commitHistory": "提交历史", - "branch": "分支:", - "moreCommits": "更多提交", - "changeLocalBranch": "变更本地分支", - "createBranchPlaceholder": "查找或创建分支", - "upstream": "上游", - "localOverwrite": "切换分支会覆盖您现有的本地更改。您必须先提交或撤消那些更改。", - "manageRemoteBranch": "管理远程分支", - "unableToAccess": "无法访问远程存储库", - "retry": "重试", - "setUpstreamBranch": "设置为上游分支", - "createRemoteBranchPlaceholder": "查找或创建远程分支", - "trackedUpstreamBranch": "创建的分支将被设置为跟踪的上游分支。", - "selectUpstreamBranch": "分支将被创建。 在下面选择以将其设置为被跟踪的上游分支。", - "pushFailed": "推送失败，因为远程具有更多的最新提交。请先拉取并合并，然后再尝试推送。", - "push": "推送", - "pull": "拉取", - "unablePull": "
无法提取远程更改；您未暂存的本地更改将被覆盖。
请先提交更改，然后重试。
", - "showUnstagedChanges": "显示未暂存的更改", - "connectionFailed": "无法连接到远程存储库：", - "pullUnrelatedHistory": "远程有无关的提交历史
您确定要将这些更改拉入本地仓库吗？
", - "pullChanges": "拉取更改", - "history": "历史", - "projectHistory": "项目历史", - "daysAgo": "__count__ 天前", - "daysAgo_plural": "__count__ 天前", - "hoursAgo": "__count__ 小时前", - "hoursAgo_plural": "__count__ 小时前", - "minsAgo": "__count__ 分钟前", - "minsAgo_plural": "__count__ 分钟前", - "secondsAgo": "秒前", - "notTracking": "您的本地分支当前未跟踪一个远程分支。", - "statusUnmergedChanged": "您的仓库中有未合并的更改。您需要解决冲突并提交结果。", - "repositoryUpToDate": "您的仓库是最新的。", - "commitsAhead": "您的存储库领先远程仓库 __count__ 次提交。您现在可以推送这些提交。", - "commitsAhead_plural": "您的存储库领先远程仓库 __count__ 次提交。您现在可以推送这些提交。", - "commitsBehind": "您的存储库落后远程仓库 __count__ 次提交。您现在可以拉取这些提交。", - "commitsBehind_plural": "您的存储库落后远程仓库 __count__ 次提交。您现在可以拉取这些提交。", - "commitsAheadAndBehind1": "您的存储库落后远程仓库 __count__ 次提交", - "commitsAheadAndBehind1_plural": "您的存储库落后远程仓库 __count__ 次提交", - "commitsAheadAndBehind2": "领先远程仓库 __count__ 次提交。", - "commitsAheadAndBehind2_plural": "领先远程仓库 __count__ 次提交。", - "commitsAheadAndBehind3": "您必须先拉取远程提交，然后才能进行推送。", - "commitsAheadAndBehind3_plural": "您必须先拉取远程提交，然后才能进行推送。", - "refreshCommitHistory": "刷新提交历史", - "refreshChanges": "刷新更改" - } - } + "project": { + "label": "项目", + "name": "项目", + "description": "描述", + "dependencies": "依赖", + "settings": "设置", + "noSummaryAvailable": "无可用摘要", + "editDescription": "编辑项目描述", + "editDependencies": "编辑项目依赖", + "noDescriptionAvailable": "没有可用的描述", + "editReadme": "编辑README.md", + "showProjectSettings": "显示项目设置", + "projectSettings": { + "title": "项目设置", + "edit": "编辑", + "none": "空", + "install": "安装", + "removeFromProject": "从项目中删除", + "addToProject": "添加到项目", + "files": "文件", + "flow": "流程", + "credentials": "证书", + "package": "包", + "packageCreate": "保存更改后将创建文件", + "fileNotExist": "文件不存在", + "selectFile": "选择文件", + "invalidEncryptionKey": "无效的加密密钥", + "encryptionEnabled": "启用加密", + "encryptionDisabled": "加密已禁用", + "setTheEncryptionKey": "设置加密密钥", + "resetTheEncryptionKey": "重置加密密钥", + "changeTheEncryptionKey": "更改加密密钥", + "currentKey": "当前密钥", + "newKey": "新密钥", + "credentialsAlert": "将删除所有现有证书", + "versionControl": "版本控制", + "branches": "分支", + "noBranches": "没有分支", + "deleteConfirm": "您确定要删除本地分支'__name__'吗？ 这不能被撤消。", + "unmergedConfirm": "本地分支'__name__'具有未合并的更改，这些更改将丢失。你确定要删除吗？", + "deleteUnmergedBranch": "删除未合并的分支", + "gitRemotes": "Git远程仓库", + "addRemote": "添加远程仓库", + "addRemote2": "添加远程仓库", + "remoteName": "远程仓库名", + "nameRule": "只能包含A-Z 0-9 _ -", + "url": "URL", + "urlRule": "https://, ssh:// 或 file://", + "urlRule2": "网址中不能包含用户名/密码", + "noRemotes": "没有远程仓库", + "deleteRemoteConfrim": "您确定要删除远程仓库'__name__'吗？", + "deleteRemote": "删除远程仓库" + }, + "userSettings": { + "committerDetail": "提交者详细信息", + "committerTip": "保留空白以使用系统默认值", + "userName": "用户名", + "email": "电子邮件", + "workflow": "工作流", + "workfowTip": "选择您偏好的工作流", + "workflowManual": "手动", + "workflowManualTip": "所有更改都必须在“历史记录”侧边栏中手动提交", + "workflowAuto": "自动", + "workflowAutoTip": "每次部署后都会自动提交更改", + "sshKeys": "SSH密钥", + "sshKeysTip": "允许您创建到远程git存储库的安全连接。", + "add": "添加密钥", + "addSshKey": "添加SSH密钥", + "addSshKeyTip": "生成新的公钥/私钥对", + "name": "名字", + "nameRule": "只能包含A-Z 0-9 _ -", + "passphrase": "密码短语", + "passphraseShort": "密码短语过短", + "optional": "可选的", + "cancel": "取消", + "generate": "生成密钥", + "noSshKeys": "没有SSH密钥", + "copyPublicKey": "将公钥复制到剪贴板", + "delete": "删除密钥", + "gitConfig": "Git配置", + "deleteConfirm": "您确定要删除SSH密钥 __name__ 吗？这不能被撤消。" + }, + "versionControl": { + "unstagedChanges": "未暂存的变更", + "stagedChanges": "暂存的变更", + "unstageChange": "取消变更的暂存", + "stageChange": "暂存变更", + "unstageAllChange": "取消所有变更的暂存", + "stageAllChange": "暂存所有变更", + "commitChanges": "提交变更", + "resolveConflicts": "解决冲突", + "head": "HEAD", + "staged": "暂存的", + "unstaged": "未暂存的", + "local": "本地的", + "remote": "远程的", + "revert": "您确定要将更改恢复为'__file__'吗？这不能被撤消。", + "revertChanges": "还原变更", + "localChanges": "本地变更", + "none": "None", + "conflictResolve": "解决所有冲突。提交更改以完成合并。", + "localFiles": "本地文件", + "all": "所有的", + "unmergedChanges": "未合并的更改", + "abortMerge": "中止合并", + "commit": "提交", + "changeToCommit": "提交变更", + "commitPlaceholder": "输入您的提交信息", + "cancelCapital": "取消", + "commitCapital": "提交", + "commitHistory": "提交历史", + "branch": "分支:", + "moreCommits": "更多提交", + "changeLocalBranch": "变更本地分支", + "createBranchPlaceholder": "查找或创建分支", + "upstream": "上游", + "localOverwrite": "切换分支会覆盖您现有的本地更改。您必须先提交或撤消那些更改。", + "manageRemoteBranch": "管理远程分支", + "unableToAccess": "无法访问远程存储库", + "retry": "重试", + "setUpstreamBranch": "设置为上游分支", + "createRemoteBranchPlaceholder": "查找或创建远程分支", + "trackedUpstreamBranch": "创建的分支将被设置为跟踪的上游分支。", + "selectUpstreamBranch": "分支将被创建。 在下面选择以将其设置为被跟踪的上游分支。", + "pushFailed": "推送失败，因为远程具有更多的最新提交。请先拉取并合并，然后再尝试推送。", + "push": "推送", + "pull": "拉取", + "unablePull": "无法提取远程更改；您未暂存的本地更改将被覆盖。
请先提交更改，然后重试。
", + "showUnstagedChanges": "显示未暂存的更改", + "connectionFailed": "无法连接到远程存储库：", + "pullUnrelatedHistory": "远程有无关的提交历史
您确定要将这些更改拉入本地仓库吗？
", + "pullChanges": "拉取更改", + "history": "历史", + "projectHistory": "项目历史", + "daysAgo": "__count__ 天前", + "daysAgo_plural": "__count__ 天前", + "hoursAgo": "__count__ 小时前", + "hoursAgo_plural": "__count__ 小时前", + "minsAgo": "__count__ 分钟前", + "minsAgo_plural": "__count__ 分钟前", + "secondsAgo": "秒前", + "notTracking": "您的本地分支当前未跟踪一个远程分支。", + "statusUnmergedChanged": "您的仓库中有未合并的更改。您需要解决冲突并提交结果。", + "repositoryUpToDate": "您的仓库是最新的。", + "commitsAhead": "您的存储库领先远程仓库 __count__ 次提交。您现在可以推送这些提交。", + "commitsAhead_plural": "您的存储库领先远程仓库 __count__ 次提交。您现在可以推送这些提交。", + "commitsBehind": "您的存储库落后远程仓库 __count__ 次提交。您现在可以拉取这些提交。", + "commitsBehind_plural": "您的存储库落后远程仓库 __count__ 次提交。您现在可以拉取这些提交。", + "commitsAheadAndBehind1": "您的存储库落后远程仓库 __count__ 次提交", + "commitsAheadAndBehind1_plural": "您的存储库落后远程仓库 __count__ 次提交", + "commitsAheadAndBehind2": "领先远程仓库 __count__ 次提交。", + "commitsAheadAndBehind2_plural": "领先远程仓库 __count__ 次提交。", + "commitsAheadAndBehind3": "您必须先拉取远程提交，然后才能进行推送。", + "commitsAheadAndBehind3_plural": "您必须先拉取远程提交，然后才能进行推送。", + "refreshCommitHistory": "刷新提交历史", + "refreshChanges": "刷新更改" + } + } + }, + "typedInput": { + "type": { + "str": "文本", + "num": "数字", + "re": "正则表达式", + "bool": "布尔值", + "json": "JSON", + "bin": "二进制流", + "date": "时间戳", + "jsonata": "表达式", + "env": "环境变量", + "cred": "证书" + } + }, + "editableList": { + "add": "添加", + "addTitle": "添加项" + }, + "search": { + "history": "搜索历史", + "clear": "清除所有", + "empty": "找不到匹配项", + "addNode": "添加节点...", + "options": { + "configNodes": "配置节点", + "unusedConfigNodes": "未使用的配置节点", + "invalidNodes": "无效的节点", + "uknownNodes": "未知的节点", + "unusedSubflows": "未使用的子流程", + "hiddenFlows": "隐藏的流程", + "modifiedNodes": "已修改的节点或流程", + "thisFlow": "当前流程" + } + }, + "expressionEditor": { + "functions": "函数", + "functionReference": "函数引用", + "insert": "插入", + "title": "JSONata 表达式编辑器", + "test": "测试", + "data": "示例消息", + "result": "结果", + "format": "格式表达式", + "compatMode": "兼容模式启用", + "compatModeDesc": "JSONata的兼容模式
目前的表达式仍然参考msg，所以将以兼容性模式进行评估。请更新表达式，使其不使用msg，因为此模式将在将来删除。
当JSONata支持首次添加到Node-RED时，它需要表达式引用msg对象。例如msg.payload将用于访问有效负载。
这样便不再需要表达式直接针对消息进行评估。要访问有效负载，表达式应该只是payload.
Buffer 编辑器
Buffer类型被存储为字节值的JSON数组。编辑器将尝试将输入的数值解析为JSON数组。如果它不是有效的JSON，它将被视为UTF-8字符串，并被转换为单个字符代码点的数组。
例如，Hello World的值会被转换为JSON数组：
[72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100]" + }, + "projects": { + "config-git": "配置Git客户端", + "welcome": { + "hello": "你好！ 我们已经将“项目”引入了Node-RED。", + "desc0": "这是一种用于管理流程文件的新方法，并且包括对流程的版本控制。", + "desc1": "首先，您可以创建您的第一个项目或从git存储库克隆现有项目。", + "desc2": "如果不确定，可以暂时跳过此步骤。您仍然可以随时通过“项目”菜单创建第一个项目。", + "create": "建立专案", + "clone": "克隆仓库", + "openExistingProject": "打开现有项目", + "not-right-now": "稍后" }, - "typedInput": { - "type": { - "str": "文字列", - "num": "数字", - "re": "正则表达式", - "bool": "布尔值", - "json": "JSON", - "bin": "二进制流", - "date": "时间戳", - "jsonata": "表达式", - "env": "环境变量", - "cred": "证书" - } + "git-config": { + "setup": "设置您的版本控制客户端", + "desc0": "Node-RED使用开源工具Git进行版本控制。它跟踪对项目文件的更改，并允许您将其推送到远程存储库。", + "desc1": "提交一组更改时，Git会使用用户名和电子邮件地址记录谁进行了更改。用户名可以是您想要的任何名称-不必是您的真实姓名。", + "desc2": "您的Git客户端已经配置了以下详细信息。", + "desc3": "您可以稍后在设置对话框的'Git config'标签下更改这些设置。", + "username": "用户名", + "email": "电子邮件" }, - "editableList": { - "add": "添加" + "project-details": { + "create": "创建你的项目", + "desc0": "项目被维护为Git仓库。与他人一起共享您的流程", + "desc1": "您可以创建多个项目，并通过编辑器在它们之间快速切换。", + "desc2": "首先，您的项目需要一个名称和一个可选的描述。", + "already-exists": "项目已存在", + "must-contain": "只能包含A-Z 0-9 _ -", + "project-name": "项目名", + "desc": "描述", + "opt": "可选的" }, - "search": { - "empty": "找不到匹配", - "addNode": "添加一个节点...", - "options": { - "configNodes": "配置节点", - "unusedConfigNodes": "未使用的配置节点", - "invalidNodes": "无效的节点", - "uknownNodes": "未知的节点", - "unusedSubflows": "未使用的子流程" - } + "clone-project": { + "clone": "克隆一个项目", + "desc0": "如果您已经有一个包含项目的git仓库，则可以对其进行克隆以开始使用。", + "already-exists": "项目已存在", + "must-contain": "只能包含A-Z 0-9 _ -", + "project-name": "项目名", + "no-info-in-url": "网址中不要包含用户名/密码", + "git-url": "Git仓库的url", + "protocols": "https://, ssh:// or file://", + "auth-failed": "认证失败", + "username": "用户名", + "passwd": "秘密啊", + "ssh-key": "SSH密钥", + "passphrase": "密码短语", + "ssh-key-desc": "在通过ssh克隆仓库之前，必须添加SSH密钥才能访问它。", + "ssh-key-add": "添加一个ssh密钥", + "credential-key": "证书加密密钥", + "cant-get-ssh-key": "错误！ 无法获取所选的SSH密钥路径。", + "already-exists2": "已存在", + "git-error": "git错误", + "connection-failed": "连接失败", + "not-git-repo": "不是一个git仓库", + "repo-not-found": "未发现仓库" }, - "expressionEditor": { - "functions": "功能", - "functionReference": "功能reference", - "insert": "插入", - "title": "JSONata表达式编辑器", - "test": "测试", - "data": "示例消息", - "result": "结果", - "format": "格式表达方法", - "compatMode": "兼容模式启用", - "compatModeDesc": "
JSONata的兼容模式
目前的表达式仍然参考msg，所以将以兼容性模式进行评估。请更新表达式，使其不使用msg，因为此模式将在将来删除。
当JSONata支持首次添加到Node-RED时，它需要表达式引用msg对象。例如msg.payload将用于访问有效负载。
这样便不再需要表达式直接针对消息进行评估。要访问有效负载，表达式应该只是payload.
缓冲区编辑器
缓冲区类型被存储为字节值的JSON数组。编辑器将尝试将输入的数值解析为JSON数组。如果它不是有效的JSON，它将被视为UTF-8字符串，并被转换为单个字符代码点的数组。
例如，Hello World的值会被转换为JSON数组：
[72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100]" + "create-project-list": { + "search": "搜索您的项目", + "current": "当前的" }, - "projects": { - "config-git": "配置Git客户端", - "welcome": { - "hello": "你好！ 我们已经将“项目”引入了Node-RED。", - "desc0": "这是一种用于管理流程文件的新方法，并且包括对流程的版本控制。", - "desc1": "首先，您可以创建您的第一个项目或从git存储库克隆现有项目。", - "desc2": "如果不确定，可以暂时跳过此步骤。您仍然可以随时通过“项目”菜单创建第一个项目。", - "create": "建立专案", - "clone": "克隆仓库", - "openExistingProject": "打开现有项目", - "not-right-now": "不是现在" - }, - "git-config": { - "setup": "设置您的版本控制客户端", - "desc0": "Node-RED使用开源工具Git进行版本控制。它跟踪对项目文件的更改，并允许您将其推送到远程存储库。", - "desc1": "提交一组更改时，Git会使用用户名和电子邮件地址记录谁进行了更改。用户名可以是您想要的任何名称-不必是您的真实姓名。", - "desc2": "您的Git客户端已经配置了以下详细信息。", - "desc3": "您可以稍后在设置对话框的'Git config'标签下更改这些设置。", - "username": "用户名", - "email": "电子邮件" - }, - "project-details": { - "create": "创建你的项目", - "desc0": "项目被维护为Git仓库。与他人一起共享您的流程", - "desc1": "您可以创建多个项目，并通过编辑器在它们之间快速切换。", - "desc2": "首先，您的项目需要一个名称和一个可选的描述。", - "already-exists": "项目已存在", - "must-contain": "只能包含A-Z 0-9 _ -", - "project-name": "项目名", - "desc": "描述", - "opt": "可选的" - }, - "clone-project": { - "clone": "克隆一个项目", - "desc0": "如果您已经有一个包含项目的git仓库，则可以对其进行克隆以开始使用。", - "already-exists": "项目已存在", - "must-contain": "只能包含A-Z 0-9 _ -", - "project-name": "项目名", - "no-info-in-url": "网址中不要包含用户名/密码", - "git-url": "Git仓库的url", - "protocols": "https://, ssh:// or file://", - "auth-failed": "认证失败", - "username": "用户名", - "passwd": "秘密啊", - "ssh-key": "SSH密钥", - "passphrase": "密码短语", - "ssh-key-desc": "在通过ssh克隆仓库之前，必须添加SSH密钥才能访问它。", - "ssh-key-add": "添加一个ssh密钥", - "credential-key": "证书加密密钥", - "cant-get-ssh-key": "错误！ 无法获取所选的SSH密钥路径。", - "already-exists2": "已存在", - "git-error": "git错误", - "connection-failed": "连接失败", - "not-git-repo": "不是一个git仓库", - "repo-not-found": "未发现仓库" - }, - "default-files": { - "create": "创建您的项目文件", - "desc0": "一个包含您的流程文件，Readme文件和package.json文件的项目。", - "desc1": "它可以包含您要在Git仓库中维护的任何其他文件。", - "desc2": "您现有的流程和凭证文件将被复制到项目中。", - "flow-file": "流程文件", - "credentials-file": "证书文件" - }, - "encryption-config": { - "setup": "设置证书文件的加密", - "desc0": "您的流程证书文件可以被加密以确保其内容安全。", - "desc1": "如果要将这些证书存储在公共Git存储库中，则必须通过提供密钥短语来对它们进行加密。", - "desc2": "您的流程证书文件当前未加密。", - "desc3": "这意味着任何有权访问该文件的人都可以读取其内容，例如密码和访问令牌。", - "desc4": "如果要将这些证书存储在公共Git仓库中，则必须通过提供密钥短语来对它们进行加密。", - "desc5": "当前，使用设置文件中的credentialSecret属性作为密钥来加密流程证书文件。", - "desc6": "您的流程证书文件当前使用系统生成的密钥加密。您应该为此项目提供一个新的密钥。", - "desc7": "密钥将与项目文件分开存储。您将需要提供在另一个Node-RED实例中使用该项目的密钥。", - "credentials": "证书", - "enable": "启用加密", - "disable": "禁用加密", - "disabled": "禁用的", - "copy": "复制现有密钥", - "use-custom": "使用自定义密钥", - "desc8": "证书文件不会被加密，其内容很容易阅读", - "create-project-files": "创建项目文件", - "create-project": "创建项目", - "already-exists": "已存在", - "git-error": "git错误", - "git-auth-error": "git认证错误" - }, - "create-success": { - "success": "您已经成功创建了第一个项目！", - "desc0": "现在，您可以像往常一样继续使用Node-RED。", - "desc1": "侧栏中的“信息”标签显示了您当前的活动项目。名称旁边的按钮可用于访问项目设置视图。", - "desc2": "侧栏中的“历史记录”标签可用于查看项目中已更改的文件并提交。它向您显示了提交的完整历史记录，并允许您将更改推送到远程存储库。" - }, - "create": { - "projects": "项目", - "already-exists": "项目已存在", - "must-contain": "只能包含A-Z 0-9 _ -", - "no-info-in-url": "网址中不要包含用户名/密码", - "open": "打开项目", - "create": "创建项目", - "clone": "克隆仓库", - "project-name": "项目名", - "desc": "描述", - "opt": "可选的", - "flow-file": "流程文件", - "credentials": "证书", - "enable-encryption": "启用加密", - "disable-encryption": "禁用加密", - "encryption-key": "加密密钥", - "desc0": "用来保护您的凭证的短语", - "desc1": "凭证文件不会被加密，其内容很容易阅读", - "git-url": "Git存储库URL", - "protocols": "https://, ssh:// or file://", - "auth-failed": "验证失败", - "username": "用户名", - "password": "密码", - "ssh-key": "SSH密钥", - "passphrase": "密码短语", - "desc2": "在通过ssh克隆存储库之前，必须添加SSH密钥才能访问它。", - "add-ssh-key": "添加一个ssh密钥", - "credentials-encryption-key": "证书加密密钥", - "already-exists-2": "已存在", - "git-error": "git错误", - "con-failed": "连接失败", - "not-git": "不是git仓库", - "no-resource": "找不到存储库", - "cant-get-ssh-key-path": "错误！无法获取所选的SSH密钥路径。", - "unexpected_error": "意外的错误" - }, - "delete": { - "confirm": "您确定要删除此项目吗？" - }, - "create-project-list": { - "search": "搜索您的项目", - "current": "当前的" - }, - "require-clean": { - "confirm": "
您有未部署的更改，这些更改将丢失。
您要继续吗？
" - }, - "send-req": { - "auth-req": "存储库需要认证", - "username": "用户名", - "password": "秘密", - "passphrase": "密码短语", - "retry": "重试", - "update-failed": "无法更新身份验证", - "unhandled": "未处理的错误响应", - "host-key-verify-failed": "主机密钥验证失败。
无法验证存储库主机密钥。请更新您的known_hosts文件，然后重试。
您有未部署的更改，这些更改将丢失。
您要继续吗？
" }, - "editor-tab": { - "properties": "属性", - "envProperties": "环境变量", - "description": "描述", - "appearance": "外观", - "preview": "UI预览", - "defaultValue": "默认值" + "send-req": { + "auth-req": "存储库需要认证", + "username": "用户名", + "password": "秘密", + "passphrase": "密码短语", + "retry": "重试", + "update-failed": "无法更新身份验证", + "unhandled": "未处理的错误响应", + "host-key-verify-failed": "主机密钥验证失败。
无法验证存储库主机密钥。请更新您的known_hosts文件，然后重试。
' + RED._("deploy.successfulDeploy") + '
', "success"); } + const flowsToLock = new Set() + function ensureUnlocked(id) { + const flow = id && (RED.nodes.workspace(id) || RED.nodes.subflow(id) || null); + const isLocked = flow ? flow.locked : false; + if (flow && isLocked) { + flow.locked = false; + flowsToLock.add(flow) + } + } RED.nodes.eachNode(function (node) { + ensureUnlocked(node.z) if (node.changed) { node.dirty = true; node.changed = false; @@ -570,7 +580,32 @@ RED.deploy = (function() { delete node.credentials; } }); + RED.nodes.eachGroup(function (node) { + ensureUnlocked(node.z) + if (node.changed) { + node.dirty = true; + node.changed = false; + } + if (node.moved) { + node.dirty = true; + node.moved = false; + } + }) + RED.nodes.eachJunction(function (node) { + ensureUnlocked(node.z) + if (node.changed) { + node.dirty = true; + node.changed = false; + } + if (node.moved) { + node.dirty = true; + node.moved = false; + } + }) RED.nodes.eachConfig(function (confNode) { + if (confNode.z) { + ensureUnlocked(confNode.z) + } confNode.changed = false; if (confNode.credentials) { delete confNode.credentials; @@ -580,8 +615,16 @@ RED.deploy = (function() { subflow.changed = false; }); RED.nodes.eachWorkspace(function (ws) { - ws.changed = false; + if (ws.changed || ws.added) { + ensureUnlocked(ws.z) + ws.changed = false; + delete ws.added + RED.events.emit("flows:change", ws) + } }); + flowsToLock.forEach(flow => { + flow.locked = true + }) // Once deployed, cannot undo back to a clean state RED.history.markAllDirty(); RED.view.redraw(); diff --git a/packages/node_modules/@node-red/editor-client/src/js/ui/editor.js b/packages/node_modules/@node-red/editor-client/src/js/ui/editor.js index 188819734..0ef3892e7 100644 --- a/packages/node_modules/@node-red/editor-client/src/js/ui/editor.js +++ b/packages/node_modules/@node-red/editor-client/src/js/ui/editor.js @@ -720,7 +720,10 @@ RED.editor = (function() { if (typeof editing_node[d] === "string" || typeof editing_node[d] === "number") { oldValues[d] = editing_node[d]; } else { - oldValues[d] = $.extend(true,{},{v:editing_node[d]}).v; + // Dont clone the group node `nodes` array + if (editing_node.type !== 'group' || d !== "nodes") { + oldValues[d] = $.extend(true,{},{v:editing_node[d]}).v; + } } } } @@ -862,6 +865,7 @@ RED.editor = (function() { function showEditDialog(node, defaultTab) { if (buildingEditDialog) { return } buildingEditDialog = true; + if (node.z && RED.workspaces.isLocked(node.z)) { return } var editing_node = node; var removeInfoEditorOnClose = false; var skipInfoRefreshOnClose = false; @@ -1047,6 +1051,13 @@ RED.editor = (function() { var trayFooterLeft = $('').appendTo(trayFooter) + var helpButton = $('').on("click", function(evt) { + evt.preventDefault(); + evt.stopPropagation(); + RED.sidebar.help.show(editing_node.type); + }).appendTo(trayFooterLeft); + RED.popover.tooltip(helpButton, RED._("sidebar.help.showHelp")); + $('').prop("checked",!!node.d).appendTo(trayFooterLeft).toggleButton({ enabledIcon: "fa-circle-thin", disabledIcon: "fa-ban", @@ -1150,6 +1161,8 @@ RED.editor = (function() { var editing_config_node = RED.nodes.node(id); var activeEditPanes = []; + if (editing_config_node && editing_config_node.z && RED.workspaces.isLocked(editing_config_node.z)) { return } + var configNodeScope = ""; // default to global var activeSubflow = RED.nodes.subflow(RED.workspaces.active()); if (activeSubflow) { @@ -1192,6 +1205,13 @@ RED.editor = (function() { var trayFooterLeft = $('').appendTo(trayFooter) + var helpButton = $('').on("click", function(evt) { + evt.preventDefault(); + evt.stopPropagation(); + RED.sidebar.help.show(editing_config_node.type); + }).appendTo(trayFooterLeft); + RED.popover.tooltip(helpButton, RED._("sidebar.help.showHelp")); + $('').prop("checked",!!editing_config_node.d).appendTo(trayFooterLeft).toggleButton({ enabledIcon: "fa-circle-thin", disabledIcon: "fa-ban", @@ -1696,6 +1716,7 @@ RED.editor = (function() { function showEditGroupDialog(group, defaultTab) { if (buildingEditDialog) { return } buildingEditDialog = true; + if (group.z && RED.workspaces.isLocked(group.z)) { return } var editing_node = group; editStack.push(group); RED.view.state(RED.state.EDITING); @@ -1855,11 +1876,15 @@ RED.editor = (function() { workspace.disabled = disabled; $("#red-ui-tab-"+(workspace.id.replace(".","-"))).toggleClass('red-ui-workspace-disabled',!!workspace.disabled); - if (workspace.id === RED.workspaces.active()) { - $("#red-ui-workspace").toggleClass("red-ui-workspace-disabled",!!workspace.disabled); - } } + var locked = $("#node-input-locked").prop("checked"); + if (workspace.locked !== locked) { + editState.changes.locked = workspace.locked; + editState.changed = true; + workspace.locked = locked; + $("#red-ui-tab-"+(workspace.id.replace(".","-"))).toggleClass('red-ui-workspace-locked',!!workspace.locked); + } if (editState.changed) { var historyEvent = { t: "edit", @@ -1900,6 +1925,7 @@ RED.editor = (function() { var trayBody = tray.find('.red-ui-tray-body'); trayBody.parent().css('overflow','hidden'); var trayFooterLeft = $('').appendTo(trayFooter) + var trayFooterRight = $('').appendTo(trayFooter) var nodeEditPanes = [ 'editor-tab-flow-properties', @@ -1914,6 +1940,18 @@ RED.editor = (function() { disabledIcon: "fa-ban", invertState: true }) + + if (!workspace.hasOwnProperty("locked")) { + workspace.locked = false; + } + $('').prop("checked",workspace.locked).appendTo(trayFooterRight).toggleButton({ + enabledLabel: RED._("common.label.unlocked"), + enabledIcon: "fa-unlock-alt", + disabledLabel: RED._("common.label.locked"), + disabledIcon: "fa-lock", + invertState: true + }) + prepareEditDialog(trayBody, nodeEditPanes, workspace, {}, "node-input", defaultTab, function(_activeEditPanes) { activeEditPanes = _activeEditPanes; trayBody.i18n(); diff --git a/packages/node_modules/@node-red/editor-client/src/js/ui/editors/code-editor.js b/packages/node_modules/@node-red/editor-client/src/js/ui/editors/code-editor.js index 7cee2026b..b92881764 100644 --- a/packages/node_modules/@node-red/editor-client/src/js/ui/editors/code-editor.js +++ b/packages/node_modules/@node-red/editor-client/src/js/ui/editors/code-editor.js @@ -45,6 +45,9 @@ selectedCodeEditor = RED.editor.codeEditor[defaultEditor]; initialised = selectedCodeEditor.init(); } + + $(''+
'')).appendTo(container);
description.find(".red-ui-text-bidi-aware").contents().filter(function() { return this.nodeType === 3 && this.textContent.trim() !== "" }).wrap( "" );
+ setTimeout(function () {
+ mermaid.init();
+ }, 200);
}
function editSummary(activeProject, summary, container, version, versionContainer) {
diff --git a/packages/node_modules/@node-red/editor-client/src/js/ui/subflow.js b/packages/node_modules/@node-red/editor-client/src/js/ui/subflow.js
index abe6402db..da38e6054 100644
--- a/packages/node_modules/@node-red/editor-client/src/js/ui/subflow.js
+++ b/packages/node_modules/@node-red/editor-client/src/js/ui/subflow.js
@@ -46,7 +46,9 @@ RED.subflow = (function() {
'';
function findAvailableSubflowIOPosition(subflow,isInput) {
- var pos = {x:50,y:30};
+ const scrollPos = RED.view.scroll()
+ const scaleFactor = RED.view.scale()
+ var pos = { x: (scrollPos[0]/scaleFactor)+50, y: (scrollPos[1]/scaleFactor)+30 };
if (!isInput) {
pos.x += 110;
}
@@ -273,6 +275,11 @@ RED.subflow = (function() {
var subflowInstances = [];
if (activeSubflow) {
RED.nodes.filterNodes({type:"subflow:"+activeSubflow.id}).forEach(function(n) {
+ const parentFlow = RED.nodes.workspace(n.z)
+ const wasLocked = parentFlow && parentFlow.locked
+ if (wasLocked) {
+ parentFlow.locked = false
+ }
subflowInstances.push({
id: n.id,
changed: n.changed
@@ -285,6 +292,9 @@ RED.subflow = (function() {
n.resize = true;
n.dirty = true;
RED.editor.updateNodeProperties(n);
+ if (wasLocked) {
+ parentFlow.locked = true
+ }
});
RED.editor.validateNode(activeSubflow);
return {
@@ -431,44 +441,7 @@ RED.subflow = (function() {
$("#red-ui-subflow-delete").on("click", function(event) {
event.preventDefault();
- var subflow = RED.nodes.subflow(RED.workspaces.active());
- if (subflow.instances.length > 0) {
- var msg = $('
')
- $('
').text(RED._("subflow.subflowInstances",{count: subflow.instances.length})).appendTo(msg); - $('
').text(RED._("subflow.confirmDelete")).appendTo(msg); - var confirmDeleteNotification = RED.notify(msg, { - modal: true, - fixed: true, - buttons: [ - { - text: RED._('common.label.cancel'), - click: function() { - confirmDeleteNotification.close(); - } - }, - { - text: RED._('workspace.confirmDelete'), - class: "primary", - click: function() { - confirmDeleteNotification.close(); - completeDelete(); - } - } - ] - }); - - return; - } else { - completeDelete(); - } - function completeDelete() { - var startDirty = RED.nodes.dirty(); - var historyEvent = removeSubflow(RED.workspaces.active()); - historyEvent.t = 'delete'; - historyEvent.dirty = startDirty; - RED.history.push(historyEvent); - } - + RED.subflow.delete(RED.workspaces.active()) }); refreshToolbar(activeSubflow); @@ -481,7 +454,51 @@ RED.subflow = (function() { $("#red-ui-workspace-toolbar").hide().empty(); $("#red-ui-workspace-chart").css({"margin-top": "0"}); } + function deleteSubflow(id) { + const subflow = RED.nodes.subflow(id || RED.workspaces.active()); + if (!subflow) { + return + } + if (subflow.instances.length > 0) { + if (subflow.instances.some(sf => { const ws = RED.nodes.workspace(sf.z); return ws?ws.locked:false })) { + return + } + const msg = $('
')
+ $(''+node.type+' ').appendTo(list);
currentType = node.type;
}
-
+ if (node.changed) {
+ labelText += "!!"
+ }
var entry = $('').appendTo(list);
var nodeDiv = $('').appendTo(entry);
entry.data('node',node.id);
nodeDiv.data('node',node.id);
- var label = $('').text(label).appendTo(nodeDiv);
+ var label = $('').text(labelText).appendTo(nodeDiv);
if (node.d) {
nodeDiv.addClass("red-ui-palette-node-config-disabled");
$('').prependTo(label);
@@ -216,7 +225,7 @@ RED.sidebar.config = (function() {
RED.nodes.eachWorkspace(function(ws) {
validList[ws.id.replace(/\./g,"-")] = true;
- getOrCreateCategory(ws.id,flowCategories,ws.label);
+ getOrCreateCategory(ws.id,flowCategories,ws.label, ws.locked);
})
RED.nodes.eachSubflow(function(sf) {
validList[sf.id.replace(/\./g,"-")] = true;
@@ -274,6 +283,15 @@ RED.sidebar.config = (function() {
changes: {},
dirty: RED.nodes.dirty()
}
+ for (let i = 0; i < selectedNodes.length; i++) {
+ let node = RED.nodes.node(selectedNodes[i])
+ if (node.z) {
+ let ws = RED.nodes.workspace(node.z)
+ if (ws && ws.locked) {
+ return
+ }
+ }
+ }
selectedNodes.forEach(function(id) {
var node = RED.nodes.node(id);
try {
diff --git a/packages/node_modules/@node-red/editor-client/src/js/ui/tab-help.js b/packages/node_modules/@node-red/editor-client/src/js/ui/tab-help.js
index 7ed93f48d..ee4bad2d8 100644
--- a/packages/node_modules/@node-red/editor-client/src/js/ui/tab-help.js
+++ b/packages/node_modules/@node-red/editor-client/src/js/ui/tab-help.js
@@ -141,7 +141,8 @@ RED.sidebar.help = (function() {
RED.events.on('registry:node-type-removed', queueRefresh);
RED.events.on('subflows:change', refreshSubflow);
- RED.actions.add("core:show-help-tab",show);
+ RED.actions.add("core:show-help-tab", show);
+ RED.actions.add("core:show-node-help", showNodeHelp)
}
@@ -338,6 +339,19 @@ RED.sidebar.help = (function() {
resizeStack();
}
+ function showNodeHelp(node) {
+ if (!node) {
+ const selection = RED.view.selection()
+ if (selection.nodes && selection.nodes.length > 0) {
+ node = selection.nodes.find(n => n.type !== 'group' && n.type !== 'junction')
+ }
+ }
+ if (node) {
+ show(node.type, true)
+ }
+ }
+
+
// TODO: DRY - projects.js
function addTargetToExternalLinks(el) {
$(el).find("a").each(function(el) {
diff --git a/packages/node_modules/@node-red/editor-client/src/js/ui/tab-info-outliner.js b/packages/node_modules/@node-red/editor-client/src/js/ui/tab-info-outliner.js
index c1a6d5705..7f2ed78be 100644
--- a/packages/node_modules/@node-red/editor-client/src/js/ui/tab-info-outliner.js
+++ b/packages/node_modules/@node-red/editor-client/src/js/ui/tab-info-outliner.js
@@ -225,6 +225,22 @@ RED.sidebar.info.outliner = (function() {
} else {
$('
').text(RED._("subflow.subflowInstances",{count: subflow.instances.length})).appendTo(msg); + $('
').text(RED._("subflow.confirmDelete")).appendTo(msg); + const confirmDeleteNotification = RED.notify(msg, { + modal: true, + fixed: true, + buttons: [ + { + text: RED._('common.label.cancel'), + click: function() { + confirmDeleteNotification.close(); + } + }, + { + text: RED._('workspace.confirmDelete'), + class: "primary", + click: function() { + confirmDeleteNotification.close(); + completeDelete(); + } + } + ] + }); + return; + } else { + completeDelete(); + } + function completeDelete() { + const startDirty = RED.nodes.dirty(); + const historyEvent = removeSubflow(subflow.id); + historyEvent.t = 'delete'; + historyEvent.dirty = startDirty; + RED.history.push(historyEvent); + } + } function removeSubflow(id, keepInstanceNodes) { // TODO: A lot of this logic is common with RED.nodes.removeWorkspace var removedNodes = []; @@ -558,7 +575,7 @@ RED.subflow = (function() { } }); RED.events.on("view:selection-changed",function(selection) { - if (!selection.nodes) { + if (!selection.nodes || RED.workspaces.isLocked()) { RED.menu.setDisabled("menu-item-subflow-convert",true); } else { RED.menu.setDisabled("menu-item-subflow-convert",false); @@ -621,6 +638,9 @@ RED.subflow = (function() { } function convertToSubflow() { + if (RED.workspaces.isLocked()) { + return + } var selection = RED.view.selection(); if (!selection.nodes) { RED.notify(RED._("subflow.errors.noNodesSelected"),"error"); @@ -775,7 +795,7 @@ RED.subflow = (function() { } subflowInstance._def = RED.nodes.getType(subflowInstance.type); RED.editor.validateNode(subflowInstance); - RED.nodes.add(subflowInstance); + subflowInstance = RED.nodes.add(subflowInstance); if (containingGroup) { RED.group.addToGroup(containingGroup, subflowInstance); @@ -1329,7 +1349,10 @@ RED.subflow = (function() { init: init, createSubflow: createSubflow, convertToSubflow: convertToSubflow, + // removeSubflow: Internal function to remove subflow removeSubflow: removeSubflow, + // delete: Prompt user for confirmation + delete: deleteSubflow, refresh: refresh, removeInput: removeSubflowInput, removeOutput: removeSubflowOutput, diff --git a/packages/node_modules/@node-red/editor-client/src/js/ui/tab-config.js b/packages/node_modules/@node-red/editor-client/src/js/ui/tab-config.js index bb956daa3..90ecf6093 100644 --- a/packages/node_modules/@node-red/editor-client/src/js/ui/tab-config.js +++ b/packages/node_modules/@node-red/editor-client/src/js/ui/tab-config.js @@ -43,12 +43,15 @@ RED.sidebar.config = (function() { var categories = {}; - function getOrCreateCategory(name,parent,label) { + function getOrCreateCategory(name,parent,label,isLocked) { name = name.replace(/\./i,"-"); if (!categories[name]) { var container = $('
').appendTo(parent); var header = $('').appendTo(container); + let lockIcon if (label) { + lockIcon = $('').appendTo(header) + lockIcon.toggle(!!isLocked) $('').text(label).appendTo(header); } else { $('').appendTo(header); @@ -62,6 +65,7 @@ RED.sidebar.config = (function() { var icon = header.find("i"); var result = { label: label, + lockIcon, list: category, size: function() { return result.list.find("li:not(.red-ui-palette-node-config-none)").length @@ -100,6 +104,9 @@ RED.sidebar.config = (function() { }); categories[name] = result; } else { + if (isLocked !== undefined && categories[name].lockIcon) { + categories[name].lockIcon.toggle(!!isLocked) + } if (categories[name].label !== label) { categories[name].list.parent().find('.red-ui-palette-node-config-label').text(label); categories[name].label = label; @@ -138,17 +145,19 @@ RED.sidebar.config = (function() { } else { var currentType = ""; nodes.forEach(function(node) { - var label = RED.utils.getNodeLabel(node,node.id); + var labelText = RED.utils.getNodeLabel(node,node.id); if (node.type != currentType) { $('').appendTo(controls)
}
+ if (n.type === 'tab') {
+ var lockToggleButton = $('').appendTo(controls).on("click",function(evt) {
+ evt.preventDefault();
+ evt.stopPropagation();
+ if (n.locked) {
+ RED.workspaces.unlock(n.id)
+ } else {
+ RED.workspaces.lock(n.id)
+ }
+ })
+ RED.popover.tooltip(lockToggleButton,function() {
+ return RED._("common.label."+(n.locked?"unlock":"lock"));
+ });
+ } else {
+ $('
').appendTo(controls)
+ }
controls.find("button").on("dblclick", function(evt) {
evt.preventDefault();
evt.stopPropagation();
@@ -368,6 +384,8 @@ RED.sidebar.info.outliner = (function() {
flowList.treeList.addChild(objects[ws.id])
objects[ws.id].element.toggleClass("red-ui-info-outline-item-disabled", !!ws.disabled)
objects[ws.id].treeList.container.toggleClass("red-ui-info-outline-item-disabled", !!ws.disabled)
+ objects[ws.id].element.toggleClass("red-ui-info-outline-item-locked", !!ws.locked)
+ objects[ws.id].treeList.container.toggleClass("red-ui-info-outline-item-locked", !!ws.locked)
updateSearch();
}
@@ -382,6 +400,8 @@ RED.sidebar.info.outliner = (function() {
existingObject.element.find(".red-ui-info-outline-item-label").text(label);
existingObject.element.toggleClass("red-ui-info-outline-item-disabled", !!n.disabled)
existingObject.treeList.container.toggleClass("red-ui-info-outline-item-disabled", !!n.disabled)
+ existingObject.element.toggleClass("red-ui-info-outline-item-locked", !!n.locked)
+ existingObject.treeList.container.toggleClass("red-ui-info-outline-item-locked", !!n.locked)
updateSearch();
}
function onFlowsReorder(order) {
diff --git a/packages/node_modules/@node-red/editor-client/src/js/ui/tab-info.js b/packages/node_modules/@node-red/editor-client/src/js/ui/tab-info.js
index cc8539363..e38b0b67e 100644
--- a/packages/node_modules/@node-red/editor-client/src/js/ui/tab-info.js
+++ b/packages/node_modules/@node-red/editor-client/src/js/ui/tab-info.js
@@ -25,6 +25,7 @@ RED.sidebar.info = (function() {
var propertiesPanelHeaderLabel;
var propertiesPanelHeaderReveal;
var propertiesPanelHeaderHelp;
+ var propertiesPanelHeaderCopyLink;
var selectedObject;
@@ -67,10 +68,20 @@ RED.sidebar.info = (function() {
propertiesPanelHeaderIcon = $("").appendTo(propertiesPanelHeader);
propertiesPanelHeaderLabel = $("").appendTo(propertiesPanelHeader);
- propertiesPanelHeaderHelp = $('').css({
+
+ propertiesPanelHeaderCopyLink = $('').css({
position: 'absolute',
top: '12px',
right: '32px'
+ }).on("click", function(evt) {
+ RED.actions.invoke('core:copy-item-url',selectedObject)
+ }).appendTo(propertiesPanelHeader);
+ RED.popover.tooltip(propertiesPanelHeaderCopyLink,RED._("sidebar.info.copyItemUrl"));
+
+ propertiesPanelHeaderHelp = $('').css({
+ position: 'absolute',
+ top: '12px',
+ right: '56px'
}).on("click", function(evt) {
evt.preventDefault();
evt.stopPropagation();
@@ -80,8 +91,7 @@ RED.sidebar.info = (function() {
}).appendTo(propertiesPanelHeader);
RED.popover.tooltip(propertiesPanelHeaderHelp,RED._("sidebar.help.showHelp"));
-
- propertiesPanelHeaderReveal = $('').css({
+ propertiesPanelHeaderReveal = $('').css({
position: 'absolute',
top: '12px',
right: '8px'
@@ -185,6 +195,7 @@ RED.sidebar.info = (function() {
propertiesPanelHeaderLabel.text("");
propertiesPanelHeaderReveal.hide();
propertiesPanelHeaderHelp.hide();
+ propertiesPanelHeaderCopyLink.hide();
return;
} else if (Array.isArray(node)) {
// Multiple things selected
@@ -196,6 +207,7 @@ RED.sidebar.info = (function() {
propertiesPanelHeaderLabel.text("Selection");
propertiesPanelHeaderReveal.hide();
propertiesPanelHeaderHelp.hide();
+ propertiesPanelHeaderCopyLink.hide();
selectedObject = null;
var types = {
@@ -277,9 +289,11 @@ RED.sidebar.info = (function() {
if (node.type === "tab" || node.type === "subflow") {
// If nothing is selected, but we're on a flow or subflow tab.
propertiesPanelHeaderHelp.hide();
+ propertiesPanelHeaderCopyLink.show();
} else if (node.type === "group") {
propertiesPanelHeaderHelp.hide();
+ propertiesPanelHeaderCopyLink.show();
propRow = $(' '+RED._("sidebar.info.type")+' n.n === node)
+ if (index > -1) {
+ const removed = set.splice(index, 1)
+ set.unshift(...removed)
+ }
+ },
+ find: function(func) { return set.find(func) },
+ dump: function () {
+ console.log('MovingSet Contents')
+ api.forEach((n, i) => {
+ console.log(`${i+1}\t${n.n.id}\t${n.n.type}`)
+ })
+ }
}
return api;
})();
- var selectedLinks = (function() {
+ const selectedLinks = (function() {
var links = new Set();
- return {
+ const api = {
add: function(link) {
links.add(link);
link.selected = true;
@@ -199,10 +220,75 @@ RED.view = (function() {
},
forEach: function(func) { links.forEach(func) },
has: function(link) { return links.has(link) },
- toArray: function() { return Array.from(links) }
+ toArray: function() { return Array.from(links) },
+ clearUnselected: function () {
+ api.forEach(l => {
+ if (!l.source.selected || !l.target.selected) {
+ api.remove(l)
+ }
+ })
+ }
}
+ return api
})();
+ const selectedGroups = (function() {
+ let groups = new Set()
+ const api = {
+ add: function(g, includeNodes, addToMovingSet) {
+ groups.add(g)
+ if (!g.selected) {
+ g.selected = true;
+ g.dirty = true;
+ }
+ if (addToMovingSet !== false) {
+ movingSet.add(g);
+ }
+ if (includeNodes) {
+ var currentSet = new Set(movingSet.nodes());
+ var allNodes = RED.group.getNodes(g,true);
+ allNodes.forEach(function(n) {
+ if (!currentSet.has(n)) {
+ movingSet.add(n)
+ }
+ n.dirty = true;
+ })
+ }
+ selectedLinks.clearUnselected()
+ },
+ remove: function(g) {
+ groups.delete(g)
+ if (g.selected) {
+ g.selected = false;
+ g.dirty = true;
+ }
+ const allNodes = RED.group.getNodes(g,true);
+ const nodeSet = new Set(allNodes);
+ nodeSet.add(g);
+ for (let i = movingSet.length()-1; i >= 0; i -= 1) {
+ const msn = movingSet.get(i);
+ if (nodeSet.has(msn.n) || msn.n === g) {
+ msn.n.selected = false;
+ msn.n.dirty = true;
+ movingSet.remove(msn.n,i)
+ }
+ }
+ selectedLinks.clearUnselected()
+ },
+ length: () => groups.length,
+ forEach: (func) => { groups.forEach(func) },
+ toArray: () => [...groups],
+ clear: function () {
+ groups.forEach(g => {
+ g.selected = false
+ g.dirty = true
+ })
+ groups.clear()
+ }
+ }
+ return api
+ })()
+
function init() {
@@ -211,6 +297,7 @@ RED.view = (function() {
evt.preventDefault()
evt.stopPropagation()
RED.contextMenu.show({
+ type: 'workspace',
x:evt.clientX-5,
y:evt.clientY-5
})
@@ -242,6 +329,7 @@ RED.view = (function() {
d3.select(document).on('mouseup.red-ui-workspace-tracker', null)
if (lasso) {
if (d3.event.buttons !== 1) {
+ outer.classed('red-ui-workspace-lasso-active', false)
lasso.remove();
lasso = null;
}
@@ -376,6 +464,31 @@ RED.view = (function() {
}
d3.event.preventDefault();
});
+
+
+ const handleAltToggle = (event) => {
+ if (mouse_mode === RED.state.MOVING_ACTIVE && event.key === 'Alt' && groupAddParentGroup) {
+ RED.nodes.group(groupAddParentGroup).dirty = true
+ for (let n = 0; n 0);
var hasMultipleSelection = hasSelection && selection.nodes.length > 1;
- RED.menu.setDisabled("menu-item-edit-cut",!hasSelection);
- RED.menu.setDisabled("menu-item-edit-copy",!hasSelection);
- RED.menu.setDisabled("menu-item-edit-select-connected",!hasSelection);
- RED.menu.setDisabled("menu-item-view-tools-move-to-back",!hasSelection);
- RED.menu.setDisabled("menu-item-view-tools-move-to-front",!hasSelection);
- RED.menu.setDisabled("menu-item-view-tools-move-backwards",!hasSelection);
- RED.menu.setDisabled("menu-item-view-tools-move-forwards",!hasSelection);
+ var hasLinkSelected = selection.links && selection.links.length > 0;
+ var canEdit = !activeFlowLocked && hasSelection
+ var canEditMultiple = !activeFlowLocked && hasMultipleSelection
+ RED.menu.setDisabled("menu-item-edit-cut", !canEdit);
+ RED.menu.setDisabled("menu-item-edit-copy", !hasSelection);
+ RED.menu.setDisabled("menu-item-edit-select-connected", !hasSelection);
+ RED.menu.setDisabled("menu-item-view-tools-move-to-back", !canEdit);
+ RED.menu.setDisabled("menu-item-view-tools-move-to-front", !canEdit);
+ RED.menu.setDisabled("menu-item-view-tools-move-backwards", !canEdit);
+ RED.menu.setDisabled("menu-item-view-tools-move-forwards", !canEdit);
- RED.menu.setDisabled("menu-item-view-tools-align-left",!hasMultipleSelection);
- RED.menu.setDisabled("menu-item-view-tools-align-center",!hasMultipleSelection);
- RED.menu.setDisabled("menu-item-view-tools-align-right",!hasMultipleSelection);
- RED.menu.setDisabled("menu-item-view-tools-align-top",!hasMultipleSelection);
- RED.menu.setDisabled("menu-item-view-tools-align-middle",!hasMultipleSelection);
- RED.menu.setDisabled("menu-item-view-tools-align-bottom",!hasMultipleSelection);
- RED.menu.setDisabled("menu-item-view-tools-distribute-horizontally",!hasMultipleSelection);
- RED.menu.setDisabled("menu-item-view-tools-distribute-veritcally",!hasMultipleSelection);
+ RED.menu.setDisabled("menu-item-view-tools-align-left", !canEditMultiple);
+ RED.menu.setDisabled("menu-item-view-tools-align-center", !canEditMultiple);
+ RED.menu.setDisabled("menu-item-view-tools-align-right", !canEditMultiple);
+ RED.menu.setDisabled("menu-item-view-tools-align-top", !canEditMultiple);
+ RED.menu.setDisabled("menu-item-view-tools-align-middle", !canEditMultiple);
+ RED.menu.setDisabled("menu-item-view-tools-align-bottom", !canEditMultiple);
+ RED.menu.setDisabled("menu-item-view-tools-distribute-horizontally", !canEditMultiple);
+ RED.menu.setDisabled("menu-item-view-tools-distribute-veritcally", !canEditMultiple);
+
+ RED.menu.setDisabled("menu-item-edit-split-wire-with-links", activeFlowLocked || !hasLinkSelected);
})
RED.actions.add("core:delete-selection",deleteSelection);
@@ -683,7 +803,7 @@ RED.view = (function() {
if (/^subflow:/.test(node.type)) {
RED.workspaces.show(node.type.substring(8))
} else if (node.type === 'group') {
- enterActiveGroup(node);
+ // enterActiveGroup(node);
redraw();
}
}
@@ -871,16 +991,31 @@ RED.view = (function() {
});
activeJunctions = RED.nodes.junctions(activeWorkspace) || [];
activeGroups = RED.nodes.groups(activeWorkspace)||[];
- activeGroups.forEach(function(g, i) {
- g._index = i;
- if (g.g) {
- g._root = g.g;
- g._depth = 1;
- } else {
- g._root = g.id;
- g._depth = 0;
+ if (activeGroups.length) {
+ const groupTree = {}
+ const rootGroups = []
+ activeGroups.forEach(function(g, i) {
+ groupTree[g.id] = g
+ g._index = i;
+ g._childGroups = []
+ if (!g.g) {
+ rootGroups.push(g)
+ }
+ });
+ activeGroups.forEach(function(g) {
+ if (g.g) {
+ groupTree[g.g]._childGroups.push(g)
+ g._parentGroup = groupTree[g.g]
+ }
+ })
+ let ii = 0
+ // Depth-first walk of the groups
+ const processGroup = g => {
+ g._order = ii++
+ g._childGroups.forEach(processGroup)
}
- });
+ rootGroups.forEach(processGroup)
+ }
} else {
activeNodes = [];
activeLinks = [];
@@ -888,43 +1023,13 @@ RED.view = (function() {
activeGroups = [];
}
- var changed = false;
- do {
- changed = false;
- activeGroups.forEach(function(g) {
- if (g.g) {
- var parentGroup = RED.nodes.group(g.g);
- if (parentGroup) {
- var parentDepth = parentGroup._depth;
- if (g._depth !== parentDepth + 1) {
- g._depth = parentDepth + 1;
- changed = true;
- }
- if (g._root !== parentGroup._root) {
- g._root = parentGroup._root;
- changed = true;
- }
- }
- }
- });
- } while (changed)
activeGroups.sort(function(a,b) {
- if (a._root === b._root) {
- return a._depth - b._depth;
- } else {
- // return a._root.localeCompare(b._root);
- return a._index - b._index;
- }
+ return a._order - b._order
});
var group = groupLayer.selectAll(".red-ui-flow-group").data(activeGroups,function(d) { return d.id });
group.sort(function(a,b) {
- if (a._root === b._root) {
- return a._depth - b._depth;
- } else {
- return a._index - b._index;
- // return a._root.localeCompare(b._root);
- }
+ return a._order - b._order
})
}
@@ -1029,6 +1134,7 @@ RED.view = (function() {
updateSelection();
}
if (mouse_mode === 0 && lasso) {
+ outer.classed('red-ui-workspace-lasso-active', false)
lasso.remove();
lasso = null;
}
@@ -1060,8 +1166,9 @@ RED.view = (function() {
.attr("height", 0)
.attr("class", "nr-ui-view-lasso");
d3.event.preventDefault();
+ outer.classed('red-ui-workspace-lasso-active', true)
}
- } else if (d3.event.altKey) {
+ } else if (d3.event.altKey && !activeFlowLocked) {
//Alt [+shift] held - Begin slicing
clearSelection();
mouse_mode = (d3.event.shiftKey) ? RED.state.SLICING_JUNCTION : RED.state.SLICING;
@@ -1075,16 +1182,18 @@ RED.view = (function() {
}
function showQuickAddDialog(options) {
+ if (activeFlowLocked) {
+ return
+ }
options = options || {};
var point = options.position || lastClickPosition;
- var spliceLink = options.splice;
+ var linkToSplice = options.splice;
var spliceMultipleLinks = options.spliceMultiple
var targetGroup = options.group;
var touchTrigger = options.touchTrigger;
- if (targetGroup && !targetGroup.active) {
- selectGroup(targetGroup,false);
- enterActiveGroup(targetGroup);
+ if (targetGroup) {
+ selectedGroups.add(targetGroup,false);
RED.view.redraw();
}
@@ -1149,7 +1258,7 @@ RED.view = (function() {
}
hideDragLines();
}
- if (spliceLink || spliceMultipleLinks) {
+ if (linkToSplice || spliceMultipleLinks) {
filter = {
input:true,
output:true,
@@ -1233,7 +1342,8 @@ RED.view = (function() {
w: 0, h: 0,
outputs: 1,
inputs: 1,
- dirty: true
+ dirty: true,
+ moved: true
}
historyEvent = {
t:'add',
@@ -1257,6 +1367,11 @@ RED.view = (function() {
if (showLabel !== undefined && (nn._def.hasOwnProperty("showLabel")?nn._def.showLabel:true) && !nn._def.defaults.hasOwnProperty("l")) {
nn.l = showLabel;
}
+ if (nn.type === 'junction') {
+ nn = RED.nodes.addJunction(nn);
+ } else {
+ nn = RED.nodes.add(nn);
+ }
if (quickAddLink) {
var drag_line = quickAddLink;
var src = null,dst,src_port;
@@ -1359,11 +1474,7 @@ RED.view = (function() {
}
}
}
- if (nn.type === 'junction') {
- RED.nodes.addJunction(nn);
- } else {
- RED.nodes.add(nn);
- }
+
RED.editor.validateNode(nn);
if (targetGroup) {
@@ -1398,24 +1509,9 @@ RED.view = (function() {
}
}
- if (spliceLink) {
+ if (linkToSplice) {
resetMouseVars();
- // TODO: DRY - droppable/nodeMouseDown/canvasMouseUp/showQuickAddDialog
- RED.nodes.removeLink(spliceLink);
- var link1 = {
- source:spliceLink.source,
- sourcePort:spliceLink.sourcePort,
- target: nn
- };
- var link2 = {
- source:nn,
- sourcePort:0,
- target: spliceLink.target
- };
- RED.nodes.addLink(link1);
- RED.nodes.addLink(link2);
- historyEvent.links = (historyEvent.links || []).concat([link1,link2]);
- historyEvent.removedLinks = [spliceLink];
+ spliceLink(linkToSplice, nn, historyEvent)
}
RED.history.push(historyEvent);
RED.nodes.dirty(true);
@@ -1423,8 +1519,7 @@ RED.view = (function() {
clearSelection();
nn.selected = true;
if (targetGroup) {
- selectGroup(targetGroup,false);
- enterActiveGroup(targetGroup);
+ selectedGroups.add(targetGroup,false);
}
movingSet.add(nn);
updateActiveNodes();
@@ -1637,16 +1732,13 @@ RED.view = (function() {
}
var d = (mouse_offset[0]-mousePos[0])*(mouse_offset[0]-mousePos[0]) + (mouse_offset[1]-mousePos[1])*(mouse_offset[1]-mousePos[1]);
if ((d > 3 && !dblClickPrimed) || (dblClickPrimed && d > 10)) {
- mouse_mode = RED.state.MOVING_ACTIVE;
clickElapsed = 0;
- spliceActive = false;
- if (movingSet.length() === 1) {
- node = movingSet.get(0);
- spliceActive = node.n.hasOwnProperty("_def") &&
- ((node.n.hasOwnProperty("inputs") && node.n.inputs > 0) || (!node.n.hasOwnProperty("inputs") && node.n._def.inputs > 0)) &&
- ((node.n.hasOwnProperty("outputs") && node.n.outputs > 0) || (!node.n.hasOwnProperty("outputs") && node.n._def.outputs > 0)) &&
- RED.nodes.filterLinks({ source: node.n }).length === 0 &&
- RED.nodes.filterLinks({ target: node.n }).length === 0;
+ if (!activeFlowLocked) {
+ if (mousedown_node) {
+ movingSet.makePrimary(mousedown_node)
+ }
+ mouse_mode = RED.state.MOVING_ACTIVE;
+ startSelectionMove()
}
}
} else if (mouse_mode == RED.state.MOVING_ACTIVE || mouse_mode == RED.state.IMPORT_DRAGGING || mouse_mode == RED.state.DETACHED_DRAGGING) {
@@ -1661,6 +1753,7 @@ RED.view = (function() {
node.n.ox = node.n.x;
node.n.oy = node.n.y;
}
+ node.n._detachFromGroup = d3.event.altKey
node.n.x = mousePos[0]+node.dx;
node.n.y = mousePos[1]+node.dy;
node.n.dirty = true;
@@ -1729,9 +1822,8 @@ RED.view = (function() {
}
}
- // Check link splice or group-add
+ // Check link splice
if (movingSet.length() === 1 && movingSet.get(0).n.type !== "group") {
- //}{//NIS
node = movingSet.get(0);
if (spliceActive) {
if (!spliceTimer) {
@@ -1779,23 +1871,39 @@ RED.view = (function() {
},100);
}
}
- if (node.n.type !== 'subflow' && !node.n.g && activeGroups) {
- if (!groupHoverTimer) {
- groupHoverTimer = setTimeout(function() {
- activeHoverGroup = getGroupAt(node.n.x,node.n.y);
- for (var i=0;i 0) {
+ clickedGroup = clickedGroup || RED.nodes.group(drag_lines[0].node.g)
+ }
+ showQuickAddDialog({ position: point, group: clickedGroup });
}
hideDragLines();
}
@@ -1857,56 +1975,29 @@ RED.view = (function() {
var y = parseInt(lasso.attr("y"));
var x2 = x+parseInt(lasso.attr("width"));
var y2 = y+parseInt(lasso.attr("height"));
- var ag = activeGroup;
if (!d3.event.shiftKey) {
clearSelection();
- if (ag) {
- if (x < ag.x+ag.w && x2 > ag.x && y < ag.y+ag.h && y2 > ag.y) {
- // There was an active group and the lasso intersects with it,
- // so reenter the group
- enterActiveGroup(ag);
- activeGroup.selected = true;
- }
- }
}
- activeGroups.forEach(function(g) {
- if (!g.selected) {
- if (g.x > x && g.x+g.w < x2 && g.y > y && g.y+g.h < y2) {
- if (!activeGroup || RED.group.contains(activeGroup,g)) {
- while (g.g && (!activeGroup || g.g !== activeGroup.id)) {
- g = RED.nodes.group(g.g);
- }
- if (!g.selected) {
- selectGroup(g,true);
- }
- }
+
+ activeGroups.forEach(function(n) {
+ if (!movingSet.has(n) && !n.selected) {
+ // group entirely within lasso
+ if (n.x > x && n.y > y && n.x + n.w < x2 && n.y + n.h < y2) {
+ selectedGroups.add(n, true)
}
}
})
-
activeNodes.forEach(function(n) {
- if (!n.selected) {
+ if (!movingSet.has(n) && !n.selected) {
if (n.x > x && n.x < x2 && n.y > y && n.y < y2) {
- if (!activeGroup || RED.group.contains(activeGroup,n)) {
- if (n.g && (!activeGroup || n.g !== activeGroup.id)) {
- var group = RED.nodes.group(n.g);
- while (group.g && (!activeGroup || group.g !== activeGroup.id)) {
- group = RED.nodes.group(group.g);
- }
- if (!group.selected) {
- selectGroup(group,true);
- }
- } else {
- n.selected = true;
- n.dirty = true;
- movingSet.add(n);
- }
- }
+ n.selected = true;
+ n.dirty = true;
+ movingSet.add(n);
}
}
});
activeJunctions.forEach(function(n) {
- if (!n.selected) {
+ if (!movingSet.has(n) && !n.selected) {
if (n.x > x && n.x < x2 && n.y > y && n.y < y2) {
n.selected = true;
n.dirty = true;
@@ -1929,17 +2020,6 @@ RED.view = (function() {
}
})
- // var selectionChanged = false;
- // do {
- // selectionChanged = false;
- // selectedGroups.forEach(function(g) {
- // if (g.g && g.selected && RED.nodes.group(g.g).selected) {
- // g.selected = false;
- // selectionChanged = true;
- // }
- // })
- // } while(selectionChanged);
-
if (activeSubflow) {
activeSubflow.in.forEach(function(n) {
n.selected = (n.x > x && n.x < x2 && n.y > y && n.y < y2);
@@ -1964,6 +2044,7 @@ RED.view = (function() {
}
}
updateSelection();
+ outer.classed('red-ui-workspace-lasso-active', false)
lasso.remove();
lasso = null;
} else if (mouse_mode == RED.state.DEFAULT && mousedown_link == null && !d3.event.ctrlKey && !d3.event.metaKey ) {
@@ -1978,210 +2059,80 @@ RED.view = (function() {
RED.actions.invoke("core:split-wires-with-junctions")
slicePath.remove();
slicePath = null;
-
- // var removedLinks = new Set()
- // var addedLinks = []
- // var addedJunctions = []
- //
- // var groupedLinks = {}
- // selectedLinks.forEach(function(l) {
- // var sourceId = l.source.id+":"+l.sourcePort
- // groupedLinks[sourceId] = groupedLinks[sourceId] || []
- // groupedLinks[sourceId].push(l)
- //
- // groupedLinks[l.target.id] = groupedLinks[l.target.id] || []
- // groupedLinks[l.target.id].push(l)
- // });
- // var linkGroups = Object.keys(groupedLinks)
- // linkGroups.sort(function(A,B) {
- // return groupedLinks[B].length - groupedLinks[A].length
- // })
- // linkGroups.forEach(function(gid) {
- // var links = groupedLinks[gid]
- // var junction = {
- // _def: {defaults:{}},
- // type: 'junction',
- // z: RED.workspaces.active(),
- // id: RED.nodes.id(),
- // x: 0,
- // y: 0,
- // w: 0, h: 0,
- // outputs: 1,
- // inputs: 1,
- // dirty: true
- // }
- // links = links.filter(function(l) { return !removedLinks.has(l) })
- // if (links.length === 0) {
- // return
- // }
- // links.forEach(function(l) {
- // junction.x += l._sliceLocation.x
- // junction.y += l._sliceLocation.y
- // })
- // junction.x = Math.round(junction.x/links.length)
- // junction.y = Math.round(junction.y/links.length)
- // if (snapGrid) {
- // junction.x = (gridSize*Math.round(junction.x/gridSize));
- // junction.y = (gridSize*Math.round(junction.y/gridSize));
- // }
- //
- // var nodeGroups = new Set()
- //
- // RED.nodes.addJunction(junction)
- // addedJunctions.push(junction)
- // let newLink
- // if (gid === links[0].source.id+":"+links[0].sourcePort) {
- // newLink = {
- // source: links[0].source,
- // sourcePort: links[0].sourcePort,
- // target: junction
- // }
- // } else {
- // newLink = {
- // source: junction,
- // sourcePort: 0,
- // target: links[0].target
- // }
- // }
- // addedLinks.push(newLink)
- // RED.nodes.addLink(newLink)
- // links.forEach(function(l) {
- // removedLinks.add(l)
- // RED.nodes.removeLink(l)
- // let newLink
- // if (gid === l.target.id) {
- // newLink = {
- // source: l.source,
- // sourcePort: l.sourcePort,
- // target: junction
- // }
- // } else {
- // newLink = {
- // source: junction,
- // sourcePort: 0,
- // target: l.target
- // }
- // }
- // addedLinks.push(newLink)
- // RED.nodes.addLink(newLink)
- // nodeGroups.add(l.source.g || "__NONE__")
- // nodeGroups.add(l.target.g || "__NONE__")
- // })
- // if (nodeGroups.size === 1) {
- // var group = nodeGroups.values().next().value
- // if (group !== "__NONE__") {
- // RED.group.addToGroup(RED.nodes.group(group), junction)
- // }
- // }
- // })
- // slicePath.remove();
- // slicePath = null;
- //
- // if (addedJunctions.length > 0) {
- // RED.history.push({
- // t: 'add',
- // links: addedLinks,
- // junctions: addedJunctions,
- // removedLinks: Array.from(removedLinks)
- // })
- // RED.nodes.dirty(true)
- // }
- // RED.view.redraw(true);
}
if (mouse_mode == RED.state.MOVING_ACTIVE) {
if (movingSet.length() > 0) {
- var addedToGroup = null;
- var moveEvent = null;
- if (activeHoverGroup) {
- var oldX = activeHoverGroup.x;
- var oldY = activeHoverGroup.y;
- for (var j=0;j 0 && mouse_mode == RED.state.MOVING_ACTIVE) {
- historyEvent = {t:"move",nodes:ns,dirty:RED.nodes.dirty()};
+ // Check to see if we need to splice a link
+ if (moveEvent.nodes.length > 0) {
+ historyEvent.events.push(moveEvent)
if (activeSpliceLink) {
- // TODO: DRY - droppable/nodeMouseDown/canvasMouseUp
- var spliceLink = d3.select(activeSpliceLink).data()[0];
- RED.nodes.removeLink(spliceLink);
- var link1 = {
- source:spliceLink.source,
- sourcePort:spliceLink.sourcePort,
- target: movingSet.get(0).n
- };
- var link2 = {
- source:movingSet.get(0).n,
- sourcePort:0,
- target: spliceLink.target
- };
- RED.nodes.addLink(link1);
- RED.nodes.addLink(link2);
- historyEvent.links = [link1,link2];
- historyEvent.removedLinks = [spliceLink];
- updateActiveNodes();
- }
- if (addedToGroup) {
- historyEvent.addToGroup = addedToGroup;
+ var linkToSplice = d3.select(activeSpliceLink).data()[0];
+ spliceLink(linkToSplice, movingSet.get(0).n, moveEvent)
}
+ }
+ if (moveAndChangedGroupEvent.nodes.length > 0) {
+ historyEvent.events.push(moveAndChangedGroupEvent)
+ }
+
+ // Only continue if something has moved
+ if (historyEvent.events.length > 0) {
RED.nodes.dirty(true);
- if (moveEvent) {
- historyEvent = {
- t: "multi",
- events: [moveEvent, historyEvent]
- };
+ if (historyEvent.events.length === 1) {
+ // Keep history tidy - no need for multi-event
+ RED.history.push(historyEvent.events[0]);
+ } else {
+ // Multiple events - push the whole lot as one
+ RED.history.push(historyEvent);
}
- RED.history.push(historyEvent);
+ updateActiveNodes();
}
}
}
- // if (mouse_mode === RED.state.MOVING && mousedown_node && mousedown_node.g) {
- // if (mousedown_node.gSelected) {
- // delete mousedown_node.gSelected
- // } else {
- // if (!d3.event.ctrlKey && !d3.event.metaKey) {
- // clearSelection();
- // }
- // RED.nodes.group(mousedown_node.g).selected = true;
- // mousedown_node.selected = true;
- // mousedown_node.dirty = true;
- // movingSet.add(mousedown_node);
- // }
- // }
if (mouse_mode == RED.state.MOVING || mouse_mode == RED.state.MOVING_ACTIVE || mouse_mode == RED.state.DETACHED_DRAGGING) {
- // if (mousedown_node) {
- // delete mousedown_node.gSelected;
- // }
if (mouse_mode === RED.state.DETACHED_DRAGGING) {
var ns = [];
for (var j=0;j {
+ if (g.hovered) {
+ g.hovered = false
+ g.dirty = true
+ }
+ })
+
+ return {
+ addedToGroup,
+ removedFromGroup,
+ groupMoveEvent,
+ rehomedNodes
+ }
+
+ }
+
function zoomIn() {
if (scaleFactor < 2) {
zoomView(scaleFactor+0.1);
@@ -2277,10 +2317,9 @@ RED.view = (function() {
}
clearSelection();
} else if (lasso) {
+ outer.classed('red-ui-workspace-lasso-active', false)
lasso.remove();
lasso = null;
- } else if (activeGroup) {
- exitActiveGroup()
} else {
clearSelection();
}
@@ -2291,82 +2330,61 @@ RED.view = (function() {
return;
}
selectedLinks.clear();
-
- if (activeGroup) {
- var ag = activeGroup;
- clearSelection();
- enterActiveGroup(ag);
-
- var groupNodes = RED.group.getNodes(ag,false);
- groupNodes.forEach(function(n) {
- if (n.type === 'group') {
- selectGroup(n,true,true);
- } else {
- movingSet.add(n)
- n.selected = true;
- n.dirty = true;
- }
- })
- activeGroup.selected = true;
- } else {
-
- clearSelection();
- exitActiveGroup();
- activeGroups.forEach(function(g) {
- if (!g.g) {
- selectGroup(g, true);
- if (!g.selected) {
- g.selected = true;
- g.dirty = true;
- }
- } else {
- g.selected = false;
+ clearSelection();
+ activeGroups.forEach(function(g) {
+ if (!g.g) {
+ selectedGroups.add(g, true);
+ if (!g.selected) {
+ g.selected = true;
g.dirty = true;
}
- })
+ } else {
+ g.selected = false;
+ g.dirty = true;
+ }
+ })
- activeNodes.forEach(function(n) {
- if (mouse_mode === RED.state.SELECTING_NODE) {
- if (selectNodesOptions.filter && !selectNodesOptions.filter(n)) {
- return;
- }
+ activeNodes.forEach(function(n) {
+ if (mouse_mode === RED.state.SELECTING_NODE) {
+ if (selectNodesOptions.filter && !selectNodesOptions.filter(n)) {
+ return;
}
- if (!n.g && !n.selected) {
- n.selected = true;
- n.dirty = true;
- movingSet.add(n);
- }
- });
+ }
+ if (!n.g && !n.selected) {
+ n.selected = true;
+ n.dirty = true;
+ movingSet.add(n);
+ }
+ });
- activeJunctions.forEach(function(n) {
+ activeJunctions.forEach(function(n) {
+ if (!n.selected) {
+ n.selected = true;
+ n.dirty = true;
+ movingSet.add(n);
+ }
+ })
+
+ if (mouse_mode !== RED.state.SELECTING_NODE && activeSubflow) {
+ activeSubflow.in.forEach(function(n) {
if (!n.selected) {
n.selected = true;
n.dirty = true;
movingSet.add(n);
}
- })
-
- if (mouse_mode !== RED.state.SELECTING_NODE && activeSubflow) {
- activeSubflow.in.forEach(function(n) {
- if (!n.selected) {
- n.selected = true;
- n.dirty = true;
- movingSet.add(n);
- }
- });
- activeSubflow.out.forEach(function(n) {
- if (!n.selected) {
- n.selected = true;
- n.dirty = true;
- movingSet.add(n);
- }
- });
- if (activeSubflow.status) {
- if (!activeSubflow.status.selected) {
- activeSubflow.status.selected = true;
- activeSubflow.status.dirty = true;
- movingSet.add(activeSubflow.status);
- }
+ });
+ activeSubflow.out.forEach(function(n) {
+ if (!n.selected) {
+ n.selected = true;
+ n.dirty = true;
+ movingSet.add(n);
+ }
+ });
+ if (activeSubflow.status) {
+ if (!activeSubflow.status.selected) {
+ activeSubflow.status.selected = true;
+ activeSubflow.status.dirty = true;
+ movingSet.add(activeSubflow.status);
}
}
}
@@ -2385,15 +2403,7 @@ RED.view = (function() {
}
movingSet.clear();
selectedLinks.clear();
- if (activeGroup) {
- activeGroup.active = false
- activeGroup.dirty = true;
- activeGroup = null;
- }
- activeGroups.forEach(function(g) {
- g.selected = false;
- g.dirty = true;
- })
+ selectedGroups.clear();
}
var lastSelection = null;
@@ -2512,6 +2522,7 @@ RED.view = (function() {
}
function editSelection() {
+ if (RED.workspaces.isLocked()) { return }
if (movingSet.length() > 0) {
var node = movingSet.get(0).n;
if (node.type === "subflow") {
@@ -2527,6 +2538,9 @@ RED.view = (function() {
if (mouse_mode === RED.state.SELECTING_NODE) {
return;
}
+ if (activeFlowLocked) {
+ return
+ }
if (portLabelHover) {
portLabelHover.remove();
portLabelHover = null;
@@ -2852,6 +2866,7 @@ RED.view = (function() {
function detachSelectedNodes() {
+ if (RED.workspaces.isLocked()) { return }
var selection = RED.view.selection();
if (selection.nodes) {
const {newLinks, removedLinks} = RED.nodes.detachNodes(selection.nodes);
@@ -2954,6 +2969,7 @@ RED.view = (function() {
mousedown_port_type = null;
activeSpliceLink = null;
spliceActive = false;
+ groupAddActive = false;
if (activeHoverGroup) {
activeHoverGroup.hovered = false;
activeHoverGroup = null;
@@ -2993,7 +3009,7 @@ RED.view = (function() {
mousedown_node = d;
mousedown_port_type = portType;
mousedown_port_index = portIndex || 0;
- if (mouse_mode !== RED.state.QUICK_JOINING) {
+ if (mouse_mode !== RED.state.QUICK_JOINING && !activeFlowLocked) {
mouse_mode = RED.state.JOINING;
document.body.style.cursor = "crosshair";
if (evt.ctrlKey || evt.metaKey) {
@@ -3156,8 +3172,25 @@ RED.view = (function() {
(drag_line.portType === PORT_TYPE_INPUT && mouseup_node.type === "subflow" && (mouseup_node.direction === "status" || mouseup_node.direction === "out")) ||
(drag_line.portType === PORT_TYPE_OUTPUT && mouseup_node.type === "subflow" && mouseup_node.direction === "in")
)) {
+ let hasJunctionLoop = false
+ if (link.source.type === 'junction' && link.target.type === 'junction') {
+ // This is joining two junctions together. We want to avoid creating a loop
+ // of pure junction nodes as there is no way to break out of it.
+
+ const visited = new Set()
+ let toVisit = [link.target]
+ while (toVisit.length > 0) {
+ const next = toVisit.shift()
+ if (next === link.source) {
+ hasJunctionLoop = true
+ break
+ }
+ visited.add(next)
+ toVisit = toVisit.concat(RED.nodes.getDownstreamNodes(next).filter(n => n.type === 'junction' && !visited.has(n)))
+ }
+ }
var existingLink = RED.nodes.filterLinks({source:src,target:dst,sourcePort: src_port}).length !== 0;
- if (!existingLink) {
+ if (!hasJunctionLoop && !existingLink) {
RED.nodes.addLink(link);
addedLinks.push(link);
}
@@ -3275,7 +3308,7 @@ RED.view = (function() {
console.log("Definition error: "+node.type+"."+((portType === PORT_TYPE_INPUT)?"inputLabels":"outputLabels"),err);
result = null;
}
- } else if ($.isArray(portLabels)) {
+ } else if (Array.isArray(portLabels)) {
result = portLabels[portIndex];
}
return result;
@@ -3433,6 +3466,11 @@ RED.view = (function() {
}
if (dblClickPrimed && mousedown_node == d && clickElapsed > 0 && clickElapsed < dblClickInterval) {
mouse_mode = RED.state.DEFAULT;
+ if (RED.workspaces.isLocked()) {
+ clickElapsed = 0;
+ d3.event.stopPropagation();
+ return
+ }
// Avoid dbl click causing text selection.
d3.event.preventDefault()
document.getSelection().removeAllRanges()
@@ -3454,8 +3492,7 @@ RED.view = (function() {
if (!groupNodeSelectPrimed && !d.selected && d.g && RED.nodes.group(d.g).selected) {
clearSelection();
- selectGroup(RED.nodes.group(d.g), false);
- enterActiveGroup(RED.nodes.group(d.g))
+ selectedGroups.add(RED.nodes.group(d.g), false);
mousedown_node.selected = true;
movingSet.add(mousedown_node);
@@ -3508,57 +3545,25 @@ RED.view = (function() {
//RED.touch.radialMenu.show(d3.select(this),pos);
if (mouse_mode == RED.state.IMPORT_DRAGGING || mouse_mode == RED.state.DETACHED_DRAGGING) {
var historyEvent = RED.history.peek();
- if (activeSpliceLink) {
- // TODO: DRY - droppable/nodeMouseDown/canvasMouseUp
- var spliceLink = d3.select(activeSpliceLink).data()[0];
- RED.nodes.removeLink(spliceLink);
- var link1 = {
- source:spliceLink.source,
- sourcePort:spliceLink.sourcePort,
- target: movingSet.get(0).n
- };
- var link2 = {
- source:movingSet.get(0).n,
- sourcePort:0,
- target: spliceLink.target
- };
- RED.nodes.addLink(link1);
- RED.nodes.addLink(link2);
+ // Check to see if we're dropping into a group
+ const {
+ addedToGroup,
+ removedFromGroup,
+ groupMoveEvent,
+ rehomedNodes
+ } = addMovingSetToGroup()
- historyEvent.links = [link1,link2];
- historyEvent.removedLinks = [spliceLink];
+ if (activeSpliceLink) {
+ var linkToSplice = d3.select(activeSpliceLink).data()[0];
+ spliceLink(linkToSplice, movingSet.get(0).n, historyEvent)
updateActiveNodes();
}
-
- var moveEvent = null;
- if (activeHoverGroup) {
- var oldX = activeHoverGroup.x;
- var oldY = activeHoverGroup.y;
- for (var j=0;j 0 && clickElapsed < dblClickInterval) {
mouse_mode = RED.state.DEFAULT;
RED.editor.editGroup(g);
@@ -3998,7 +3892,6 @@ RED.view = (function() {
}
if (mouse_mode == RED.state.QUICK_JOINING) {
- d3.event.stopPropagation();
return;
} else if (mouse_mode === RED.state.SELECTING_NODE) {
d3.event.stopPropagation();
@@ -4020,34 +3913,16 @@ RED.view = (function() {
lastClickNode = g;
if (g.selected && (d3.event.ctrlKey||d3.event.metaKey)) {
- if (g === activeGroup) {
- exitActiveGroup();
- }
- deselectGroup(g);
+ selectedGroups.remove(g);
d3.event.stopPropagation();
} else {
if (!g.selected) {
if (!d3.event.ctrlKey && !d3.event.metaKey) {
- var ag = activeGroup;
clearSelection();
- if (ag && g.g === ag.id) {
- enterActiveGroup(ag);
- activeGroup.selected = true;
- }
}
- if (activeGroup) {
- if (!RED.group.contains(activeGroup,g)) {
- // Clicked on a group that is outside the activeGroup
- exitActiveGroup();
- } else {
- }
- }
- selectGroup(g,true);//!wasSelected);
- } else if (activeGroup && g.g !== activeGroup.id){
- exitActiveGroup();
+ selectedGroups.add(g,true);//!wasSelected);
}
-
if (d3.event.button != 2) {
var d = g.nodes[0];
prepareDrag(mouse);
@@ -4061,65 +3936,17 @@ RED.view = (function() {
d3.event.stopPropagation();
}
- function selectGroup(g, includeNodes, addToMovingSet) {
- if (!g.selected) {
- g.selected = true;
- g.dirty = true;
- }
- if (addToMovingSet !== false) {
- movingSet.add(g);
- }
- if (includeNodes) {
- var currentSet = new Set(movingSet.nodes());
- var allNodes = RED.group.getNodes(g,true);
- allNodes.forEach(function(n) {
- if (!currentSet.has(n)) {
- movingSet.add(n)
- // n.selected = true;
- }
- n.dirty = true;
- })
- }
- }
- function enterActiveGroup(group) {
- if (activeGroup) {
- exitActiveGroup();
- }
- group.active = true;
- group.dirty = true;
- activeGroup = group;
- movingSet.remove(group);
- }
- function exitActiveGroup() {
- if (activeGroup) {
- activeGroup.active = false;
- activeGroup.dirty = true;
- deselectGroup(activeGroup);
- selectGroup(activeGroup,true);
- activeGroup = null;
- }
- }
- function deselectGroup(g) {
- if (g.selected) {
- g.selected = false;
- g.dirty = true;
- }
- var nodeSet = new Set(g.nodes);
- nodeSet.add(g);
- for (var i = movingSet.length()-1; i >= 0; i -= 1) {
- var msn = movingSet.get(i);
- if (nodeSet.has(msn.n) || msn.n === g) {
- msn.n.selected = false;
- msn.n.dirty = true;
- movingSet.remove(msn.n,i)
- }
- }
- }
- function getGroupAt(x,y) {
+ function getGroupAt(x, y, ignoreSelected) {
// x,y expected to be in node-co-ordinate space
var candidateGroups = {};
for (var i=0;i= g.x && x <= g.x + g.w && y >= g.y && y <= g.y + g.h) {
candidateGroups[g.id] = g;
}
@@ -4143,7 +3970,7 @@ RED.view = (function() {
function isButtonEnabled(d) {
var buttonEnabled = true;
var ws = RED.nodes.workspace(RED.workspaces.active());
- if (ws && !ws.disabled && !d.d) {
+ if (ws && !ws.disabled && !d.d && !ws.locked) {
if (d._def.button.hasOwnProperty('enabled')) {
if (typeof d._def.button.enabled === "function") {
buttonEnabled = d._def.button.enabled.call(d);
@@ -4166,7 +3993,7 @@ RED.view = (function() {
}
var activeWorkspace = RED.workspaces.active();
var ws = RED.nodes.workspace(activeWorkspace);
- if (ws && !ws.disabled && !d.d) {
+ if (ws && !ws.disabled && !d.d && !ws.locked) {
if (d._def.button.toggle) {
d[d._def.button.toggle] = !d[d._def.button.toggle];
d.dirty = true;
@@ -4181,7 +4008,7 @@ RED.view = (function() {
if (d.dirty) {
redraw();
}
- } else {
+ } else if (!ws || !ws.locked){
if (activeSubflow) {
RED.notify(RED._("notification.warning", {message:RED._("notification.warnings.nodeActionDisabledSubflow")}),"warning");
} else {
@@ -4196,14 +4023,15 @@ RED.view = (function() {
function showTouchMenu(obj,pos) {
var mdn = mousedown_node;
var options = [];
- options.push({name:"delete",disabled:(movingSet.length()===0 && selectedLinks.length() === 0),onselect:function() {deleteSelection();}});
- options.push({name:"cut",disabled:(movingSet.length()===0),onselect:function() {copySelection(true);deleteSelection();}});
- options.push({name:"copy",disabled:(movingSet.length()===0),onselect:function() {copySelection();}});
- options.push({name:"paste",disabled:(clipboard.length===0),onselect:function() {importNodes(clipboard, {generateIds: true, touchImport: true});}});
- options.push({name:"edit",disabled:(movingSet.length() != 1),onselect:function() { RED.editor.edit(mdn);}});
+ const isActiveLocked = RED.workspaces.isLocked()
+ options.push({name:"delete",disabled:(isActiveLocked || movingSet.length()===0 && selectedLinks.length() === 0),onselect:function() {deleteSelection();}});
+ options.push({name:"cut",disabled:(isActiveLocked || movingSet.length()===0),onselect:function() {copySelection(true);deleteSelection();}});
+ options.push({name:"copy",disabled:(isActiveLocked || movingSet.length()===0),onselect:function() {copySelection();}});
+ options.push({name:"paste",disabled:(isActiveLocked || clipboard.length===0),onselect:function() {importNodes(clipboard, {generateIds: true, touchImport: true});}});
+ options.push({name:"edit",disabled:(isActiveLocked || movingSet.length() != 1),onselect:function() { RED.editor.edit(mdn);}});
options.push({name:"select",onselect:function() {selectAll();}});
options.push({name:"undo",disabled:(RED.history.depth() === 0),onselect:function() {RED.history.pop();}});
- options.push({name:"add",onselect:function() {
+ options.push({name:"add",disabled:isActiveLocked, onselect:function() {
chartPos = chart.offset();
showQuickAddDialog({
position:[pos[0]-chartPos.left+chart.scrollLeft(),pos[1]-chartPos.top+chart.scrollTop()],
@@ -4546,6 +4374,7 @@ RED.view = (function() {
this.__port__.setAttribute("transform","translate(-5,"+((d.h/2)-5)+")");
this.__outputOutput__.setAttribute("transform","translate(20,"+((d.h/2)-8)+")");
this.__outputNumber__.setAttribute("transform","translate(20,"+((d.h/2)+7)+")");
+ this.__outputNumber__.textContent = d.i+1;
}
d.dirty = false;
}
@@ -4735,6 +4564,7 @@ RED.view = (function() {
nodesReordered = true;
delete d._reordered;
}
+
if (d.dirty) {
var self = this;
var thisNode = d3.select(this);
@@ -5388,23 +5218,30 @@ RED.view = (function() {
g.attr("id",d.id);
var groupBorderRadius = 4;
-
+ var groupOutlineBorderRadius = 6
var selectGroup = groupSelectLayer.append('g').attr("class", "red-ui-flow-group").attr("id","group_select_"+d.id);
- selectGroup.append('rect').classed("red-ui-flow-group-outline-select",true)
+ const groupBackground = selectGroup.append('rect')
+ .classed("red-ui-flow-group-outline-select",true)
.classed("red-ui-flow-group-outline-select-background",true)
- .attr('rx',groupBorderRadius).attr('ry',groupBorderRadius)
- .attr("x",-4)
- .attr("y",-4);
-
-
- selectGroup.append('rect').classed("red-ui-flow-group-outline-select",true)
- .attr('rx',groupBorderRadius).attr('ry',groupBorderRadius)
- .attr("x",-4)
- .attr("y",-4)
- selectGroup.on("mousedown", function() {groupMouseDown.call(g[0][0],d)});
- selectGroup.on("mouseup", function() {groupMouseUp.call(g[0][0],d)});
- selectGroup.on("touchstart", function() {groupMouseDown.call(g[0][0],d); d3.event.preventDefault();});
- selectGroup.on("touchend", function() {groupMouseUp.call(g[0][0],d); d3.event.preventDefault();});
+ .attr('rx',groupOutlineBorderRadius).attr('ry',groupOutlineBorderRadius)
+ .attr("x",-3)
+ .attr("y",-3);
+ selectGroup.append('rect')
+ .classed("red-ui-flow-group-outline-select",true)
+ .classed("red-ui-flow-group-outline-select-outline",true)
+ .attr('rx',groupOutlineBorderRadius).attr('ry',groupOutlineBorderRadius)
+ .attr("x",-3)
+ .attr("y",-3)
+ selectGroup.append('rect')
+ .classed("red-ui-flow-group-outline-select",true)
+ .classed("red-ui-flow-group-outline-select-line",true)
+ .attr('rx',groupOutlineBorderRadius).attr('ry',groupOutlineBorderRadius)
+ .attr("x",-3)
+ .attr("y",-3)
+ groupBackground.on("mousedown", function() {groupMouseDown.call(g[0][0],d)});
+ groupBackground.on("mouseup", function() {groupMouseUp.call(g[0][0],d)});
+ groupBackground.on("touchstart", function() {groupMouseDown.call(g[0][0],d); d3.event.preventDefault();});
+ groupBackground.on("touchend", function() {groupMouseUp.call(g[0][0],d); d3.event.preventDefault();});
g.append('rect').classed("red-ui-flow-group-outline",true).attr('rx',0.5).attr('ry',0.5);
@@ -5422,11 +5259,7 @@ RED.view = (function() {
});
if (addedGroups) {
group.sort(function(a,b) {
- if (a._root === b._root) {
- return a._depth - b._depth;
- } else {
- return a._index - b._index;
- }
+ return a._order - b._order
})
}
group[0].reverse();
@@ -5451,6 +5284,11 @@ RED.view = (function() {
var margin = 26;
d.nodes.forEach(function(n) {
groupOpCount++
+ if (n._detachFromGroup) {
+ // Do not include this node when recalulating
+ // the group dimensions
+ return
+ }
if (n.type !== "group") {
minX = Math.min(minX,n.x-n.w/2-margin-((n._def.button && n._def.align!=="right")?20:0));
minY = Math.min(minY,n.y-n.h/2-margin);
@@ -5463,11 +5301,12 @@ RED.view = (function() {
maxY = Math.max(maxY,n.y+n.h+margin)
}
});
-
- d.x = minX;
- d.y = minY;
- d.w = maxX - minX;
- d.h = maxY - minY;
+ if (minX !== Number.POSITIVE_INFINITY && minY !== Number.POSITIVE_INFINITY) {
+ d.x = minX;
+ d.y = minY;
+ d.w = maxX - minX;
+ d.h = maxY - minY;
+ }
recalculateLabelOffsets = true;
// if set explicitly to false, this group has just been
// imported so needed this initial resize calculation.
@@ -5524,16 +5363,25 @@ RED.view = (function() {
} else {
selectGroup.classList.remove("red-ui-flow-group-hovered")
}
+ if (d.selected) {
+ selectGroup.classList.add("red-ui-flow-group-selected")
+ } else {
+ selectGroup.classList.remove("red-ui-flow-group-selected")
+ }
var selectGroupRect = selectGroup.children[0];
- selectGroupRect.setAttribute("width",d.w+8)
- selectGroupRect.setAttribute("height",d.h+8)
- selectGroupRect.style.strokeOpacity = (d.active || d.selected || d.highlighted)?0.8:0;
- selectGroupRect.style.strokeDasharray = (d.active)?"10 4":"";
+ // Background
+ selectGroupRect.setAttribute("width",d.w+6)
+ selectGroupRect.setAttribute("height",d.h+6)
+ // Outline
selectGroupRect = selectGroup.children[1];
- selectGroupRect.setAttribute("width",d.w+8)
- selectGroupRect.setAttribute("height",d.h+8)
- selectGroupRect.style.strokeOpacity = (d.active || d.selected || d.highlighted)?0.8:0;
- selectGroupRect.style.strokeDasharray = (d.active)?"10 4":"";
+ selectGroupRect.setAttribute("width",d.w+6)
+ selectGroupRect.setAttribute("height",d.h+6)
+ selectGroupRect.style.strokeOpacity = (d.selected || d.highlighted)?0.8:0;
+ // Line
+ selectGroupRect = selectGroup.children[2];
+ selectGroupRect.setAttribute("width",d.w+6)
+ selectGroupRect.setAttribute("height",d.h+6)
+ selectGroupRect.style.strokeOpacity = (d.selected || d.highlighted)?0.8:0;
if (d.highlighted) {
selectGroup.classList.add("red-ui-flow-node-highlighted");
@@ -5661,7 +5509,7 @@ RED.view = (function() {
if (mouse_mode === RED.state.SELECTING_NODE) {
return;
}
-
+ const wasDirty = RED.nodes.dirty()
var nodesToImport;
if (typeof newNodesObj === "string") {
if (newNodesObj === "") {
@@ -5678,7 +5526,7 @@ RED.view = (function() {
nodesToImport = newNodesObj;
}
- if (!$.isArray(nodesToImport)) {
+ if (!Array.isArray(nodesToImport)) {
nodesToImport = [nodesToImport];
}
if (options.generateDefaultNames) {
@@ -5694,7 +5542,29 @@ RED.view = (function() {
if (activeSubflow) {
activeSubflowChanged = activeSubflow.changed;
}
- var result = RED.nodes.import(nodesToImport,{generateIds:options.generateIds, addFlow: addNewFlow, importMap: options.importMap});
+ var filteredNodesToImport = nodesToImport;
+ var globalConfig = null;
+ var gconf = null;
+
+ RED.nodes.eachConfig(function (conf) {
+ if (conf.type === "global-config") {
+ gconf = conf;
+ }
+ });
+ if (gconf) {
+ filteredNodesToImport = nodesToImport.filter(function (n) {
+ return (n.type !== "global-config");
+ });
+ globalConfig = nodesToImport.find(function (n) {
+ return (n.type === "global-config");
+ });
+ }
+ var result = RED.nodes.import(filteredNodesToImport,{
+ generateIds: options.generateIds,
+ addFlow: addNewFlow,
+ importMap: options.importMap,
+ markChanged: true
+ });
if (result) {
var new_nodes = result.nodes;
var new_links = result.links;
@@ -5710,7 +5580,7 @@ RED.view = (function() {
var new_ms = new_nodes.filter(function(n) { return n.hasOwnProperty("x") && n.hasOwnProperty("y") && n.z == RED.workspaces.active() });
new_ms = new_ms.concat(new_groups.filter(function(g) { return g.z === RED.workspaces.active()}))
new_ms = new_ms.concat(new_junctions.filter(function(j) { return j.z === RED.workspaces.active()}))
- var new_node_ids = new_nodes.map(function(n){ n.changed = true; return n.id; });
+ var new_node_ids = new_nodes.map(function(n){ return n.id; });
clearSelection();
movingSet.clear();
@@ -5776,28 +5646,19 @@ RED.view = (function() {
}
if (!touchImport) {
mouse_mode = RED.state.IMPORT_DRAGGING;
- spliceActive = false;
- if (movingSet.length() === 1) {
- node = movingSet.get(0);
- spliceActive = node.n.hasOwnProperty("_def") &&
- ((node.n.hasOwnProperty("inputs") && node.n.inputs > 0) || (!node.n.hasOwnProperty("inputs") && node.n._def.inputs > 0)) &&
- ((node.n.hasOwnProperty("outputs") && node.n.outputs > 0) || (!node.n.hasOwnProperty("outputs") && node.n._def.outputs > 0))
-
-
- }
+ startSelectionMove()
}
-
}
var historyEvent = {
- t:"add",
- nodes:new_node_ids,
- links:new_links,
- groups:new_groups,
+ t: "add",
+ nodes: new_node_ids,
+ links: new_links,
+ groups: new_groups,
junctions: new_junctions,
- workspaces:new_workspaces,
- subflows:new_subflows,
- dirty:RED.nodes.dirty()
+ workspaces: new_workspaces,
+ subflows: new_subflows,
+ dirty: wasDirty
};
if (movingSet.length() === 0) {
RED.nodes.dirty(true);
@@ -5806,7 +5667,7 @@ RED.view = (function() {
var subflowRefresh = RED.subflow.refresh(true);
if (subflowRefresh) {
historyEvent.subflow = {
- id:activeSubflow.id,
+ id: activeSubflow.id,
changed: activeSubflowChanged,
instances: subflowRefresh.instances
}
@@ -5826,6 +5687,50 @@ RED.view = (function() {
}
}
+ if (globalConfig) {
+ // merge global env to existing global-config
+ var env0 = gconf.env;
+ var env1 = globalConfig.env;
+ var newEnv = Array.from(env0);
+ var changed = false;
+
+ env1.forEach(function (item1) {
+ var index = newEnv.findIndex(function (item0) {
+ return (item0.name === item1.name);
+ });
+ if (index >= 0) {
+ var item0 = newEnv[index];
+ if ((item0.type !== item1.type) ||
+ (item0.value !== item1.value)) {
+ newEnv[index] = item1;
+ changed = true;
+ }
+ }
+ else {
+ newEnv.push(item1);
+ changed = true;
+ }
+ });
+ if(changed) {
+ gconf.env = newEnv;
+ var replaceEvent = {
+ t: "edit",
+ node: gconf,
+ changed: true,
+ changes: {
+ env: env0
+ }
+ };
+ historyEvent = {
+ t:"multi",
+ events: [
+ replaceEvent,
+ historyEvent,
+ ]
+ };
+ }
+ }
+
RED.history.push(historyEvent);
updateActiveNodes();
@@ -5880,6 +5785,59 @@ RED.view = (function() {
}
}
+ function startSelectionMove() {
+ spliceActive = false;
+ if (movingSet.length() === 1) {
+ const node = movingSet.get(0);
+ spliceActive = node.n.hasOwnProperty("_def") &&
+ ((node.n.hasOwnProperty("inputs") && node.n.inputs > 0) || (!node.n.hasOwnProperty("inputs") && node.n._def.inputs > 0)) &&
+ ((node.n.hasOwnProperty("outputs") && node.n.outputs > 0) || (!node.n.hasOwnProperty("outputs") && node.n._def.outputs > 0)) &&
+ RED.nodes.filterLinks({ source: node.n }).length === 0 &&
+ RED.nodes.filterLinks({ target: node.n }).length === 0;
+ }
+ groupAddActive = false
+ groupAddParentGroup = null
+ if (movingSet.length() > 0 && activeGroups) {
+ // movingSet includes the selection AND any nodes inside selected groups
+ // So we cannot simply check the `g` of all nodes match.
+ // Instead, we have to:
+ // - note all groups in movingSet
+ // - note all .g values referenced in movingSet
+ // - then check for g values for groups not in movingSet
+ let isValidSelection = true
+ let hasNullGroup = false
+ const selectedGroups = []
+ const referencedGroups = new Set()
+ movingSet.forEach(n => {
+ if (n.n.type === 'subflow') {
+ isValidSelection = false
+ }
+ if (n.n.type === 'group') {
+ selectedGroups.push(n.n.id)
+ }
+ if (n.n.g) {
+ referencedGroups.add(n.n.g)
+ } else {
+ hasNullGroup = true
+ }
+ })
+ if (isValidSelection) {
+ selectedGroups.forEach(g => referencedGroups.delete(g))
+ // console.log('selectedGroups', selectedGroups)
+ // console.log('referencedGroups',referencedGroups)
+ // console.log('hasNullGroup', hasNullGroup)
+ if (referencedGroups.size === 0) {
+ groupAddActive = true
+ } else if (!hasNullGroup && referencedGroups.size === 1) {
+ groupAddParentGroup = referencedGroups.values().next().value
+ groupAddActive = true
+ }
+ }
+ // console.log('groupAddActive', groupAddActive)
+ // console.log('groupAddParentGroup', groupAddParentGroup)
+ }
+ }
+
function toggleShowGrid(state) {
if (state) {
gridLayer.style("visibility","visible");
@@ -5901,6 +5859,9 @@ RED.view = (function() {
if (mouse_mode === RED.state.SELECTING_NODE) {
return;
}
+ if (activeFlowLocked) {
+ return
+ }
var workspaceSelection = RED.workspaces.selection();
var changed = false;
if (workspaceSelection.length > 0) {
@@ -5960,20 +5921,13 @@ RED.view = (function() {
}
});
}
- var selectedGroups = activeGroups.filter(function(g) { return g.selected && !g.active });
- if (selectedGroups.length > 0) {
- if (selectedGroups.length === 1 && selectedGroups[0].active) {
- // Let nodes be nodes
- } else {
- selectedGroups.forEach(function(g) {
- var groupNodes = RED.group.getNodes(g,true);
- groupNodes.forEach(function(n) {
- allNodes.delete(n);
- });
- allNodes.add(g);
- });
- }
- }
+ selectedGroups.forEach(function(g) {
+ var groupNodes = RED.group.getNodes(g,true);
+ groupNodes.forEach(function(n) {
+ allNodes.delete(n);
+ });
+ allNodes.add(g);
+ });
if (allNodes.size > 0) {
selection.nodes = Array.from(allNodes);
}
@@ -6160,6 +6114,13 @@ RED.view = (function() {
selectedNode.dirty = true;
movingSet.clear();
movingSet.add(selectedNode);
+ } else {
+ selectedNode = RED.nodes.group(selection);
+ if (selectedNode) {
+ movingSet.clear();
+ selectedGroups.clear()
+ selectedGroups.add(selectedNode)
+ }
}
} else if (selection) {
if (selection.nodes) {
@@ -6175,7 +6136,7 @@ RED.view = (function() {
n.dirty = true;
movingSet.add(n);
} else {
- selectGroup(n,true);
+ selectedGroups.add(n,true);
}
})
}
@@ -6218,7 +6179,7 @@ RED.view = (function() {
return result;
},
getGroupAtPoint: getGroupAt,
- getActiveGroup: function() { return activeGroup },
+ getActiveGroup: function() { return null },
reveal: function(id,triggerHighlight) {
if (RED.nodes.workspace(id) || RED.nodes.subflow(id)) {
RED.workspaces.show(id, null, null, true);
@@ -6228,7 +6189,9 @@ RED.view = (function() {
if (node.z && (node.type === "group" || node._def.category !== 'config')) {
node.dirty = true;
RED.workspaces.show(node.z);
-
+ if (node.type === "group" && !node.w && !node.h) {
+ _redraw();
+ }
var screenSize = [chart[0].clientWidth/scaleFactor,chart[0].clientHeight/scaleFactor];
var scrollPos = [chart.scrollLeft()/scaleFactor,chart.scrollTop()/scaleFactor];
var cx = node.x;
@@ -6341,8 +6304,12 @@ RED.view = (function() {
})
},
scroll: function(x,y) {
- chart.scrollLeft(chart.scrollLeft()+x);
- chart.scrollTop(chart.scrollTop()+y)
+ if (x !== undefined && y !== undefined) {
+ chart.scrollLeft(chart.scrollLeft()+x);
+ chart.scrollTop(chart.scrollTop()+y)
+ } else {
+ return [chart.scrollLeft(), chart.scrollTop()]
+ }
},
clickNodeButton: function(n) {
if (n._def.button) {
diff --git a/packages/node_modules/@node-red/editor-client/src/js/ui/workspaces.js b/packages/node_modules/@node-red/editor-client/src/js/ui/workspaces.js
index 1f5cdf0f1..1a71577ce 100644
--- a/packages/node_modules/@node-red/editor-client/src/js/ui/workspaces.js
+++ b/packages/node_modules/@node-red/editor-client/src/js/ui/workspaces.js
@@ -58,6 +58,9 @@ RED.workspaces = (function() {
if (!ws.closeable) {
ws.hideable = true;
}
+ if (!ws.hasOwnProperty('locked')) {
+ ws.locked = false
+ }
workspace_tabs.addTab(ws,targetIndex);
var hiddenTabs = JSON.parse(RED.settings.getLocal("hiddenTabs")||"{}");
@@ -75,11 +78,15 @@ RED.workspaces = (function() {
type: "tab",
id: tabId,
disabled: false,
+ locked: false,
info: "",
label: RED._('workspace.defaultName',{number:workspaceIndex}),
env: [],
- hideable: true
+ hideable: true,
};
+ if (!skipHistoryEntry) {
+ ws.added = true
+ }
RED.nodes.addWorkspace(ws,targetIndex);
workspace_tabs.addTab(ws,targetIndex);
@@ -89,8 +96,7 @@ RED.workspaces = (function() {
RED.nodes.dirty(true);
}
}
- $("#red-ui-tab-"+(ws.id.replace(".","-"))).attr("flowname",ws.label)
-
+ $("#red-ui-tab-"+(ws.id.replace(".","-"))).attr("flowname",ws.label).toggleClass('red-ui-workspace-changed',!!(ws.contentsChanged || ws.changed || ws.added));
RED.view.focus();
return ws;
}
@@ -99,6 +105,9 @@ RED.workspaces = (function() {
if (workspaceTabCount === 1) {
return;
}
+ if (ws.locked) {
+ return
+ }
var workspaceOrder = RED.nodes.getWorkspaceOrder();
ws._index = workspaceOrder.indexOf(ws.id);
removeWorkspace(ws);
@@ -119,13 +128,206 @@ RED.workspaces = (function() {
RED.editor.editSubflow(subflow);
}
} else {
- RED.editor.editFlow(workspace);
+ if (!workspace.locked) {
+ RED.editor.editFlow(workspace);
+ }
}
}
var workspace_tabs;
var workspaceTabCount = 0;
+
+ function getMenuItems(isMenuButton, tab) {
+ let hiddenFlows = new Set()
+ for (let i = 0; i < hideStack.length; i++) {
+ let ids = hideStack[i]
+ if (!Array.isArray(ids)) {
+ ids = [ids]
+ }
+ ids.forEach(id => {
+ if (RED.nodes.workspace(id)) {
+ hiddenFlows.add(id)
+ }
+ })
+ }
+ const hiddenflowCount = hiddenFlows.size;
+ let activeWorkspace = tab || RED.nodes.workspace(RED.workspaces.active()) || RED.nodes.subflow(RED.workspaces.active())
+ let isFlowDisabled = activeWorkspace ? activeWorkspace.disabled : false
+ const currentTabs = workspace_tabs.listTabs();
+ let flowCount = 0;
+ currentTabs.forEach(tab => {
+ if (RED.nodes.workspace(tab)) {
+ flowCount++;
+ }
+ });
+
+ let isCurrentLocked = RED.workspaces.isLocked()
+ if (tab) {
+ isCurrentLocked = tab.locked
+ }
+
+ var menuItems = []
+ if (isMenuButton) {
+ menuItems.push({
+ id:"red-ui-tabs-menu-option-search-flows",
+ label: RED._("workspace.listFlows"),
+ onselect: "core:list-flows"
+ },
+ {
+ id:"red-ui-tabs-menu-option-search-subflows",
+ label: RED._("workspace.listSubflows"),
+ onselect: "core:list-subflows"
+ },
+ null)
+ }
+ menuItems.push(
+ {
+ id:"red-ui-tabs-menu-option-add-flow",
+ label: RED._("workspace.addFlow"),
+ onselect: "core:add-flow"
+ }
+ )
+ if (isMenuButton || !!tab) {
+ menuItems.push(
+ {
+ id:"red-ui-tabs-menu-option-add-flow-right",
+ label: RED._("workspace.addFlowToRight"),
+ shortcut: RED.keyboard.getShortcut("core:add-flow-to-right"),
+ onselect: function() {
+ RED.actions.invoke("core:add-flow-to-right", tab)
+ }
+ },
+ null
+ )
+ if (activeWorkspace && activeWorkspace.type === 'tab') {
+ menuItems.push(
+ isFlowDisabled ? {
+ label: RED._("workspace.enableFlow"),
+ shortcut: RED.keyboard.getShortcut("core:enable-flow"),
+ onselect: function() {
+ RED.actions.invoke("core:enable-flow", tab?tab.id:undefined)
+ },
+ disabled: isCurrentLocked
+ } : {
+ label: RED._("workspace.disableFlow"),
+ shortcut: RED.keyboard.getShortcut("core:disable-flow"),
+ onselect: function() {
+ RED.actions.invoke("core:disable-flow", tab?tab.id:undefined)
+ },
+ disabled: isCurrentLocked
+ },
+ isCurrentLocked? {
+ label: RED._("workspace.unlockFlow"),
+ shortcut: RED.keyboard.getShortcut("core:unlock-flow"),
+ onselect: function() {
+ RED.actions.invoke('core:unlock-flow', tab?tab.id:undefined)
+ }
+ } : {
+ label: RED._("workspace.lockFlow"),
+ shortcut: RED.keyboard.getShortcut("core:lock-flow"),
+ onselect: function() {
+ RED.actions.invoke('core:lock-flow', tab?tab.id:undefined)
+ }
+ },
+ null
+ )
+ }
+ const activeIndex = currentTabs.findIndex(id => (activeWorkspace && (id === activeWorkspace.id)));
+ menuItems.push(
+ {
+ label: RED._("workspace.moveToStart"),
+ shortcut: RED.keyboard.getShortcut("core:move-flow-to-start"),
+ onselect: function() {
+ RED.actions.invoke("core:move-flow-to-start", tab?tab.id:undefined)
+ },
+ disabled: activeIndex === 0
+ },
+ {
+ label: RED._("workspace.moveToEnd"),
+ shortcut: RED.keyboard.getShortcut("core:move-flow-to-end"),
+ onselect: function() {
+ RED.actions.invoke("core:move-flow-to-end", tab?tab.id:undefined)
+ },
+ disabled: activeIndex === currentTabs.length - 1
+ }
+ )
+ }
+ menuItems.push(null)
+ if (isMenuButton || !!tab) {
+ menuItems.push(
+ {
+ id:"red-ui-tabs-menu-option-add-hide-flows",
+ label: RED._("workspace.hideFlow"),
+ shortcut: RED.keyboard.getShortcut("core:hide-flow"),
+ onselect: function() {
+ RED.actions.invoke("core:hide-flow", tab)
+ }
+ },
+ {
+ id:"red-ui-tabs-menu-option-add-hide-other-flows",
+ label: RED._("workspace.hideOtherFlows"),
+ shortcut: RED.keyboard.getShortcut("core:hide-other-flows"),
+ onselect: function() {
+ RED.actions.invoke("core:hide-other-flows", tab)
+ }
+ }
+ )
+
+ }
+
+ menuItems.push(
+ {
+ id:"red-ui-tabs-menu-option-add-hide-all-flows",
+ label: RED._("workspace.hideAllFlows"),
+ onselect: "core:hide-all-flows",
+ disabled: (hiddenflowCount === flowCount)
+ },
+ {
+ id:"red-ui-tabs-menu-option-add-show-all-flows",
+ disabled: hiddenflowCount === 0,
+ label: RED._("workspace.showAllFlows", { count: hiddenflowCount }),
+ onselect: "core:show-all-flows"
+ },
+ {
+ id:"red-ui-tabs-menu-option-add-show-last-flow",
+ disabled: hideStack.length === 0,
+ label: RED._("workspace.showLastHiddenFlow"),
+ onselect: "core:show-last-hidden-flow"
+ }
+ )
+ if (tab) {
+ menuItems.push(
+ null,
+ {
+ label: RED._("common.label.delete"),
+ onselect: function() {
+ if (tab.type === 'tab') {
+ RED.workspaces.delete(tab)
+ } else if (tab.type === 'subflow') {
+ RED.subflow.delete(tab.id)
+ }
+ },
+ disabled: isCurrentLocked || (workspaceTabCount === 1)
+ },
+ {
+ label: RED._("menu.label.export"),
+ shortcut: RED.keyboard.getShortcut("core:show-export-dialog"),
+ onselect: function() {
+ RED.workspaces.show(tab.id)
+ RED.actions.invoke('core:show-export-dialog', null, 'flow')
+ }
+ }
+ )
+ }
+ // if (isMenuButton && hiddenflowCount > 0) {
+ // menuItems.unshift({
+ // label: RED._("workspace.hiddenFlows",{count: hiddenflowCount}),
+ // onselect: "core:list-hidden-flows"
+ // })
+ // }
+ return menuItems;
+ }
function createWorkspaceTabs() {
workspace_tabs = RED.tabs.create({
id: "red-ui-workspace-tabs",
@@ -137,8 +339,9 @@ RED.workspaces = (function() {
$("#red-ui-workspace-chart").show();
activeWorkspace = tab.id;
window.location.hash = 'flow/'+tab.id;
- $("#red-ui-workspace").toggleClass("red-ui-workspace-disabled",!!tab.disabled);
- } else {
+ $("#red-ui-workspace").toggleClass("red-ui-workspace-disabled", !!tab.disabled);
+ $("#red-ui-workspace").toggleClass("red-ui-workspace-locked", !!tab.locked);
+ } else {
$("#red-ui-workspace-chart").hide();
activeWorkspace = 0;
window.location.hash = '';
@@ -169,6 +372,18 @@ RED.workspaces = (function() {
if (tab.disabled) {
$("#red-ui-tab-"+(tab.id.replace(".","-"))).addClass('red-ui-workspace-disabled');
}
+ $('').prependTo("#red-ui-tab-"+(tab.id.replace(".","-"))+" .red-ui-tab-label");
+ if (tab.locked) {
+ $("#red-ui-tab-"+(tab.id.replace(".","-"))).addClass('red-ui-workspace-locked');
+ }
+
+ const changeBadgeContainer = $('').appendTo("#red-ui-tab-"+(tab.id.replace(".","-")))
+ const changeBadge = document.createElementNS("http://www.w3.org/2000/svg","circle");
+ changeBadge.setAttribute("cx",5);
+ changeBadge.setAttribute("cy",5);
+ changeBadge.setAttribute("r",5);
+ changeBadgeContainer.append(changeBadge)
+
RED.menu.setDisabled("menu-item-workspace-delete",activeWorkspace === 0 || workspaceTabCount <= 1);
if (workspaceTabCount === 1) {
showWorkspace();
@@ -189,13 +404,19 @@ RED.workspaces = (function() {
RED.history.push({
t:'reorder',
workspaces: {
- from:oldOrder,
- to:newOrder
+ from: oldOrder,
+ to: newOrder
},
dirty:RED.nodes.dirty()
});
- RED.nodes.dirty(true);
- setWorkspaceOrder(newOrder);
+ // Only mark flows dirty if flow-order has changed (excluding subflows)
+ const filteredOldOrder = oldOrder.filter(id => !!RED.nodes.workspace(id))
+ const filteredNewOrder = newOrder.filter(id => !!RED.nodes.workspace(id))
+
+ if (JSON.stringify(filteredOldOrder) !== JSON.stringify(filteredNewOrder)) {
+ RED.nodes.dirty(true);
+ setWorkspaceOrder(newOrder);
+ }
},
onselect: function(selectedTabs) {
RED.view.select(false)
@@ -214,12 +435,12 @@ RED.workspaces = (function() {
},
onhide: function(tab) {
hideStack.push(tab.id);
-
- var hiddenTabs = JSON.parse(RED.settings.getLocal("hiddenTabs")||"{}");
- hiddenTabs[tab.id] = true;
- RED.settings.setLocal("hiddenTabs",JSON.stringify(hiddenTabs));
-
- RED.events.emit("workspace:hide",{workspace: tab.id})
+ if (tab.type === "tab") {
+ var hiddenTabs = JSON.parse(RED.settings.getLocal("hiddenTabs")||"{}");
+ hiddenTabs[tab.id] = true;
+ RED.settings.setLocal("hiddenTabs",JSON.stringify(hiddenTabs));
+ RED.events.emit("workspace:hide",{workspace: tab.id})
+ }
},
onshow: function(tab) {
removeFromHideStack(tab.id);
@@ -234,77 +455,8 @@ RED.workspaces = (function() {
scrollable: true,
addButton: "core:add-flow",
addButtonCaption: RED._("workspace.addFlow"),
- menu: function() {
- var menuItems = [
- {
- id:"red-ui-tabs-menu-option-search-flows",
- label: RED._("workspace.listFlows"),
- onselect: "core:list-flows"
- },
- {
- id:"red-ui-tabs-menu-option-search-subflows",
- label: RED._("workspace.listSubflows"),
- onselect: "core:list-subflows"
- },
- null,
- {
- id:"red-ui-tabs-menu-option-add-flow",
- label: RED._("workspace.addFlow"),
- onselect: "core:add-flow"
- },
- {
- id:"red-ui-tabs-menu-option-add-flow-right",
- label: RED._("workspace.addFlowToRight"),
- onselect: "core:add-flow-to-right"
- },
- null,
- {
- id:"red-ui-tabs-menu-option-add-hide-flows",
- label: RED._("workspace.hideFlow"),
- onselect: "core:hide-flow"
- },
- {
- id:"red-ui-tabs-menu-option-add-hide-other-flows",
- label: RED._("workspace.hideOtherFlows"),
- onselect: "core:hide-other-flows"
- },
- {
- id:"red-ui-tabs-menu-option-add-show-all-flows",
- label: RED._("workspace.showAllFlows"),
- onselect: "core:show-all-flows"
- },
- {
- id:"red-ui-tabs-menu-option-add-hide-all-flows",
- label: RED._("workspace.hideAllFlows"),
- onselect: "core:hide-all-flows"
- },
- {
- id:"red-ui-tabs-menu-option-add-show-last-flow",
- label: RED._("workspace.showLastHiddenFlow"),
- onselect: "core:show-last-hidden-flow"
- }
- ]
- let hiddenFlows = new Set()
- for (let i = 0; i < hideStack.length; i++) {
- let ids = hideStack[i]
- if (!Array.isArray(ids)) {
- ids = [ids]
- }
- ids.forEach(id => {
- if (RED.nodes.workspace(id)) {
- hiddenFlows.add(id)
- }
- })
- }
- const flowCount = hiddenFlows.size;
- if (flowCount > 0) {
- menuItems.unshift({
- label: RED._("workspace.hiddenFlows",{count: flowCount}),
- onselect: "core:list-hidden-flows"
- })
- }
- return menuItems;
- }
+ menu: function() { return getMenuItems(true) },
+ contextmenu: function(tab) { return getMenuItems(false, tab) }
});
workspaceTabCount = 0;
}
@@ -355,16 +507,33 @@ RED.workspaces = (function() {
});
RED.actions.add("core:add-flow",function(opts) { addWorkspace(undefined,undefined,opts?opts.index:undefined)});
- RED.actions.add("core:add-flow-to-right",function(opts) { addWorkspace(undefined,undefined,workspace_tabs.activeIndex()+1)});
+ RED.actions.add("core:add-flow-to-right",function(workspace) {
+ let index
+ if (workspace) {
+ index = workspace_tabs.getTabIndex(workspace.id)+1
+ } else {
+ index = workspace_tabs.activeIndex()+1
+ }
+ addWorkspace(undefined,undefined,index)
+ });
RED.actions.add("core:edit-flow",editWorkspace);
RED.actions.add("core:remove-flow",removeWorkspace);
RED.actions.add("core:enable-flow",enableWorkspace);
RED.actions.add("core:disable-flow",disableWorkspace);
+ RED.actions.add("core:lock-flow",lockWorkspace);
+ RED.actions.add("core:unlock-flow",unlockWorkspace);
+ RED.actions.add("core:move-flow-to-start", function(id) { moveWorkspace(id, 'start') });
+ RED.actions.add("core:move-flow-to-end", function(id) { moveWorkspace(id, 'end') });
- RED.actions.add("core:hide-flow", function() {
- var selection = workspace_tabs.selection();
- if (selection.length === 0) {
- selection = [{id:activeWorkspace}]
+ RED.actions.add("core:hide-flow", function(workspace) {
+ let selection
+ if (workspace) {
+ selection = [workspace]
+ } else {
+ selection = workspace_tabs.selection();
+ if (selection.length === 0) {
+ selection = [{id:activeWorkspace}]
+ }
}
var hiddenTabs = [];
selection.forEach(function(ws) {
@@ -378,10 +547,15 @@ RED.workspaces = (function() {
workspace_tabs.clearSelection();
})
- RED.actions.add("core:hide-other-flows", function() {
- var selection = workspace_tabs.selection();
- if (selection.length === 0) {
- selection = [{id:activeWorkspace}]
+ RED.actions.add("core:hide-other-flows", function(workspace) {
+ let selection
+ if (workspace) {
+ selection = [workspace]
+ } else {
+ selection = workspace_tabs.selection();
+ if (selection.length === 0) {
+ selection = [{id:activeWorkspace}]
+ }
}
var selected = new Set(selection.map(function(ws) { return ws.id }))
@@ -471,6 +645,11 @@ RED.workspaces = (function() {
RED.workspaces.show(viewStack[++viewStackPos],true);
}
})
+
+ RED.events.on("flows:change", (ws) => {
+ $("#red-ui-tab-"+(ws.id.replace(".","-"))).toggleClass('red-ui-workspace-changed',!!(ws.contentsChanged || ws.changed || ws.added));
+ })
+
hideWorkspace();
}
@@ -486,7 +665,7 @@ RED.workspaces = (function() {
}
function setWorkspaceState(id,disabled) {
var workspace = RED.nodes.workspace(id||activeWorkspace);
- if (!workspace) {
+ if (!workspace || workspace.locked) {
return;
}
if (workspace.disabled !== disabled) {
@@ -521,11 +700,47 @@ RED.workspaces = (function() {
}
}
}
+ function lockWorkspace(id) {
+ setWorkspaceLockState(id,true);
+ }
+ function unlockWorkspace(id) {
+ setWorkspaceLockState(id,false);
+ }
+ function setWorkspaceLockState(id,locked) {
+ var workspace = RED.nodes.workspace(id||activeWorkspace);
+ if (!workspace) {
+ return;
+ }
+ if (workspace.locked !== locked) {
+ var changes = { locked: workspace.locked };
+ workspace.locked = locked;
+ $("#red-ui-tab-"+(workspace.id.replace(".","-"))).toggleClass('red-ui-workspace-locked',!!workspace.locked);
+ if (!id || (id === activeWorkspace)) {
+ $("#red-ui-workspace").toggleClass("red-ui-workspace-locked",!!workspace.locked);
+ }
+ var historyEvent = {
+ t: "edit",
+ changes:changes,
+ node: workspace,
+ dirty: RED.nodes.dirty()
+ }
+ workspace.changed = true;
+ RED.history.push(historyEvent);
+ RED.events.emit("flows:change",workspace);
+ RED.nodes.dirty(true);
+ RED.nodes.filterNodes({z:workspace.id}).forEach(n => n.dirty = true)
+ RED.view.redraw(true);
+ }
+ }
function removeWorkspace(ws) {
if (!ws) {
- deleteWorkspace(RED.nodes.workspace(activeWorkspace));
+ ws = RED.nodes.workspace(activeWorkspace)
+ if (ws && !ws.locked) {
+ deleteWorkspace(RED.nodes.workspace(activeWorkspace));
+ }
} else {
+ if (ws.locked) { return }
if (workspace_tabs.contains(ws.id)) {
workspace_tabs.removeTab(ws.id);
}
@@ -535,16 +750,46 @@ RED.workspaces = (function() {
}
}
+ function moveWorkspace(id, direction) {
+ const workspace = RED.nodes.workspace(id||activeWorkspace) || RED.nodes.subflow(id||activeWorkspace);
+ if (!workspace) {
+ return;
+ }
+ const currentOrder = workspace_tabs.listTabs()
+ const oldOrder = [...currentOrder]
+ const currentIndex = currentOrder.findIndex(id => id === workspace.id)
+ currentOrder.splice(currentIndex, 1)
+ if (direction === 'start') {
+ currentOrder.unshift(workspace.id)
+ } else if (direction === 'end') {
+ currentOrder.push(workspace.id)
+ }
+ const newOrder = setWorkspaceOrder(currentOrder)
+ if (JSON.stringify(newOrder) !== JSON.stringify(oldOrder)) {
+ RED.history.push({
+ t:'reorder',
+ workspaces: {
+ from:oldOrder,
+ to:newOrder
+ },
+ dirty:RED.nodes.dirty()
+ });
+ const filteredOldOrder = oldOrder.filter(id => !!RED.nodes.workspace(id))
+ const filteredNewOrder = newOrder.filter(id => !!RED.nodes.workspace(id))
+ if (JSON.stringify(filteredOldOrder) !== JSON.stringify(filteredNewOrder)) {
+ RED.nodes.dirty(true);
+ }
+ }
+ }
function setWorkspaceOrder(order) {
- var newOrder = order.filter(function(id) {
- return RED.nodes.workspace(id) !== undefined;
- })
+ var newOrder = order.filter(id => !!RED.nodes.workspace(id))
var currentOrder = RED.nodes.getWorkspaceOrder();
if (JSON.stringify(newOrder) !== JSON.stringify(currentOrder)) {
RED.nodes.setWorkspaceOrder(newOrder);
RED.events.emit("flows:reorder",newOrder);
}
workspace_tabs.order(order);
+ return newOrder
}
function flashTab(tabId) {
@@ -590,6 +835,11 @@ RED.workspaces = (function() {
active: function() {
return activeWorkspace
},
+ isLocked: function(id) {
+ id = id || activeWorkspace
+ var ws = RED.nodes.workspace(id) || RED.nodes.subflow(id)
+ return ws && ws.locked
+ },
selection: function() {
return workspace_tabs.selection();
},
@@ -646,6 +896,8 @@ RED.workspaces = (function() {
workspace_tabs.resize();
},
enable: enableWorkspace,
- disable: disableWorkspace
+ disable: disableWorkspace,
+ lock: lockWorkspace,
+ unlock: unlockWorkspace
}
})();
diff --git a/packages/node_modules/@node-red/editor-client/src/sass/dragdrop.scss b/packages/node_modules/@node-red/editor-client/src/sass/dragdrop.scss
index 78646e0e7..3d4b2253a 100644
--- a/packages/node_modules/@node-red/editor-client/src/sass/dragdrop.scss
+++ b/packages/node_modules/@node-red/editor-client/src/sass/dragdrop.scss
@@ -37,3 +37,27 @@
}
}
}
+
+#red-ui-image-drop-target {
+ position: absolute;
+ top: 0; bottom: 0;
+ left: 0; right: 0;
+ background: var(--red-ui-dnd-background);
+ display:table;
+ width: 100%;
+ height: 100%;
+ display: none;
+ z-index:100;
+ div {
+ pointer-events: none;
+ display: table-cell;
+ vertical-align: middle;
+ text-align: center;
+ font-size: 40px;
+ color: var(--red-ui-dnd-color);
+ i {
+ pointer-events: none;
+ font-size: 80px;
+ }
+ }
+}
diff --git a/packages/node_modules/@node-red/editor-client/src/sass/editor.scss b/packages/node_modules/@node-red/editor-client/src/sass/editor.scss
index f6f8eb4c1..dcc8060d4 100644
--- a/packages/node_modules/@node-red/editor-client/src/sass/editor.scss
+++ b/packages/node_modules/@node-red/editor-client/src/sass/editor.scss
@@ -87,16 +87,18 @@
padding: 0px 8px;
height: 26px;
line-height: 26px;
- &.toggle:not(.selected) {
+ &.toggle.selected {
color: var(--red-ui-workspace-button-color-selected) !important;
- background: var(--red-ui-workspace-button-background-active);
+ background: var(--red-ui-workspace-button-background) !important;
}
}
.red-ui-tray-footer-left {
- display:inline-block;
margin-right: 20px;
float:left;
+ & :not(:first-child) {
+ margin-left: 5px
+ }
}
.red-ui-tray-footer-right {
float: right;
diff --git a/packages/node_modules/@node-red/editor-client/src/sass/flow.scss b/packages/node_modules/@node-red/editor-client/src/sass/flow.scss
index be8db6c93..0eb68656b 100644
--- a/packages/node_modules/@node-red/editor-client/src/sass/flow.scss
+++ b/packages/node_modules/@node-red/editor-client/src/sass/flow.scss
@@ -68,6 +68,9 @@
stroke: var(--red-ui-node-border);
cursor: move;
stroke-width: 1;
+ .red-ui-workspace-locked & {
+ cursor: pointer;
+ }
}
.red-ui-workspace-select-mode {
g.red-ui-flow-node.red-ui-flow-node-hovered * {
@@ -88,10 +91,13 @@
.red-ui-flow-group {
&.red-ui-flow-group-hovered {
- .red-ui-flow-group-outline-select {
+ .red-ui-flow-group-outline-select-line {
stroke-opacity: 0.8 !important;
stroke-dasharray: 10 4 !important;
}
+ .red-ui-flow-group-outline-select-outline {
+ stroke-opacity: 0.8 !important;
+ }
}
&.red-ui-flow-group-active-hovered:not(.red-ui-flow-group-hovered) {
.red-ui-flow-group-outline-select {
@@ -110,15 +116,35 @@
.red-ui-flow-group-outline-select {
fill: none;
stroke: var(--red-ui-node-selected-color);
- pointer-events: stroke;
+ pointer-events: none;
stroke-opacity: 0;
- stroke-width: 3;
+ stroke-width: 2;
- &.red-ui-flow-group-outline-select-background {
+ &.red-ui-flow-group-outline-select-outline {
stroke: var(--red-ui-view-background);
- stroke-width: 6;
+ stroke-width: 4;
+ }
+ &.red-ui-flow-group-outline-select-background {
+ fill: white;
+ fill-opacity: 0;
+ pointer-events: stroke;
+ stroke-width: 16;
}
}
+
+svg:not(.red-ui-workspace-lasso-active) {
+ .red-ui-flow-group:not(.red-ui-flow-group-selected) {
+ .red-ui-flow-group-outline-select.red-ui-flow-group-outline-select-background:hover {
+ ~ .red-ui-flow-group-outline-select {
+ stroke-opacity: 0.4 !important;
+ }
+ ~ .red-ui-flow-group-outline-select-line {
+ stroke-dasharray: 10 4 !important;
+ }
+ }
+ }
+}
+
.red-ui-flow-group-body {
pointer-events: none;
fill: var(--red-ui-group-default-fill);
@@ -287,9 +313,11 @@ g.red-ui-flow-node-selected {
text-anchor:start;
}
-.red-ui-flow-port-hovered {
- stroke: var(--red-ui-port-selected-color);
- fill: var(--red-ui-port-selected-color);
+#red-ui-workspace:not(.red-ui-workspace-locked) {
+ .red-ui-flow-port-hovered {
+ stroke: var(--red-ui-port-selected-color);
+ fill: var(--red-ui-port-selected-color);
+ }
}
.red-ui-flow-subflow-port {
diff --git a/packages/node_modules/@node-red/editor-client/src/sass/tab-info.scss b/packages/node_modules/@node-red/editor-client/src/sass/tab-info.scss
index 2d7344df2..313025b27 100644
--- a/packages/node_modules/@node-red/editor-client/src/sass/tab-info.scss
+++ b/packages/node_modules/@node-red/editor-client/src/sass/tab-info.scss
@@ -468,6 +468,9 @@ div.red-ui-info-table {
.fa-eye {
display: none;
}
+ .fa-unlock-alt {
+ display: none;
+ }
}
.red-ui-info-outline-item-control-reveal,
.red-ui-info-outline-item-control-action {
@@ -501,6 +504,25 @@ div.red-ui-info-table {
display: none;
}
}
+ .fa-lock {
+ display: none;
+ }
+ .red-ui-info-outline-item.red-ui-info-outline-item-locked & {
+ .fa-lock {
+ display: inline-block;
+ }
+ .fa-unlock-alt {
+ display: none;
+ }
+ }
+ // If the parent is locked, do not show the display/action buttons when
+ // hovering in the outline
+ .red-ui-info-outline-item-locked .red-ui-info-outline-item & {
+ .red-ui-info-outline-item-control-disable,
+ .red-ui-info-outline-item-control-action {
+ display: none;
+ }
+ }
button {
margin-right: 3px
}
@@ -518,8 +540,6 @@ div.red-ui-info-table {
}
}
-
-
.red-ui-icons {
display: inline-block;
width: 18px;
diff --git a/packages/node_modules/@node-red/editor-client/src/sass/workspace.scss b/packages/node_modules/@node-red/editor-client/src/sass/workspace.scss
index a5734570d..e096c7cf3 100644
--- a/packages/node_modules/@node-red/editor-client/src/sass/workspace.scss
+++ b/packages/node_modules/@node-red/editor-client/src/sass/workspace.scss
@@ -105,7 +105,38 @@
}
}
}
+.red-ui-tab:not(.red-ui-workspace-changed) .red-ui-flow-tab-changed {
+ display: none;
+}
+.red-ui-tab.red-ui-workspace-changed .red-ui-flow-tab-changed {
+ display: inline-block;
+ position: absolute;
+ top: 1px;
+ right: 1px;
+}
+.red-ui-workspace-locked-icon {
+ display: none;
+}
+.red-ui-workspace-locked {
+ &.red-ui-tab {
+ // border-top-style: dashed;
+ // border-left-style: dashed;
+ // border-right-style: dashed;
+
+ // a {
+ // font-style: italic;
+ // color: var(--red-ui-tab-text-color-disabled-inactive) !important;
+ // }
+ // &.active a {
+ // font-weight: normal;
+ // color: var(--red-ui-tab-text-color-disabled-active) !important;
+ // }
+ .red-ui-workspace-locked-icon {
+ display: inline;
+ }
+ }
+}
#red-ui-navigator-canvas {
position: absolute;
diff --git a/packages/node_modules/@node-red/editor-client/src/tours/3.0/images/context-menu.png b/packages/node_modules/@node-red/editor-client/src/tours/3.0/images/context-menu.png
new file mode 100644
index 000000000..1acaab48b
Binary files /dev/null and b/packages/node_modules/@node-red/editor-client/src/tours/3.0/images/context-menu.png differ
diff --git a/packages/node_modules/@node-red/editor-client/src/tours/images/continuous-search.png b/packages/node_modules/@node-red/editor-client/src/tours/3.0/images/continuous-search.png
similarity index 100%
rename from packages/node_modules/@node-red/editor-client/src/tours/images/continuous-search.png
rename to packages/node_modules/@node-red/editor-client/src/tours/3.0/images/continuous-search.png
diff --git a/packages/node_modules/@node-red/editor-client/src/tours/images/debug-path-tooltip.png b/packages/node_modules/@node-red/editor-client/src/tours/3.0/images/debug-path-tooltip.png
similarity index 100%
rename from packages/node_modules/@node-red/editor-client/src/tours/images/debug-path-tooltip.png
rename to packages/node_modules/@node-red/editor-client/src/tours/3.0/images/debug-path-tooltip.png
diff --git a/packages/node_modules/@node-red/editor-client/src/tours/images/junction-quick-add.png b/packages/node_modules/@node-red/editor-client/src/tours/3.0/images/junction-quick-add.png
similarity index 100%
rename from packages/node_modules/@node-red/editor-client/src/tours/images/junction-quick-add.png
rename to packages/node_modules/@node-red/editor-client/src/tours/3.0/images/junction-quick-add.png
diff --git a/packages/node_modules/@node-red/editor-client/src/tours/images/junction-slice.gif b/packages/node_modules/@node-red/editor-client/src/tours/3.0/images/junction-slice.gif
similarity index 100%
rename from packages/node_modules/@node-red/editor-client/src/tours/images/junction-slice.gif
rename to packages/node_modules/@node-red/editor-client/src/tours/3.0/images/junction-slice.gif
diff --git a/packages/node_modules/@node-red/editor-client/src/tours/images/split-wire-with-links.gif b/packages/node_modules/@node-red/editor-client/src/tours/3.0/images/split-wire-with-links.gif
similarity index 100%
rename from packages/node_modules/@node-red/editor-client/src/tours/images/split-wire-with-links.gif
rename to packages/node_modules/@node-red/editor-client/src/tours/3.0/images/split-wire-with-links.gif
diff --git a/packages/node_modules/@node-red/editor-client/src/tours/3.0/welcome.js b/packages/node_modules/@node-red/editor-client/src/tours/3.0/welcome.js
new file mode 100644
index 000000000..4ec95c693
--- /dev/null
+++ b/packages/node_modules/@node-red/editor-client/src/tours/3.0/welcome.js
@@ -0,0 +1,197 @@
+export default {
+ version: "3.0.0",
+ steps: [
+ {
+ titleIcon: "fa fa-map-o",
+ title: {
+ "en-US": "Welcome to Node-RED 3.0!",
+ "ja": "Node-RED 3.0へようこそ!",
+ "fr": "Bienvenue dans Node-RED 3.0 !"
+ },
+ description: {
+ "en-US": " any>(fn?: Func, exact?: number): Func;
+ /**
+ * Example:
+ *
+ * ```js
+ * import assert from 'node:assert';
+ *
+ * const tracker = new assert.CallTracker();
+ *
+ * function func() {}
+ * const callsfunc = tracker.calls(func);
+ * callsfunc(1, 2, 3);
+ *
+ * assert.deepStrictEqual(tracker.getCalls(callsfunc),
+ * [{ thisArg: this, arguments: [1, 2, 3 ] }]);
+ * ```
+ *
+ * @since v18.8.0, v16.18.0
+ * @params fn
+ * @returns An Array with the calls to a tracked function.
+ */
+ getCalls(fn: Function): CallTrackerCall[];
+ /**
+ * The arrays contains information about the expected and actual number of calls of
+ * the functions that have not been called the expected number of times.
+ *
+ * ```js
+ * import assert from 'assert';
+ *
+ * // Creates call tracker.
+ * const tracker = new assert.CallTracker();
+ *
+ * function func() {}
+ *
+ * function foo() {}
+ *
+ * // Returns a function that wraps func() that must be called exact times
+ * // before tracker.verify().
+ * const callsfunc = tracker.calls(func, 2);
+ *
+ * // Returns an array containing information on callsfunc()
+ * tracker.report();
+ * // [
+ * // {
+ * // message: 'Expected the func function to be executed 2 time(s) but was
+ * // executed 0 time(s).',
+ * // actual: 0,
+ * // expected: 2,
+ * // operator: 'func',
+ * // stack: stack trace
+ * // }
+ * // ]
+ * ```
+ * @since v14.2.0, v12.19.0
+ * @return of objects containing information about the wrapper functions returned by `calls`.
+ */
report(): CallTrackerReportInformation[];
+ /**
+ * Reset calls of the call tracker.
+ * If a tracked function is passed as an argument, the calls will be reset for it.
+ * If no arguments are passed, all tracked functions will be reset.
+ *
+ * ```js
+ * import assert from 'node:assert';
+ *
+ * const tracker = new assert.CallTracker();
+ *
+ * function func() {}
+ * const callsfunc = tracker.calls(func);
+ *
+ * callsfunc();
+ * // Tracker was called once
+ * tracker.getCalls(callsfunc).length === 1;
+ *
+ * tracker.reset(callsfunc);
+ * tracker.getCalls(callsfunc).length === 0;
+ * ```
+ *
+ * @since v18.8.0, v16.18.0
+ * @param fn a tracked function to reset.
+ */
+ reset(fn?: Function): void;
+ /**
+ * Iterates through the list of functions passed to `tracker.calls()` and will throw an error for functions that
+ * have not been called the expected number of times.
+ *
+ * ```js
+ * import assert from 'assert';
+ *
+ * // Creates call tracker.
+ * const tracker = new assert.CallTracker();
+ *
+ * function func() {}
+ *
+ * // Returns a function that wraps func() that must be called exact times
+ * // before tracker.verify().
+ * const callsfunc = tracker.calls(func, 2);
+ *
+ * callsfunc();
+ *
+ * // Will throw an error since callsfunc() was only called once.
+ * tracker.verify();
+ * ```
+ * @since v14.2.0, v12.19.0
+ */
verify(): void;
}
+ interface CallTrackerCall {
+ thisArg: object;
+ arguments: unknown[];
+ }
interface CallTrackerReportInformation {
message: string;
/** The actual number of times the function was called. */
@@ -44,74 +189,764 @@ declare module 'assert' {
/** A stack trace of the function. */
stack: object;
}
-
- type AssertPredicate = RegExp | (new () => object) | ((thrown: any) => boolean) | object | Error;
-
+ type AssertPredicate = RegExp | (new () => object) | ((thrown: unknown) => boolean) | object | Error;
+ /**
+ * Throws an `AssertionError` with the provided error message or a default
+ * error message. If the `message` parameter is an instance of an `Error` then
+ * it will be thrown instead of the `AssertionError`.
+ *
+ * ```js
+ * import assert from 'assert/strict';
+ *
+ * assert.fail();
+ * // AssertionError [ERR_ASSERTION]: Failed
+ *
+ * assert.fail('boom');
+ * // AssertionError [ERR_ASSERTION]: boom
+ *
+ * assert.fail(new TypeError('need array'));
+ * // TypeError: need array
+ * ```
+ *
+ * Using `assert.fail()` with more than two arguments is possible but deprecated.
+ * See below for further details.
+ * @since v0.1.21
+ * @param [message='Failed']
+ */
function fail(message?: string | Error): never;
/** @deprecated since v10.0.0 - use fail([message]) or other assert functions instead. */
function fail(
- actual: any,
- expected: any,
+ actual: unknown,
+ expected: unknown,
message?: string | Error,
operator?: string,
// tslint:disable-next-line:ban-types
- stackStartFn?: Function,
+ stackStartFn?: Function
): never;
- function ok(value: any, message?: string | Error): asserts value;
- /** @deprecated since v9.9.0 - use strictEqual() instead. */
- function equal(actual: any, expected: any, message?: string | Error): void;
- /** @deprecated since v9.9.0 - use notStrictEqual() instead. */
- function notEqual(actual: any, expected: any, message?: string | Error): void;
- /** @deprecated since v9.9.0 - use deepStrictEqual() instead. */
- function deepEqual(actual: any, expected: any, message?: string | Error): void;
- /** @deprecated since v9.9.0 - use notDeepStrictEqual() instead. */
- function notDeepEqual(actual: any, expected: any, message?: string | Error): void;
- function strictEqual(actual: any, expected: T, message?: string | Error): asserts actual is T;
- function notStrictEqual(actual: any, expected: any, message?: string | Error): void;
- function deepStrictEqual(actual: any, expected: T, message?: string | Error): asserts actual is T;
- function notDeepStrictEqual(actual: any, expected: any, message?: string | Error): void;
-
- function throws(block: () => any, message?: string | Error): void;
- function throws(block: () => any, error: AssertPredicate, message?: string | Error): void;
- function doesNotThrow(block: () => any, message?: string | Error): void;
- function doesNotThrow(block: () => any, error: AssertPredicate, message?: string | Error): void;
-
- function ifError(value: any): asserts value is null | undefined;
-
- function rejects(block: (() => Promise) | Promise, message?: string | Error): Promise;
- function rejects(
- block: (() => Promise) | Promise,
- error: AssertPredicate,
- message?: string | Error,
- ): Promise;
- function doesNotReject(block: (() => Promise) | Promise, message?: string | Error): Promise;
- function doesNotReject(
- block: (() => Promise) | Promise,
- error: AssertPredicate,
- message?: string | Error,
- ): Promise;
-
+ /**
+ * Tests if `value` is truthy. It is equivalent to`assert.equal(!!value, true, message)`.
+ *
+ * If `value` is not truthy, an `AssertionError` is thrown with a `message`property set equal to the value of the `message` parameter. If the `message`parameter is `undefined`, a default
+ * error message is assigned. If the `message`parameter is an instance of an `Error` then it will be thrown instead of the`AssertionError`.
+ * If no arguments are passed in at all `message` will be set to the string:`` 'No value argument passed to `assert.ok()`' ``.
+ *
+ * Be aware that in the `repl` the error message will be different to the one
+ * thrown in a file! See below for further details.
+ *
+ * ```js
+ * import assert from 'assert/strict';
+ *
+ * assert.ok(true);
+ * // OK
+ * assert.ok(1);
+ * // OK
+ *
+ * assert.ok();
+ * // AssertionError: No value argument passed to `assert.ok()`
+ *
+ * assert.ok(false, 'it\'s false');
+ * // AssertionError: it's false
+ *
+ * // In the repl:
+ * assert.ok(typeof 123 === 'string');
+ * // AssertionError: false == true
+ *
+ * // In a file (e.g. test.js):
+ * assert.ok(typeof 123 === 'string');
+ * // AssertionError: The expression evaluated to a falsy value:
+ * //
+ * // assert.ok(typeof 123 === 'string')
+ *
+ * assert.ok(false);
+ * // AssertionError: The expression evaluated to a falsy value:
+ * //
+ * // assert.ok(false)
+ *
+ * assert.ok(0);
+ * // AssertionError: The expression evaluated to a falsy value:
+ * //
+ * // assert.ok(0)
+ * ```
+ *
+ * ```js
+ * import assert from 'assert/strict';
+ *
+ * // Using `assert()` works the same:
+ * assert(0);
+ * // AssertionError: The expression evaluated to a falsy value:
+ * //
+ * // assert(0)
+ * ```
+ * @since v0.1.21
+ */
+ function ok(value: unknown, message?: string | Error): asserts value;
+ /**
+ * **Strict assertion mode**
+ *
+ * An alias of {@link strictEqual}.
+ *
+ * **Legacy assertion mode**
+ *
+ * > Stability: 3 - Legacy: Use {@link strictEqual} instead.
+ *
+ * Tests shallow, coercive equality between the `actual` and `expected` parameters
+ * using the [Abstract Equality Comparison](https://tc39.github.io/ecma262/#sec-abstract-equality-comparison) ( `==` ). `NaN` is special handled
+ * and treated as being identical in case both sides are `NaN`.
+ *
+ * ```js
+ * import assert from 'assert';
+ *
+ * assert.equal(1, 1);
+ * // OK, 1 == 1
+ * assert.equal(1, '1');
+ * // OK, 1 == '1'
+ * assert.equal(NaN, NaN);
+ * // OK
+ *
+ * assert.equal(1, 2);
+ * // AssertionError: 1 == 2
+ * assert.equal({ a: { b: 1 } }, { a: { b: 1 } });
+ * // AssertionError: { a: { b: 1 } } == { a: { b: 1 } }
+ * ```
+ *
+ * If the values are not equal, an `AssertionError` is thrown with a `message`property set equal to the value of the `message` parameter. If the `message`parameter is undefined, a default
+ * error message is assigned. If the `message`parameter is an instance of an `Error` then it will be thrown instead of the`AssertionError`.
+ * @since v0.1.21
+ */
+ function equal(actual: unknown, expected: unknown, message?: string | Error): void;
+ /**
+ * **Strict assertion mode**
+ *
+ * An alias of {@link notStrictEqual}.
+ *
+ * **Legacy assertion mode**
+ *
+ * > Stability: 3 - Legacy: Use {@link notStrictEqual} instead.
+ *
+ * Tests shallow, coercive inequality with the [Abstract Equality Comparison](https://tc39.github.io/ecma262/#sec-abstract-equality-comparison)(`!=` ). `NaN` is special handled and treated as
+ * being identical in case both
+ * sides are `NaN`.
+ *
+ * ```js
+ * import assert from 'assert';
+ *
+ * assert.notEqual(1, 2);
+ * // OK
+ *
+ * assert.notEqual(1, 1);
+ * // AssertionError: 1 != 1
+ *
+ * assert.notEqual(1, '1');
+ * // AssertionError: 1 != '1'
+ * ```
+ *
+ * If the values are equal, an `AssertionError` is thrown with a `message`property set equal to the value of the `message` parameter. If the `message`parameter is undefined, a default error
+ * message is assigned. If the `message`parameter is an instance of an `Error` then it will be thrown instead of the`AssertionError`.
+ * @since v0.1.21
+ */
+ function notEqual(actual: unknown, expected: unknown, message?: string | Error): void;
+ /**
+ * **Strict assertion mode**
+ *
+ * An alias of {@link deepStrictEqual}.
+ *
+ * **Legacy assertion mode**
+ *
+ * > Stability: 3 - Legacy: Use {@link deepStrictEqual} instead.
+ *
+ * Tests for deep equality between the `actual` and `expected` parameters. Consider
+ * using {@link deepStrictEqual} instead. {@link deepEqual} can have
+ * surprising results.
+ *
+ * _Deep equality_ means that the enumerable "own" properties of child objects
+ * are also recursively evaluated by the following rules.
+ * @since v0.1.21
+ */
+ function deepEqual(actual: unknown, expected: unknown, message?: string | Error): void;
+ /**
+ * **Strict assertion mode**
+ *
+ * An alias of {@link notDeepStrictEqual}.
+ *
+ * **Legacy assertion mode**
+ *
+ * > Stability: 3 - Legacy: Use {@link notDeepStrictEqual} instead.
+ *
+ * Tests for any deep inequality. Opposite of {@link deepEqual}.
+ *
+ * ```js
+ * import assert from 'assert';
+ *
+ * const obj1 = {
+ * a: {
+ * b: 1
+ * }
+ * };
+ * const obj2 = {
+ * a: {
+ * b: 2
+ * }
+ * };
+ * const obj3 = {
+ * a: {
+ * b: 1
+ * }
+ * };
+ * const obj4 = Object.create(obj1);
+ *
+ * assert.notDeepEqual(obj1, obj1);
+ * // AssertionError: { a: { b: 1 } } notDeepEqual { a: { b: 1 } }
+ *
+ * assert.notDeepEqual(obj1, obj2);
+ * // OK
+ *
+ * assert.notDeepEqual(obj1, obj3);
+ * // AssertionError: { a: { b: 1 } } notDeepEqual { a: { b: 1 } }
+ *
+ * assert.notDeepEqual(obj1, obj4);
+ * // OK
+ * ```
+ *
+ * If the values are deeply equal, an `AssertionError` is thrown with a`message` property set equal to the value of the `message` parameter. If the`message` parameter is undefined, a default
+ * error message is assigned. If the`message` parameter is an instance of an `Error` then it will be thrown
+ * instead of the `AssertionError`.
+ * @since v0.1.21
+ */
+ function notDeepEqual(actual: unknown, expected: unknown, message?: string | Error): void;
+ /**
+ * Tests strict equality between the `actual` and `expected` parameters as
+ * determined by the [SameValue Comparison](https://tc39.github.io/ecma262/#sec-samevalue).
+ *
+ * ```js
+ * import assert from 'assert/strict';
+ *
+ * assert.strictEqual(1, 2);
+ * // AssertionError [ERR_ASSERTION]: Expected inputs to be strictly equal:
+ * //
+ * // 1 !== 2
+ *
+ * assert.strictEqual(1, 1);
+ * // OK
+ *
+ * assert.strictEqual('Hello foobar', 'Hello World!');
+ * // AssertionError [ERR_ASSERTION]: Expected inputs to be strictly equal:
+ * // + actual - expected
+ * //
+ * // + 'Hello foobar'
+ * // - 'Hello World!'
+ * // ^
+ *
+ * const apples = 1;
+ * const oranges = 2;
+ * assert.strictEqual(apples, oranges, `apples ${apples} !== oranges ${oranges}`);
+ * // AssertionError [ERR_ASSERTION]: apples 1 !== oranges 2
+ *
+ * assert.strictEqual(1, '1', new TypeError('Inputs are not identical'));
+ * // TypeError: Inputs are not identical
+ * ```
+ *
+ * If the values are not strictly equal, an `AssertionError` is thrown with a`message` property set equal to the value of the `message` parameter. If the`message` parameter is undefined, a
+ * default error message is assigned. If the`message` parameter is an instance of an `Error` then it will be thrown
+ * instead of the `AssertionError`.
+ * @since v0.1.21
+ */
+ function strictEqual(actual: unknown, expected: T, message?: string | Error): asserts actual is T;
+ /**
+ * Tests strict inequality between the `actual` and `expected` parameters as
+ * determined by the [SameValue Comparison](https://tc39.github.io/ecma262/#sec-samevalue).
+ *
+ * ```js
+ * import assert from 'assert/strict';
+ *
+ * assert.notStrictEqual(1, 2);
+ * // OK
+ *
+ * assert.notStrictEqual(1, 1);
+ * // AssertionError [ERR_ASSERTION]: Expected "actual" to be strictly unequal to:
+ * //
+ * // 1
+ *
+ * assert.notStrictEqual(1, '1');
+ * // OK
+ * ```
+ *
+ * If the values are strictly equal, an `AssertionError` is thrown with a`message` property set equal to the value of the `message` parameter. If the`message` parameter is undefined, a
+ * default error message is assigned. If the`message` parameter is an instance of an `Error` then it will be thrown
+ * instead of the `AssertionError`.
+ * @since v0.1.21
+ */
+ function notStrictEqual(actual: unknown, expected: unknown, message?: string | Error): void;
+ /**
+ * Tests for deep equality between the `actual` and `expected` parameters.
+ * "Deep" equality means that the enumerable "own" properties of child objects
+ * are recursively evaluated also by the following rules.
+ * @since v1.2.0
+ */
+ function deepStrictEqual(actual: unknown, expected: T, message?: string | Error): asserts actual is T;
+ /**
+ * Tests for deep strict inequality. Opposite of {@link deepStrictEqual}.
+ *
+ * ```js
+ * import assert from 'assert/strict';
+ *
+ * assert.notDeepStrictEqual({ a: 1 }, { a: '1' });
+ * // OK
+ * ```
+ *
+ * If the values are deeply and strictly equal, an `AssertionError` is thrown
+ * with a `message` property set equal to the value of the `message` parameter. If
+ * the `message` parameter is undefined, a default error message is assigned. If
+ * the `message` parameter is an instance of an `Error` then it will be thrown
+ * instead of the `AssertionError`.
+ * @since v1.2.0
+ */
+ function notDeepStrictEqual(actual: unknown, expected: unknown, message?: string | Error): void;
+ /**
+ * Expects the function `fn` to throw an error.
+ *
+ * If specified, `error` can be a [`Class`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes),
+ * [`RegExp`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions), a validation function,
+ * a validation object where each property will be tested for strict deep equality,
+ * or an instance of error where each property will be tested for strict deep
+ * equality including the non-enumerable `message` and `name` properties. When
+ * using an object, it is also possible to use a regular expression, when
+ * validating against a string property. See below for examples.
+ *
+ * If specified, `message` will be appended to the message provided by the`AssertionError` if the `fn` call fails to throw or in case the error validation
+ * fails.
+ *
+ * Custom validation object/error instance:
+ *
+ * ```js
+ * import assert from 'assert/strict';
+ *
+ * const err = new TypeError('Wrong value');
+ * err.code = 404;
+ * err.foo = 'bar';
+ * err.info = {
+ * nested: true,
+ * baz: 'text'
+ * };
+ * err.reg = /abc/i;
+ *
+ * assert.throws(
+ * () => {
+ * throw err;
+ * },
+ * {
+ * name: 'TypeError',
+ * message: 'Wrong value',
+ * info: {
+ * nested: true,
+ * baz: 'text'
+ * }
+ * // Only properties on the validation object will be tested for.
+ * // Using nested objects requires all properties to be present. Otherwise
+ * // the validation is going to fail.
+ * }
+ * );
+ *
+ * // Using regular expressions to validate error properties:
+ * throws(
+ * () => {
+ * throw err;
+ * },
+ * {
+ * // The `name` and `message` properties are strings and using regular
+ * // expressions on those will match against the string. If they fail, an
+ * // error is thrown.
+ * name: /^TypeError$/,
+ * message: /Wrong/,
+ * foo: 'bar',
+ * info: {
+ * nested: true,
+ * // It is not possible to use regular expressions for nested properties!
+ * baz: 'text'
+ * },
+ * // The `reg` property contains a regular expression and only if the
+ * // validation object contains an identical regular expression, it is going
+ * // to pass.
+ * reg: /abc/i
+ * }
+ * );
+ *
+ * // Fails due to the different `message` and `name` properties:
+ * throws(
+ * () => {
+ * const otherErr = new Error('Not found');
+ * // Copy all enumerable properties from `err` to `otherErr`.
+ * for (const [key, value] of Object.entries(err)) {
+ * otherErr[key] = value;
+ * }
+ * throw otherErr;
+ * },
+ * // The error's `message` and `name` properties will also be checked when using
+ * // an error as validation object.
+ * err
+ * );
+ * ```
+ *
+ * Validate instanceof using constructor:
+ *
+ * ```js
+ * import assert from 'assert/strict';
+ *
+ * assert.throws(
+ * () => {
+ * throw new Error('Wrong value');
+ * },
+ * Error
+ * );
+ * ```
+ *
+ * Validate error message using [`RegExp`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions):
+ *
+ * Using a regular expression runs `.toString` on the error object, and will
+ * therefore also include the error name.
+ *
+ * ```js
+ * import assert from 'assert/strict';
+ *
+ * assert.throws(
+ * () => {
+ * throw new Error('Wrong value');
+ * },
+ * /^Error: Wrong value$/
+ * );
+ * ```
+ *
+ * Custom error validation:
+ *
+ * The function must return `true` to indicate all internal validations passed.
+ * It will otherwise fail with an `AssertionError`.
+ *
+ * ```js
+ * import assert from 'assert/strict';
+ *
+ * assert.throws(
+ * () => {
+ * throw new Error('Wrong value');
+ * },
+ * (err) => {
+ * assert(err instanceof Error);
+ * assert(/value/.test(err));
+ * // Avoid returning anything from validation functions besides `true`.
+ * // Otherwise, it's not clear what part of the validation failed. Instead,
+ * // throw an error about the specific validation that failed (as done in this
+ * // example) and add as much helpful debugging information to that error as
+ * // possible.
+ * return true;
+ * },
+ * 'unexpected error'
+ * );
+ * ```
+ *
+ * `error` cannot be a string. If a string is provided as the second
+ * argument, then `error` is assumed to be omitted and the string will be used for`message` instead. This can lead to easy-to-miss mistakes. Using the same
+ * message as the thrown error message is going to result in an`ERR_AMBIGUOUS_ARGUMENT` error. Please read the example below carefully if using
+ * a string as the second argument gets considered:
+ *
+ * ```js
+ * import assert from 'assert/strict';
+ *
+ * function throwingFirst() {
+ * throw new Error('First');
+ * }
+ *
+ * function throwingSecond() {
+ * throw new Error('Second');
+ * }
+ *
+ * function notThrowing() {}
+ *
+ * // The second argument is a string and the input function threw an Error.
+ * // The first case will not throw as it does not match for the error message
+ * // thrown by the input function!
+ * assert.throws(throwingFirst, 'Second');
+ * // In the next example the message has no benefit over the message from the
+ * // error and since it is not clear if the user intended to actually match
+ * // against the error message, Node.js throws an `ERR_AMBIGUOUS_ARGUMENT` error.
+ * assert.throws(throwingSecond, 'Second');
+ * // TypeError [ERR_AMBIGUOUS_ARGUMENT]
+ *
+ * // The string is only used (as message) in case the function does not throw:
+ * assert.throws(notThrowing, 'Second');
+ * // AssertionError [ERR_ASSERTION]: Missing expected exception: Second
+ *
+ * // If it was intended to match for the error message do this instead:
+ * // It does not throw because the error messages match.
+ * assert.throws(throwingSecond, /Second$/);
+ *
+ * // If the error message does not match, an AssertionError is thrown.
+ * assert.throws(throwingFirst, /Second$/);
+ * // AssertionError [ERR_ASSERTION]
+ * ```
+ *
+ * Due to the confusing error-prone notation, avoid a string as the second
+ * argument.
+ * @since v0.1.21
+ */
+ function throws(block: () => unknown, message?: string | Error): void;
+ function throws(block: () => unknown, error: AssertPredicate, message?: string | Error): void;
+ /**
+ * Asserts that the function `fn` does not throw an error.
+ *
+ * Using `assert.doesNotThrow()` is actually not useful because there
+ * is no benefit in catching an error and then rethrowing it. Instead, consider
+ * adding a comment next to the specific code path that should not throw and keep
+ * error messages as expressive as possible.
+ *
+ * When `assert.doesNotThrow()` is called, it will immediately call the `fn`function.
+ *
+ * If an error is thrown and it is the same type as that specified by the `error`parameter, then an `AssertionError` is thrown. If the error is of a
+ * different type, or if the `error` parameter is undefined, the error is
+ * propagated back to the caller.
+ *
+ * If specified, `error` can be a [`Class`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes),
+ * [`RegExp`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions) or a validation
+ * function. See {@link throws} for more details.
+ *
+ * The following, for instance, will throw the `TypeError` because there is no
+ * matching error type in the assertion:
+ *
+ * ```js
+ * import assert from 'assert/strict';
+ *
+ * assert.doesNotThrow(
+ * () => {
+ * throw new TypeError('Wrong value');
+ * },
+ * SyntaxError
+ * );
+ * ```
+ *
+ * However, the following will result in an `AssertionError` with the message
+ * 'Got unwanted exception...':
+ *
+ * ```js
+ * import assert from 'assert/strict';
+ *
+ * assert.doesNotThrow(
+ * () => {
+ * throw new TypeError('Wrong value');
+ * },
+ * TypeError
+ * );
+ * ```
+ *
+ * If an `AssertionError` is thrown and a value is provided for the `message`parameter, the value of `message` will be appended to the `AssertionError` message:
+ *
+ * ```js
+ * import assert from 'assert/strict';
+ *
+ * assert.doesNotThrow(
+ * () => {
+ * throw new TypeError('Wrong value');
+ * },
+ * /Wrong value/,
+ * 'Whoops'
+ * );
+ * // Throws: AssertionError: Got unwanted exception: Whoops
+ * ```
+ * @since v0.1.21
+ */
+ function doesNotThrow(block: () => unknown, message?: string | Error): void;
+ function doesNotThrow(block: () => unknown, error: AssertPredicate, message?: string | Error): void;
+ /**
+ * Throws `value` if `value` is not `undefined` or `null`. This is useful when
+ * testing the `error` argument in callbacks. The stack trace contains all frames
+ * from the error passed to `ifError()` including the potential new frames for`ifError()` itself.
+ *
+ * ```js
+ * import assert from 'assert/strict';
+ *
+ * assert.ifError(null);
+ * // OK
+ * assert.ifError(0);
+ * // AssertionError [ERR_ASSERTION]: ifError got unwanted exception: 0
+ * assert.ifError('error');
+ * // AssertionError [ERR_ASSERTION]: ifError got unwanted exception: 'error'
+ * assert.ifError(new Error());
+ * // AssertionError [ERR_ASSERTION]: ifError got unwanted exception: Error
+ *
+ * // Create some random error frames.
+ * let err;
+ * (function errorFrame() {
+ * err = new Error('test error');
+ * })();
+ *
+ * (function ifErrorFrame() {
+ * assert.ifError(err);
+ * })();
+ * // AssertionError [ERR_ASSERTION]: ifError got unwanted exception: test error
+ * // at ifErrorFrame
+ * // at errorFrame
+ * ```
+ * @since v0.1.97
+ */
+ function ifError(value: unknown): asserts value is null | undefined;
+ /**
+ * Awaits the `asyncFn` promise or, if `asyncFn` is a function, immediately
+ * calls the function and awaits the returned promise to complete. It will then
+ * check that the promise is rejected.
+ *
+ * If `asyncFn` is a function and it throws an error synchronously,`assert.rejects()` will return a rejected `Promise` with that error. If the
+ * function does not return a promise, `assert.rejects()` will return a rejected`Promise` with an `ERR_INVALID_RETURN_VALUE` error. In both cases the error
+ * handler is skipped.
+ *
+ * Besides the async nature to await the completion behaves identically to {@link throws}.
+ *
+ * If specified, `error` can be a [`Class`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes),
+ * [`RegExp`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions), a validation function,
+ * an object where each property will be tested for, or an instance of error where
+ * each property will be tested for including the non-enumerable `message` and`name` properties.
+ *
+ * If specified, `message` will be the message provided by the `AssertionError` if the `asyncFn` fails to reject.
+ *
+ * ```js
+ * import assert from 'assert/strict';
+ *
+ * await assert.rejects(
+ * async () => {
+ * throw new TypeError('Wrong value');
+ * },
+ * {
+ * name: 'TypeError',
+ * message: 'Wrong value'
+ * }
+ * );
+ * ```
+ *
+ * ```js
+ * import assert from 'assert/strict';
+ *
+ * await assert.rejects(
+ * async () => {
+ * throw new TypeError('Wrong value');
+ * },
+ * (err) => {
+ * assert.strictEqual(err.name, 'TypeError');
+ * assert.strictEqual(err.message, 'Wrong value');
+ * return true;
+ * }
+ * );
+ * ```
+ *
+ * ```js
+ * import assert from 'assert/strict';
+ *
+ * assert.rejects(
+ * Promise.reject(new Error('Wrong value')),
+ * Error
+ * ).then(() => {
+ * // ...
+ * });
+ * ```
+ *
+ * `error` cannot be a string. If a string is provided as the second
+ * argument, then `error` is assumed to be omitted and the string will be used for`message` instead. This can lead to easy-to-miss mistakes. Please read the
+ * example in {@link throws} carefully if using a string as the second
+ * argument gets considered.
+ * @since v10.0.0
+ */
+ function rejects(block: (() => Promise) | Promise, message?: string | Error): Promise;
+ function rejects(block: (() => Promise) | Promise, error: AssertPredicate, message?: string | Error): Promise;
+ /**
+ * Awaits the `asyncFn` promise or, if `asyncFn` is a function, immediately
+ * calls the function and awaits the returned promise to complete. It will then
+ * check that the promise is not rejected.
+ *
+ * If `asyncFn` is a function and it throws an error synchronously,`assert.doesNotReject()` will return a rejected `Promise` with that error. If
+ * the function does not return a promise, `assert.doesNotReject()` will return a
+ * rejected `Promise` with an `ERR_INVALID_RETURN_VALUE` error. In both cases
+ * the error handler is skipped.
+ *
+ * Using `assert.doesNotReject()` is actually not useful because there is little
+ * benefit in catching a rejection and then rejecting it again. Instead, consider
+ * adding a comment next to the specific code path that should not reject and keep
+ * error messages as expressive as possible.
+ *
+ * If specified, `error` can be a [`Class`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes),
+ * [`RegExp`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions) or a validation
+ * function. See {@link throws} for more details.
+ *
+ * Besides the async nature to await the completion behaves identically to {@link doesNotThrow}.
+ *
+ * ```js
+ * import assert from 'assert/strict';
+ *
+ * await assert.doesNotReject(
+ * async () => {
+ * throw new TypeError('Wrong value');
+ * },
+ * SyntaxError
+ * );
+ * ```
+ *
+ * ```js
+ * import assert from 'assert/strict';
+ *
+ * assert.doesNotReject(Promise.reject(new TypeError('Wrong value')))
+ * .then(() => {
+ * // ...
+ * });
+ * ```
+ * @since v10.0.0
+ */
+ function doesNotReject(block: (() => Promise) | Promise, message?: string | Error): Promise;
+ function doesNotReject(block: (() => Promise) | Promise, error: AssertPredicate, message?: string | Error): Promise;
+ /**
+ * Expects the `string` input to match the regular expression.
+ *
+ * ```js
+ * import assert from 'assert/strict';
+ *
+ * assert.match('I will fail', /pass/);
+ * // AssertionError [ERR_ASSERTION]: The input did not match the regular ...
+ *
+ * assert.match(123, /pass/);
+ * // AssertionError [ERR_ASSERTION]: The "string" argument must be of type string.
+ *
+ * assert.match('I will pass', /pass/);
+ * // OK
+ * ```
+ *
+ * If the values do not match, or if the `string` argument is of another type than`string`, an `AssertionError` is thrown with a `message` property set equal
+ * to the value of the `message` parameter. If the `message` parameter is
+ * undefined, a default error message is assigned. If the `message` parameter is an
+ * instance of an `Error` then it will be thrown instead of the `AssertionError`.
+ * @since v13.6.0, v12.16.0
+ */
function match(value: string, regExp: RegExp, message?: string | Error): void;
+ /**
+ * Expects the `string` input not to match the regular expression.
+ *
+ * ```js
+ * import assert from 'assert/strict';
+ *
+ * assert.doesNotMatch('I will fail', /fail/);
+ * // AssertionError [ERR_ASSERTION]: The input was expected to not match the ...
+ *
+ * assert.doesNotMatch(123, /pass/);
+ * // AssertionError [ERR_ASSERTION]: The "string" argument must be of type string.
+ *
+ * assert.doesNotMatch('I will pass', /different/);
+ * // OK
+ * ```
+ *
+ * If the values do match, or if the `string` argument is of another type than`string`, an `AssertionError` is thrown with a `message` property set equal
+ * to the value of the `message` parameter. If the `message` parameter is
+ * undefined, a default error message is assigned. If the `message` parameter is an
+ * instance of an `Error` then it will be thrown instead of the `AssertionError`.
+ * @since v13.6.0, v12.16.0
+ */
function doesNotMatch(value: string, regExp: RegExp, message?: string | Error): void;
-
- const strict: Omit<
- typeof assert,
- | 'equal'
- | 'notEqual'
- | 'deepEqual'
- | 'notDeepEqual'
- | 'ok'
- | 'strictEqual'
- | 'deepStrictEqual'
- | 'ifError'
- | 'strict'
- > & {
- (value: any, message?: string | Error): asserts value;
+ const strict: Omit & {
+ (value: unknown, message?: string | Error): asserts value;
equal: typeof strictEqual;
notEqual: typeof notStrictEqual;
deepEqual: typeof deepStrictEqual;
notDeepEqual: typeof notDeepStrictEqual;
-
// Mapped types and assertion functions are incompatible?
// TS2775: Assertions require every name in the call target
// to be declared with an explicit type annotation.
@@ -122,7 +957,6 @@ declare module 'assert' {
strict: typeof strict;
};
}
-
export = assert;
}
declare module 'node:assert' {
diff --git a/packages/node_modules/@node-red/editor-client/src/types/node/assert/strict.d.ts b/packages/node_modules/@node-red/editor-client/src/types/node/assert/strict.d.ts
new file mode 100644
index 000000000..ada209ced
--- /dev/null
+++ b/packages/node_modules/@node-red/editor-client/src/types/node/assert/strict.d.ts
@@ -0,0 +1,11 @@
+
+/* NOTE: Do not edit directly! This file is generated using `npm run update-types` in https://github.com/Steve-Mcl/monaco-editor-esm-i18n */
+
+declare module 'assert/strict' {
+ import { strict } from 'node:assert';
+ export = strict;
+}
+declare module 'node:assert/strict' {
+ import { strict } from 'node:assert';
+ export = strict;
+}
diff --git a/packages/node_modules/@node-red/editor-client/src/types/node/async_hooks.d.ts b/packages/node_modules/@node-red/editor-client/src/types/node/async_hooks.d.ts
index c576ec7c7..206104c55 100644
--- a/packages/node_modules/@node-red/editor-client/src/types/node/async_hooks.d.ts
+++ b/packages/node_modules/@node-red/editor-client/src/types/node/async_hooks.d.ts
@@ -2,18 +2,49 @@
/* NOTE: Do not edit directly! This file is generated using `npm run update-types` in https://github.com/Steve-Mcl/monaco-editor-esm-i18n */
/**
- * Async Hooks module: https://nodejs.org/api/async_hooks.html
+ * The `async_hooks` module provides an API to track asynchronous resources. It
+ * can be accessed using:
+ *
+ * ```js
+ * import async_hooks from 'async_hooks';
+ * ```
+ * @experimental
+ * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/async_hooks.js)
*/
declare module 'async_hooks' {
/**
- * Returns the asyncId of the current execution context.
+ * ```js
+ * import { executionAsyncId } from 'async_hooks';
+ *
+ * console.log(executionAsyncId()); // 1 - bootstrap
+ * fs.open(path, 'r', (err, fd) => {
+ * console.log(executionAsyncId()); // 6 - open()
+ * });
+ * ```
+ *
+ * The ID returned from `executionAsyncId()` is related to execution timing, not
+ * causality (which is covered by `triggerAsyncId()`):
+ *
+ * ```js
+ * const server = net.createServer((conn) => {
+ * // Returns the ID of the server, not of the new connection, because the
+ * // callback runs in the execution scope of the server's MakeCallback().
+ * async_hooks.executionAsyncId();
+ *
+ * }).listen(port, () => {
+ * // Returns the ID of a TickObject (process.nextTick()) because all
+ * // callbacks passed to .listen() are wrapped in a nextTick().
+ * async_hooks.executionAsyncId();
+ * });
+ * ```
+ *
+ * Promise contexts may not get precise `executionAsyncIds` by default.
+ * See the section on `promise execution tracking`.
+ * @since v8.1.0
+ * @return The `asyncId` of the current execution context. Useful to track when something calls.
*/
function executionAsyncId(): number;
-
/**
- * The resource representing the current execution.
- * Useful to store data within the resource.
- *
* Resource objects returned by `executionAsyncResource()` are most often internal
* Node.js handle objects with undocumented APIs. Using any functions or properties
* on the object is likely to crash your application and should be avoided.
@@ -21,14 +52,70 @@ declare module 'async_hooks' {
* Using `executionAsyncResource()` in the top-level execution context will
* return an empty object as there is no handle or request object to use,
* but having an object representing the top-level can be helpful.
+ *
+ * ```js
+ * import { open } from 'fs';
+ * import { executionAsyncId, executionAsyncResource } from 'async_hooks';
+ *
+ * console.log(executionAsyncId(), executionAsyncResource()); // 1 {}
+ * open(new URL(import.meta.url), 'r', (err, fd) => {
+ * console.log(executionAsyncId(), executionAsyncResource()); // 7 FSReqWrap
+ * });
+ * ```
+ *
+ * This can be used to implement continuation local storage without the
+ * use of a tracking `Map` to store the metadata:
+ *
+ * ```js
+ * import { createServer } from 'http';
+ * import {
+ * executionAsyncId,
+ * executionAsyncResource,
+ * createHook
+ * } from 'async_hooks';
+ * const sym = Symbol('state'); // Private symbol to avoid pollution
+ *
+ * createHook({
+ * init(asyncId, type, triggerAsyncId, resource) {
+ * const cr = executionAsyncResource();
+ * if (cr) {
+ * resource[sym] = cr[sym];
+ * }
+ * }
+ * }).enable();
+ *
+ * const server = createServer((req, res) => {
+ * executionAsyncResource()[sym] = { state: req.url };
+ * setTimeout(function() {
+ * res.end(JSON.stringify(executionAsyncResource()[sym]));
+ * }, 100);
+ * }).listen(3000);
+ * ```
+ * @since v13.9.0, v12.17.0
+ * @return The resource representing the current execution. Useful to store data within the resource.
*/
function executionAsyncResource(): object;
-
/**
- * Returns the ID of the resource responsible for calling the callback that is currently being executed.
+ * ```js
+ * const server = net.createServer((conn) => {
+ * // The resource that caused (or triggered) this callback to be called
+ * // was that of the new connection. Thus the return value of triggerAsyncId()
+ * // is the asyncId of "conn".
+ * async_hooks.triggerAsyncId();
+ *
+ * }).listen(port, () => {
+ * // Even though all callbacks passed to .listen() are wrapped in a nextTick()
+ * // the callback itself exists because the call to the server's .listen()
+ * // was made. So the return value would be the ID of the server.
+ * async_hooks.triggerAsyncId();
+ * });
+ * ```
+ *
+ * Promise contexts may not get valid `triggerAsyncId`s by default. See
+ * the section on `promise execution tracking`.
+ * @return The ID of the resource responsible for calling the callback that is currently being executed.
*/
function triggerAsyncId(): number;
-
interface HookCallbacks {
/**
* Called when a class is constructed that has the possibility to emit an asynchronous event.
@@ -38,73 +125,133 @@ declare module 'async_hooks' {
* @param resource reference to the resource representing the async operation, needs to be released during destroy
*/
init?(asyncId: number, type: string, triggerAsyncId: number, resource: object): void;
-
/**
* When an asynchronous operation is initiated or completes a callback is called to notify the user.
* The before callback is called just before said callback is executed.
* @param asyncId the unique identifier assigned to the resource about to execute the callback.
*/
before?(asyncId: number): void;
-
/**
* Called immediately after the callback specified in before is completed.
* @param asyncId the unique identifier assigned to the resource which has executed the callback.
*/
after?(asyncId: number): void;
-
/**
* Called when a promise has resolve() called. This may not be in the same execution id
* as the promise itself.
* @param asyncId the unique id for the promise that was resolve()d.
*/
promiseResolve?(asyncId: number): void;
-
/**
* Called after the resource corresponding to asyncId is destroyed
* @param asyncId a unique ID for the async resource
*/
destroy?(asyncId: number): void;
}
-
interface AsyncHook {
/**
* Enable the callbacks for a given AsyncHook instance. If no callbacks are provided enabling is a noop.
*/
enable(): this;
-
/**
* Disable the callbacks for a given AsyncHook instance from the global pool of AsyncHook callbacks to be executed. Once a hook has been disabled it will not be called again until enabled.
*/
disable(): this;
}
-
/**
- * Registers functions to be called for different lifetime events of each async operation.
- * @param options the callbacks to register
- * @return an AsyncHooks instance used for disabling and enabling hooks
+ * Registers functions to be called for different lifetime events of each async
+ * operation.
+ *
+ * The callbacks `init()`/`before()`/`after()`/`destroy()` are called for the
+ * respective asynchronous event during a resource's lifetime.
+ *
+ * All callbacks are optional. For example, if only resource cleanup needs to
+ * be tracked, then only the `destroy` callback needs to be passed. The
+ * specifics of all functions that can be passed to `callbacks` is in the `Hook Callbacks` section.
+ *
+ * ```js
+ * import { createHook } from 'async_hooks';
+ *
+ * const asyncHook = createHook({
+ * init(asyncId, type, triggerAsyncId, resource) { },
+ * destroy(asyncId) { }
+ * });
+ * ```
+ *
+ * The callbacks will be inherited via the prototype chain:
+ *
+ * ```js
+ * class MyAsyncCallbacks {
+ * init(asyncId, type, triggerAsyncId, resource) { }
+ * destroy(asyncId) {}
+ * }
+ *
+ * class MyAddedCallbacks extends MyAsyncCallbacks {
+ * before(asyncId) { }
+ * after(asyncId) { }
+ * }
+ *
+ * const asyncHook = async_hooks.createHook(new MyAddedCallbacks());
+ * ```
+ *
+ * Because promises are asynchronous resources whose lifecycle is tracked
+ * via the async hooks mechanism, the `init()`, `before()`, `after()`, and`destroy()` callbacks _must not_ be async functions that return promises.
+ * @since v8.1.0
+ * @param callbacks The `Hook Callbacks` to register
+ * @return Instance used for disabling and enabling hooks
*/
- function createHook(options: HookCallbacks): AsyncHook;
-
+ function createHook(callbacks: HookCallbacks): AsyncHook;
interface AsyncResourceOptions {
- /**
- * The ID of the execution context that created this async event.
- * @default executionAsyncId()
- */
- triggerAsyncId?: number | undefined;
-
- /**
- * Disables automatic `emitDestroy` when the object is garbage collected.
- * This usually does not need to be set (even if `emitDestroy` is called
- * manually), unless the resource's `asyncId` is retrieved and the
- * sensitive API's `emitDestroy` is called with it.
- * @default false
- */
- requireManualDestroy?: boolean | undefined;
+ /**
+ * The ID of the execution context that created this async event.
+ * @default executionAsyncId()
+ */
+ triggerAsyncId?: number | undefined;
+ /**
+ * Disables automatic `emitDestroy` when the object is garbage collected.
+ * This usually does not need to be set (even if `emitDestroy` is called
+ * manually), unless the resource's `asyncId` is retrieved and the
+ * sensitive API's `emitDestroy` is called with it.
+ * @default false
+ */
+ requireManualDestroy?: boolean | undefined;
}
-
/**
- * The class AsyncResource was designed to be extended by the embedder's async resources.
- * Using this users can easily trigger the lifetime events of their own resources.
+ * The class `AsyncResource` is designed to be extended by the embedder's async
+ * resources. Using this, users can easily trigger the lifetime events of their
+ * own resources.
+ *
+ * The `init` hook will trigger when an `AsyncResource` is instantiated.
+ *
+ * The following is an overview of the `AsyncResource` API.
+ *
+ * ```js
+ * import { AsyncResource, executionAsyncId } from 'async_hooks';
+ *
+ * // AsyncResource() is meant to be extended. Instantiating a
+ * // new AsyncResource() also triggers init. If triggerAsyncId is omitted then
+ * // async_hook.executionAsyncId() is used.
+ * const asyncResource = new AsyncResource(
+ * type, { triggerAsyncId: executionAsyncId(), requireManualDestroy: false }
+ * );
+ *
+ * // Run a function in the execution context of the resource. This will
+ * // * establish the context of the resource
+ * // * trigger the AsyncHooks before callbacks
+ * // * call the provided function `fn` with the supplied arguments
+ * // * trigger the AsyncHooks after callbacks
+ * // * restore the original execution context
+ * asyncResource.runInAsyncScope(fn, thisArg, ...args);
+ *
+ * // Call AsyncHooks destroy callbacks.
+ * asyncResource.emitDestroy();
+ *
+ * // Return the unique ID assigned to the AsyncResource instance.
+ * asyncResource.asyncId();
+ *
+ * // Return the trigger ID for the AsyncResource instance.
+ * asyncResource.triggerAsyncId();
+ * ```
*/
class AsyncResource {
/**
@@ -114,115 +261,236 @@ declare module 'async_hooks' {
* @param type The type of async event.
* @param triggerAsyncId The ID of the execution context that created
* this async event (default: `executionAsyncId()`), or an
- * AsyncResourceOptions object (since 9.3)
+ * AsyncResourceOptions object (since v9.3.0)
*/
- constructor(type: string, triggerAsyncId?: number|AsyncResourceOptions);
-
+ constructor(type: string, triggerAsyncId?: number | AsyncResourceOptions);
/**
* Binds the given function to the current execution context.
+ *
+ * The returned function will have an `asyncResource` property referencing
+ * the `AsyncResource` to which the function is bound.
+ * @since v14.8.0, v12.19.0
* @param fn The function to bind to the current execution context.
* @param type An optional name to associate with the underlying `AsyncResource`.
*/
- static bind any>(fn: Func, type?: string): Func & { asyncResource: AsyncResource };
-
+ static bind any, ThisArg>(
+ fn: Func,
+ type?: string,
+ thisArg?: ThisArg
+ ): Func & {
+ asyncResource: AsyncResource;
+ };
/**
* Binds the given function to execute to this `AsyncResource`'s scope.
+ *
+ * The returned function will have an `asyncResource` property referencing
+ * the `AsyncResource` to which the function is bound.
+ * @since v14.8.0, v12.19.0
* @param fn The function to bind to the current `AsyncResource`.
*/
- bind any>(fn: Func): Func & { asyncResource: AsyncResource };
-
+ bind any>(
+ fn: Func
+ ): Func & {
+ asyncResource: AsyncResource;
+ };
/**
- * Call the provided function with the provided arguments in the
- * execution context of the async resource. This will establish the
- * context, trigger the AsyncHooks before callbacks, call the function,
- * trigger the AsyncHooks after callbacks, and then restore the original
- * execution context.
- * @param fn The function to call in the execution context of this
- * async resource.
+ * Call the provided function with the provided arguments in the execution context
+ * of the async resource. This will establish the context, trigger the AsyncHooks
+ * before callbacks, call the function, trigger the AsyncHooks after callbacks, and
+ * then restore the original execution context.
+ * @since v9.6.0
+ * @param fn The function to call in the execution context of this async resource.
* @param thisArg The receiver to be used for the function call.
* @param args Optional arguments to pass to the function.
*/
runInAsyncScope(fn: (this: This, ...args: any[]) => Result, thisArg?: This, ...args: any[]): Result;
-
/**
- * Call AsyncHooks destroy callbacks.
+ * Call all `destroy` hooks. This should only ever be called once. An error will
+ * be thrown if it is called more than once. This **must** be manually called. If
+ * the resource is left to be collected by the GC then the `destroy` hooks will
+ * never be called.
+ * @return A reference to `asyncResource`.
*/
emitDestroy(): this;
-
/**
- * @return the unique ID assigned to this AsyncResource instance.
+ * @return The unique `asyncId` assigned to the resource.
*/
asyncId(): number;
-
/**
- * @return the trigger ID for this AsyncResource instance.
+ *
+ * @return The same `triggerAsyncId` that is passed to the `AsyncResource` constructor.
*/
triggerAsyncId(): number;
}
-
/**
- * When having multiple instances of `AsyncLocalStorage`, they are independent
- * from each other. It is safe to instantiate this class multiple times.
+ * This class creates stores that stay coherent through asynchronous operations.
+ *
+ * While you can create your own implementation on top of the `async_hooks` module,`AsyncLocalStorage` should be preferred as it is a performant and memory safe
+ * implementation that involves significant optimizations that are non-obvious to
+ * implement.
+ *
+ * The following example uses `AsyncLocalStorage` to build a simple logger
+ * that assigns IDs to incoming HTTP requests and includes them in messages
+ * logged within each request.
+ *
+ * ```js
+ * import http from 'http';
+ * import { AsyncLocalStorage } from 'async_hooks';
+ *
+ * const asyncLocalStorage = new AsyncLocalStorage();
+ *
+ * function logWithId(msg) {
+ * const id = asyncLocalStorage.getStore();
+ * console.log(`${id !== undefined ? id : '-'}:`, msg);
+ * }
+ *
+ * let idSeq = 0;
+ * http.createServer((req, res) => {
+ * asyncLocalStorage.run(idSeq++, () => {
+ * logWithId('start');
+ * // Imagine any chain of async operations here
+ * setImmediate(() => {
+ * logWithId('finish');
+ * res.end();
+ * });
+ * });
+ * }).listen(8080);
+ *
+ * http.get('http://localhost:8080');
+ * http.get('http://localhost:8080');
+ * // Prints:
+ * // 0: start
+ * // 1: start
+ * // 0: finish
+ * // 1: finish
+ * ```
+ *
+ * Each instance of `AsyncLocalStorage` maintains an independent storage context.
+ * Multiple instances can safely exist simultaneously without risk of interfering
+ * with each other data.
+ * @since v13.10.0, v12.17.0
*/
class AsyncLocalStorage {
/**
- * This method disables the instance of `AsyncLocalStorage`. All subsequent calls
- * to `asyncLocalStorage.getStore()` will return `undefined` until
- * `asyncLocalStorage.run()` is called again.
+ * Disables the instance of `AsyncLocalStorage`. All subsequent calls
+ * to `asyncLocalStorage.getStore()` will return `undefined` until`asyncLocalStorage.run()` or `asyncLocalStorage.enterWith()` is called again.
*
* When calling `asyncLocalStorage.disable()`, all current contexts linked to the
* instance will be exited.
*
- * Calling `asyncLocalStorage.disable()` is required before the
- * `asyncLocalStorage` can be garbage collected. This does not apply to stores
+ * Calling `asyncLocalStorage.disable()` is required before the`asyncLocalStorage` can be garbage collected. This does not apply to stores
* provided by the `asyncLocalStorage`, as those objects are garbage collected
* along with the corresponding async resources.
*
- * This method is to be used when the `asyncLocalStorage` is not in use anymore
+ * Use this method when the `asyncLocalStorage` is not in use anymore
* in the current process.
+ * @since v13.10.0, v12.17.0
+ * @experimental
*/
disable(): void;
-
/**
- * This method returns the current store. If this method is called outside of an
- * asynchronous context initialized by calling `asyncLocalStorage.run`, it will
- * return `undefined`.
+ * Returns the current store.
+ * If called outside of an asynchronous context initialized by
+ * calling `asyncLocalStorage.run()` or `asyncLocalStorage.enterWith()`, it
+ * returns `undefined`.
+ * @since v13.10.0, v12.17.0
*/
getStore(): T | undefined;
-
/**
- * This methods runs a function synchronously within a context and return its
+ * Runs a function synchronously within a context and returns its
* return value. The store is not accessible outside of the callback function or
* the asynchronous operations created within the callback.
*
- * Optionally, arguments can be passed to the function. They will be passed to the
- * callback function.
+ * The optional `args` are passed to the callback function.
*
- * I the callback function throws an error, it will be thrown by `run` too. The
- * stacktrace will not be impacted by this call and the context will be exited.
+ * If the callback function throws an error, the error is thrown by `run()` too.
+ * The stacktrace is not impacted by this call and the context is exited.
+ *
+ * Example:
+ *
+ * ```js
+ * const store = { id: 2 };
+ * try {
+ * asyncLocalStorage.run(store, () => {
+ * asyncLocalStorage.getStore(); // Returns the store object
+ * throw new Error();
+ * });
+ * } catch (e) {
+ * asyncLocalStorage.getStore(); // Returns undefined
+ * // The error will be caught here
+ * }
+ * ```
+ * @since v13.10.0, v12.17.0
*/
- // TODO: Apply generic vararg once available
- run(store: T, callback: (...args: any[]) => R, ...args: any[]): R;
-
+ run(store: T, callback: (...args: TArgs) => R, ...args: TArgs): R;
/**
- * This methods runs a function synchronously outside of a context and return its
- * return value. The store is not accessible within the callback function or the
- * asynchronous operations created within the callback.
+ * Runs a function synchronously outside of a context and returns its
+ * return value. The store is not accessible within the callback function or
+ * the asynchronous operations created within the callback. Any `getStore()`call done within the callback function will always return `undefined`.
*
- * Optionally, arguments can be passed to the function. They will be passed to the
- * callback function.
+ * The optional `args` are passed to the callback function.
*
- * If the callback function throws an error, it will be thrown by `exit` too. The
- * stacktrace will not be impacted by this call and the context will be
- * re-entered.
+ * If the callback function throws an error, the error is thrown by `exit()` too.
+ * The stacktrace is not impacted by this call and the context is re-entered.
+ *
+ * Example:
+ *
+ * ```js
+ * // Within a call to run
+ * try {
+ * asyncLocalStorage.getStore(); // Returns the store object or value
+ * asyncLocalStorage.exit(() => {
+ * asyncLocalStorage.getStore(); // Returns undefined
+ * throw new Error();
+ * });
+ * } catch (e) {
+ * asyncLocalStorage.getStore(); // Returns the same object or value
+ * // The error will be caught here
+ * }
+ * ```
+ * @since v13.10.0, v12.17.0
+ * @experimental
*/
- // TODO: Apply generic vararg once available
- exit(callback: (...args: any[]) => R, ...args: any[]): R;
-
+ exit(callback: (...args: TArgs) => R, ...args: TArgs): R;
/**
- * Calling `asyncLocalStorage.enterWith(store)` will transition into the context
- * for the remainder of the current synchronous execution and will persist
- * through any following asynchronous calls.
+ * Transitions into the context for the remainder of the current
+ * synchronous execution and then persists the store through any following
+ * asynchronous calls.
+ *
+ * Example:
+ *
+ * ```js
+ * const store = { id: 1 };
+ * // Replaces previous store with the given store object
+ * asyncLocalStorage.enterWith(store);
+ * asyncLocalStorage.getStore(); // Returns the store object
+ * someAsyncOperation(() => {
+ * asyncLocalStorage.getStore(); // Returns the same object
+ * });
+ * ```
+ *
+ * This transition will continue for the _entire_ synchronous execution.
+ * This means that if, for example, the context is entered within an event
+ * handler subsequent event handlers will also run within that context unless
+ * specifically bound to another context with an `AsyncResource`. That is why`run()` should be preferred over `enterWith()` unless there are strong reasons
+ * to use the latter method.
+ *
+ * ```js
+ * const store = { id: 1 };
+ *
+ * emitter.on('my-event', () => {
+ * asyncLocalStorage.enterWith(store);
+ * });
+ * emitter.on('my-event', () => {
+ * asyncLocalStorage.getStore(); // Returns the same object
+ * });
+ *
+ * asyncLocalStorage.getStore(); // Returns undefined
+ * emitter.emit('my-event');
+ * asyncLocalStorage.getStore(); // Returns the same object
+ * ```
+ * @since v13.11.0, v12.17.0
+ * @experimental
*/
enterWith(store: T): void;
}
diff --git a/packages/node_modules/@node-red/editor-client/src/types/node/buffer.d.ts b/packages/node_modules/@node-red/editor-client/src/types/node/buffer.d.ts
index 24a77e1e4..e04af96e7 100644
--- a/packages/node_modules/@node-red/editor-client/src/types/node/buffer.d.ts
+++ b/packages/node_modules/@node-red/editor-client/src/types/node/buffer.d.ts
@@ -1,8 +1,54 @@
/* NOTE: Do not edit directly! This file is generated using `npm run update-types` in https://github.com/Steve-Mcl/monaco-editor-esm-i18n */
+/**
+ * `Buffer` objects are used to represent a fixed-length sequence of bytes. Many
+ * Node.js APIs support `Buffer`s.
+ *
+ * The `Buffer` class is a subclass of JavaScript's [`Uint8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) class and
+ * extends it with methods that cover additional use cases. Node.js APIs accept
+ * plain [`Uint8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) s wherever `Buffer`s are supported as well.
+ *
+ * While the `Buffer` class is available within the global scope, it is still
+ * recommended to explicitly reference it via an import or require statement.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * // Creates a zero-filled Buffer of length 10.
+ * const buf1 = Buffer.alloc(10);
+ *
+ * // Creates a Buffer of length 10,
+ * // filled with bytes which all have the value `1`.
+ * const buf2 = Buffer.alloc(10, 1);
+ *
+ * // Creates an uninitialized buffer of length 10.
+ * // This is faster than calling Buffer.alloc() but the returned
+ * // Buffer instance might contain old data that needs to be
+ * // overwritten using fill(), write(), or other functions that fill the Buffer's
+ * // contents.
+ * const buf3 = Buffer.allocUnsafe(10);
+ *
+ * // Creates a Buffer containing the bytes [1, 2, 3].
+ * const buf4 = Buffer.from([1, 2, 3]);
+ *
+ * // Creates a Buffer containing the bytes [1, 1, 1, 1] – the entries
+ * // are all truncated using `(value & 255)` to fit into the range 0–255.
+ * const buf5 = Buffer.from([257, 257.5, -255, '1']);
+ *
+ * // Creates a Buffer containing the UTF-8-encoded bytes for the string 'tést':
+ * // [0x74, 0xc3, 0xa9, 0x73, 0x74] (in hexadecimal notation)
+ * // [116, 195, 169, 115, 116] (in decimal notation)
+ * const buf6 = Buffer.from('tést');
+ *
+ * // Creates a Buffer containing the Latin-1 bytes [0x74, 0xe9, 0x73, 0x74].
+ * const buf7 = Buffer.from('tést', 'latin1');
+ * ```
+ * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/buffer.js)
+ */
declare module 'buffer' {
import { BinaryLike } from 'node:crypto';
+ import { ReadableStream as WebReadableStream } from 'node:stream/web';
export const INSPECT_MAX_BYTES: number;
export const kMaxLength: number;
export const kStringMaxLength: number;
@@ -10,17 +56,49 @@ declare module 'buffer' {
MAX_LENGTH: number;
MAX_STRING_LENGTH: number;
};
- const BuffType: typeof Buffer;
-
- export type TranscodeEncoding = "ascii" | "utf8" | "utf16le" | "ucs2" | "latin1" | "binary";
-
+ export type TranscodeEncoding = 'ascii' | 'utf8' | 'utf16le' | 'ucs2' | 'latin1' | 'binary';
+ /**
+ * Re-encodes the given `Buffer` or `Uint8Array` instance from one character
+ * encoding to another. Returns a new `Buffer` instance.
+ *
+ * Throws if the `fromEnc` or `toEnc` specify invalid character encodings or if
+ * conversion from `fromEnc` to `toEnc` is not permitted.
+ *
+ * Encodings supported by `buffer.transcode()` are: `'ascii'`, `'utf8'`,`'utf16le'`, `'ucs2'`, `'latin1'`, and `'binary'`.
+ *
+ * The transcoding process will use substitution characters if a given byte
+ * sequence cannot be adequately represented in the target encoding. For instance:
+ *
+ * ```js
+ * import { Buffer, transcode } from 'buffer';
+ *
+ * const newBuf = transcode(Buffer.from('€'), 'utf8', 'ascii');
+ * console.log(newBuf.toString('ascii'));
+ * // Prints: '?'
+ * ```
+ *
+ * Because the Euro (`€`) sign is not representable in US-ASCII, it is replaced
+ * with `?` in the transcoded `Buffer`.
+ * @since v7.1.0
+ * @param source A `Buffer` or `Uint8Array` instance.
+ * @param fromEnc The current encoding.
+ * @param toEnc To target encoding.
+ */
export function transcode(source: Uint8Array, fromEnc: TranscodeEncoding, toEnc: TranscodeEncoding): Buffer;
-
export const SlowBuffer: {
/** @deprecated since v6.0.0, use `Buffer.allocUnsafeSlow()` */
- new(size: number): Buffer;
+ new (size: number): Buffer;
prototype: Buffer;
};
+ /**
+ * Resolves a `'blob:nodedata:...'` an associated `Blob` object registered using
+ * a prior call to `URL.createObjectURL()`.
+ * @since v16.7.0
+ * @experimental
+ * @param id A `'blob:nodedata:...` URL string returned by a prior call to `URL.createObjectURL()`.
+ */
+ export function resolveObjectURL(id: string): Blob | undefined;
+ export { Buffer };
/**
* @experimental
*/
@@ -39,18 +117,18 @@ declare module 'buffer' {
/**
* A [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) encapsulates immutable, raw data that can be safely shared across
* multiple worker threads.
- * @since v14.18.0
+ * @since v15.7.0
* @experimental
*/
export class Blob {
/**
* The total size of the `Blob` in bytes.
- * @since v14.18.0
+ * @since v15.7.0
*/
readonly size: number;
/**
* The content-type of the `Blob`.
- * @since v14.18.0
+ * @since v15.7.0
*/
readonly type: string;
/**
@@ -65,13 +143,13 @@ declare module 'buffer' {
/**
* Returns a promise that fulfills with an [ArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) containing a copy of
* the `Blob` data.
- * @since v14.18.0
+ * @since v15.7.0
*/
arrayBuffer(): Promise;
/**
* Creates and returns a new `Blob` containing a subset of this `Blob` objects
* data. The original `Blob` is not altered.
- * @since v14.18.0
+ * @since v15.7.0
* @param start The starting index.
* @param end The ending index.
* @param type The content-type for the new `Blob`
@@ -80,12 +158,2078 @@ declare module 'buffer' {
/**
* Returns a promise that fulfills with the contents of the `Blob` decoded as a
* UTF-8 string.
- * @since v14.18.0
+ * @since v15.7.0
*/
text(): Promise;
+ /**
+ * Returns a new (WHATWG) `ReadableStream` that allows the content of the `Blob` to be read.
+ * @since v16.7.0
+ */
+ stream(): WebReadableStream;
+ }
+ export import atob = globalThis.atob;
+ export import btoa = globalThis.btoa;
+ global {
+ // Buffer class
+ type BufferEncoding = 'ascii' | 'utf8' | 'utf-8' | 'utf16le' | 'ucs2' | 'ucs-2' | 'base64' | 'base64url' | 'latin1' | 'binary' | 'hex';
+ type WithImplicitCoercion =
+ | T
+ | {
+ valueOf(): T;
+ };
+ /**
+ * Raw data is stored in instances of the Buffer class.
+ * A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap. A Buffer cannot be resized.
+ * Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'base64url'|'binary'(deprecated)|'hex'
+ */
+ interface BufferConstructor {
+ /**
+ * Allocates a new buffer containing the given {str}.
+ *
+ * @param str String to store in buffer.
+ * @param encoding encoding to use, optional. Default is 'utf8'
+ * @deprecated since v10.0.0 - Use `Buffer.from(string[, encoding])` instead.
+ */
+ new (str: string, encoding?: BufferEncoding): Buffer;
+ /**
+ * Allocates a new buffer of {size} octets.
+ *
+ * @param size count of octets to allocate.
+ * @deprecated since v10.0.0 - Use `Buffer.alloc()` instead (also see `Buffer.allocUnsafe()`).
+ */
+ new (size: number): Buffer;
+ /**
+ * Allocates a new buffer containing the given {array} of octets.
+ *
+ * @param array The octets to store.
+ * @deprecated since v10.0.0 - Use `Buffer.from(array)` instead.
+ */
+ new (array: Uint8Array): Buffer;
+ /**
+ * Produces a Buffer backed by the same allocated memory as
+ * the given {ArrayBuffer}/{SharedArrayBuffer}.
+ *
+ *
+ * @param arrayBuffer The ArrayBuffer with which to share memory.
+ * @deprecated since v10.0.0 - Use `Buffer.from(arrayBuffer[, byteOffset[, length]])` instead.
+ */
+ new (arrayBuffer: ArrayBuffer | SharedArrayBuffer): Buffer;
+ /**
+ * Allocates a new buffer containing the given {array} of octets.
+ *
+ * @param array The octets to store.
+ * @deprecated since v10.0.0 - Use `Buffer.from(array)` instead.
+ */
+ new (array: ReadonlyArray): Buffer;
+ /**
+ * Copies the passed {buffer} data onto a new {Buffer} instance.
+ *
+ * @param buffer The buffer to copy.
+ * @deprecated since v10.0.0 - Use `Buffer.from(buffer)` instead.
+ */
+ new (buffer: Buffer): Buffer;
+ /**
+ * Allocates a new `Buffer` using an `array` of bytes in the range `0` – `255`.
+ * Array entries outside that range will be truncated to fit into it.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * // Creates a new Buffer containing the UTF-8 bytes of the string 'buffer'.
+ * const buf = Buffer.from([0x62, 0x75, 0x66, 0x66, 0x65, 0x72]);
+ * ```
+ *
+ * A `TypeError` will be thrown if `array` is not an `Array` or another type
+ * appropriate for `Buffer.from()` variants.
+ *
+ * `Buffer.from(array)` and `Buffer.from(string)` may also use the internal`Buffer` pool like `Buffer.allocUnsafe()` does.
+ * @since v5.10.0
+ */
+ from(arrayBuffer: WithImplicitCoercion, byteOffset?: number, length?: number): Buffer;
+ /**
+ * Creates a new Buffer using the passed {data}
+ * @param data data to create a new Buffer
+ */
+ from(data: Uint8Array | ReadonlyArray): Buffer;
+ from(data: WithImplicitCoercion | string>): Buffer;
+ /**
+ * Creates a new Buffer containing the given JavaScript string {str}.
+ * If provided, the {encoding} parameter identifies the character encoding.
+ * If not provided, {encoding} defaults to 'utf8'.
+ */
+ from(
+ str:
+ | WithImplicitCoercion
+ | {
+ [Symbol.toPrimitive](hint: 'string'): string;
+ },
+ encoding?: BufferEncoding
+ ): Buffer;
+ /**
+ * Creates a new Buffer using the passed {data}
+ * @param values to create a new Buffer
+ */
+ of(...items: number[]): Buffer;
+ /**
+ * Returns `true` if `obj` is a `Buffer`, `false` otherwise.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * Buffer.isBuffer(Buffer.alloc(10)); // true
+ * Buffer.isBuffer(Buffer.from('foo')); // true
+ * Buffer.isBuffer('a string'); // false
+ * Buffer.isBuffer([]); // false
+ * Buffer.isBuffer(new Uint8Array(1024)); // false
+ * ```
+ * @since v0.1.101
+ */
+ isBuffer(obj: any): obj is Buffer;
+ /**
+ * Returns `true` if `encoding` is the name of a supported character encoding,
+ * or `false` otherwise.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * console.log(Buffer.isEncoding('utf8'));
+ * // Prints: true
+ *
+ * console.log(Buffer.isEncoding('hex'));
+ * // Prints: true
+ *
+ * console.log(Buffer.isEncoding('utf/8'));
+ * // Prints: false
+ *
+ * console.log(Buffer.isEncoding(''));
+ * // Prints: false
+ * ```
+ * @since v0.9.1
+ * @param encoding A character encoding name to check.
+ */
+ isEncoding(encoding: string): encoding is BufferEncoding;
+ /**
+ * Returns the byte length of a string when encoded using `encoding`.
+ * This is not the same as [`String.prototype.length`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/length), which does not account
+ * for the encoding that is used to convert the string into bytes.
+ *
+ * For `'base64'`, `'base64url'`, and `'hex'`, this function assumes valid input.
+ * For strings that contain non-base64/hex-encoded data (e.g. whitespace), the
+ * return value might be greater than the length of a `Buffer` created from the
+ * string.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const str = '\u00bd + \u00bc = \u00be';
+ *
+ * console.log(`${str}: ${str.length} characters, ` +
+ * `${Buffer.byteLength(str, 'utf8')} bytes`);
+ * // Prints: ½ + ¼ = ¾: 9 characters, 12 bytes
+ * ```
+ *
+ * When `string` is a
+ * `Buffer`/[`DataView`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView)/[`TypedArray`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/-
+ * Reference/Global_Objects/TypedArray)/[`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer)/[`SharedArrayBuffer`](https://develop-
+ * er.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer), the byte length as reported by `.byteLength`is returned.
+ * @since v0.1.90
+ * @param string A value to calculate the length of.
+ * @param [encoding='utf8'] If `string` is a string, this is its encoding.
+ * @return The number of bytes contained within `string`.
+ */
+ byteLength(string: string | NodeJS.ArrayBufferView | ArrayBuffer | SharedArrayBuffer, encoding?: BufferEncoding): number;
+ /**
+ * Returns a new `Buffer` which is the result of concatenating all the `Buffer`instances in the `list` together.
+ *
+ * If the list has no items, or if the `totalLength` is 0, then a new zero-length`Buffer` is returned.
+ *
+ * If `totalLength` is not provided, it is calculated from the `Buffer` instances
+ * in `list` by adding their lengths.
+ *
+ * If `totalLength` is provided, it is coerced to an unsigned integer. If the
+ * combined length of the `Buffer`s in `list` exceeds `totalLength`, the result is
+ * truncated to `totalLength`.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * // Create a single `Buffer` from a list of three `Buffer` instances.
+ *
+ * const buf1 = Buffer.alloc(10);
+ * const buf2 = Buffer.alloc(14);
+ * const buf3 = Buffer.alloc(18);
+ * const totalLength = buf1.length + buf2.length + buf3.length;
+ *
+ * console.log(totalLength);
+ * // Prints: 42
+ *
+ * const bufA = Buffer.concat([buf1, buf2, buf3], totalLength);
+ *
+ * console.log(bufA);
+ * // Prints:
+ * console.log(bufA.length);
+ * // Prints: 42
+ * ```
+ *
+ * `Buffer.concat()` may also use the internal `Buffer` pool like `Buffer.allocUnsafe()` does.
+ * @since v0.7.11
+ * @param list List of `Buffer` or {@link Uint8Array} instances to concatenate.
+ * @param totalLength Total length of the `Buffer` instances in `list` when concatenated.
+ */
+ concat(list: ReadonlyArray, totalLength?: number): Buffer;
+ /**
+ * Compares `buf1` to `buf2`, typically for the purpose of sorting arrays of`Buffer` instances. This is equivalent to calling `buf1.compare(buf2)`.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf1 = Buffer.from('1234');
+ * const buf2 = Buffer.from('0123');
+ * const arr = [buf1, buf2];
+ *
+ * console.log(arr.sort(Buffer.compare));
+ * // Prints: [ , ]
+ * // (This result is equal to: [buf2, buf1].)
+ * ```
+ * @since v0.11.13
+ * @return Either `-1`, `0`, or `1`, depending on the result of the comparison. See `compare` for details.
+ */
+ compare(buf1: Uint8Array, buf2: Uint8Array): number;
+ /**
+ * Allocates a new `Buffer` of `size` bytes. If `fill` is `undefined`, the`Buffer` will be zero-filled.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.alloc(5);
+ *
+ * console.log(buf);
+ * // Prints:
+ * ```
+ *
+ * If `size` is larger than {@link constants.MAX_LENGTH} or smaller than 0, `ERR_INVALID_ARG_VALUE` is thrown.
+ *
+ * If `fill` is specified, the allocated `Buffer` will be initialized by calling `buf.fill(fill)`.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.alloc(5, 'a');
+ *
+ * console.log(buf);
+ * // Prints:
+ * ```
+ *
+ * If both `fill` and `encoding` are specified, the allocated `Buffer` will be
+ * initialized by calling `buf.fill(fill, encoding)`.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.alloc(11, 'aGVsbG8gd29ybGQ=', 'base64');
+ *
+ * console.log(buf);
+ * // Prints:
+ * ```
+ *
+ * Calling `Buffer.alloc()` can be measurably slower than the alternative `Buffer.allocUnsafe()` but ensures that the newly created `Buffer` instance
+ * contents will never contain sensitive data from previous allocations, including
+ * data that might not have been allocated for `Buffer`s.
+ *
+ * A `TypeError` will be thrown if `size` is not a number.
+ * @since v5.10.0
+ * @param size The desired length of the new `Buffer`.
+ * @param [fill=0] A value to pre-fill the new `Buffer` with.
+ * @param [encoding='utf8'] If `fill` is a string, this is its encoding.
+ */
+ alloc(size: number, fill?: string | Buffer | number, encoding?: BufferEncoding): Buffer;
+ /**
+ * Allocates a new `Buffer` of `size` bytes. If `size` is larger than {@link constants.MAX_LENGTH} or smaller than 0, `ERR_INVALID_ARG_VALUE` is thrown.
+ *
+ * The underlying memory for `Buffer` instances created in this way is _not_
+ * _initialized_. The contents of the newly created `Buffer` are unknown and_may contain sensitive data_. Use `Buffer.alloc()` instead to initialize`Buffer` instances with zeroes.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.allocUnsafe(10);
+ *
+ * console.log(buf);
+ * // Prints (contents may vary):
+ *
+ * buf.fill(0);
+ *
+ * console.log(buf);
+ * // Prints:
+ * ```
+ *
+ * A `TypeError` will be thrown if `size` is not a number.
+ *
+ * The `Buffer` module pre-allocates an internal `Buffer` instance of
+ * size `Buffer.poolSize` that is used as a pool for the fast allocation of new`Buffer` instances created using `Buffer.allocUnsafe()`,`Buffer.from(array)`, `Buffer.concat()`, and the
+ * deprecated`new Buffer(size)` constructor only when `size` is less than or equal
+ * to `Buffer.poolSize >> 1` (floor of `Buffer.poolSize` divided by two).
+ *
+ * Use of this pre-allocated internal memory pool is a key difference between
+ * calling `Buffer.alloc(size, fill)` vs. `Buffer.allocUnsafe(size).fill(fill)`.
+ * Specifically, `Buffer.alloc(size, fill)` will _never_ use the internal `Buffer`pool, while `Buffer.allocUnsafe(size).fill(fill)`_will_ use the internal`Buffer` pool if `size` is less
+ * than or equal to half `Buffer.poolSize`. The
+ * difference is subtle but can be important when an application requires the
+ * additional performance that `Buffer.allocUnsafe()` provides.
+ * @since v5.10.0
+ * @param size The desired length of the new `Buffer`.
+ */
+ allocUnsafe(size: number): Buffer;
+ /**
+ * Allocates a new `Buffer` of `size` bytes. If `size` is larger than {@link constants.MAX_LENGTH} or smaller than 0, `ERR_INVALID_ARG_VALUE` is thrown. A zero-length `Buffer` is created
+ * if `size` is 0.
+ *
+ * The underlying memory for `Buffer` instances created in this way is _not_
+ * _initialized_. The contents of the newly created `Buffer` are unknown and_may contain sensitive data_. Use `buf.fill(0)` to initialize
+ * such `Buffer` instances with zeroes.
+ *
+ * When using `Buffer.allocUnsafe()` to allocate new `Buffer` instances,
+ * allocations under 4 KB are sliced from a single pre-allocated `Buffer`. This
+ * allows applications to avoid the garbage collection overhead of creating many
+ * individually allocated `Buffer` instances. This approach improves both
+ * performance and memory usage by eliminating the need to track and clean up as
+ * many individual `ArrayBuffer` objects.
+ *
+ * However, in the case where a developer may need to retain a small chunk of
+ * memory from a pool for an indeterminate amount of time, it may be appropriate
+ * to create an un-pooled `Buffer` instance using `Buffer.allocUnsafeSlow()` and
+ * then copying out the relevant bits.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * // Need to keep around a few small chunks of memory.
+ * const store = [];
+ *
+ * socket.on('readable', () => {
+ * let data;
+ * while (null !== (data = readable.read())) {
+ * // Allocate for retained data.
+ * const sb = Buffer.allocUnsafeSlow(10);
+ *
+ * // Copy the data into the new allocation.
+ * data.copy(sb, 0, 0, 10);
+ *
+ * store.push(sb);
+ * }
+ * });
+ * ```
+ *
+ * A `TypeError` will be thrown if `size` is not a number.
+ * @since v5.12.0
+ * @param size The desired length of the new `Buffer`.
+ */
+ allocUnsafeSlow(size: number): Buffer;
+ /**
+ * This is the size (in bytes) of pre-allocated internal `Buffer` instances used
+ * for pooling. This value may be modified.
+ * @since v0.11.3
+ */
+ poolSize: number;
+ }
+ interface Buffer extends Uint8Array {
+ /**
+ * Writes `string` to `buf` at `offset` according to the character encoding in`encoding`. The `length` parameter is the number of bytes to write. If `buf` did
+ * not contain enough space to fit the entire string, only part of `string` will be
+ * written. However, partially encoded characters will not be written.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.alloc(256);
+ *
+ * const len = buf.write('\u00bd + \u00bc = \u00be', 0);
+ *
+ * console.log(`${len} bytes: ${buf.toString('utf8', 0, len)}`);
+ * // Prints: 12 bytes: ½ + ¼ = ¾
+ *
+ * const buffer = Buffer.alloc(10);
+ *
+ * const length = buffer.write('abcd', 8);
+ *
+ * console.log(`${length} bytes: ${buffer.toString('utf8', 8, 10)}`);
+ * // Prints: 2 bytes : ab
+ * ```
+ * @since v0.1.90
+ * @param string String to write to `buf`.
+ * @param [offset=0] Number of bytes to skip before starting to write `string`.
+ * @param [length=buf.length - offset] Maximum number of bytes to write (written bytes will not exceed `buf.length - offset`).
+ * @param [encoding='utf8'] The character encoding of `string`.
+ * @return Number of bytes written.
+ */
+ write(string: string, encoding?: BufferEncoding): number;
+ write(string: string, offset: number, encoding?: BufferEncoding): number;
+ write(string: string, offset: number, length: number, encoding?: BufferEncoding): number;
+ /**
+ * Decodes `buf` to a string according to the specified character encoding in`encoding`. `start` and `end` may be passed to decode only a subset of `buf`.
+ *
+ * If `encoding` is `'utf8'` and a byte sequence in the input is not valid UTF-8,
+ * then each invalid byte is replaced with the replacement character `U+FFFD`.
+ *
+ * The maximum length of a string instance (in UTF-16 code units) is available
+ * as {@link constants.MAX_STRING_LENGTH}.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf1 = Buffer.allocUnsafe(26);
+ *
+ * for (let i = 0; i < 26; i++) {
+ * // 97 is the decimal ASCII value for 'a'.
+ * buf1[i] = i + 97;
+ * }
+ *
+ * console.log(buf1.toString('utf8'));
+ * // Prints: abcdefghijklmnopqrstuvwxyz
+ * console.log(buf1.toString('utf8', 0, 5));
+ * // Prints: abcde
+ *
+ * const buf2 = Buffer.from('tést');
+ *
+ * console.log(buf2.toString('hex'));
+ * // Prints: 74c3a97374
+ * console.log(buf2.toString('utf8', 0, 3));
+ * // Prints: té
+ * console.log(buf2.toString(undefined, 0, 3));
+ * // Prints: té
+ * ```
+ * @since v0.1.90
+ * @param [encoding='utf8'] The character encoding to use.
+ * @param [start=0] The byte offset to start decoding at.
+ * @param [end=buf.length] The byte offset to stop decoding at (not inclusive).
+ */
+ toString(encoding?: BufferEncoding, start?: number, end?: number): string;
+ /**
+ * Returns a JSON representation of `buf`. [`JSON.stringify()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify) implicitly calls
+ * this function when stringifying a `Buffer` instance.
+ *
+ * `Buffer.from()` accepts objects in the format returned from this method.
+ * In particular, `Buffer.from(buf.toJSON())` works like `Buffer.from(buf)`.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5]);
+ * const json = JSON.stringify(buf);
+ *
+ * console.log(json);
+ * // Prints: {"type":"Buffer","data":[1,2,3,4,5]}
+ *
+ * const copy = JSON.parse(json, (key, value) => {
+ * return value && value.type === 'Buffer' ?
+ * Buffer.from(value) :
+ * value;
+ * });
+ *
+ * console.log(copy);
+ * // Prints:
+ * ```
+ * @since v0.9.2
+ */
+ toJSON(): {
+ type: 'Buffer';
+ data: number[];
+ };
+ /**
+ * Returns `true` if both `buf` and `otherBuffer` have exactly the same bytes,`false` otherwise. Equivalent to `buf.compare(otherBuffer) === 0`.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf1 = Buffer.from('ABC');
+ * const buf2 = Buffer.from('414243', 'hex');
+ * const buf3 = Buffer.from('ABCD');
+ *
+ * console.log(buf1.equals(buf2));
+ * // Prints: true
+ * console.log(buf1.equals(buf3));
+ * // Prints: false
+ * ```
+ * @since v0.11.13
+ * @param otherBuffer A `Buffer` or {@link Uint8Array} with which to compare `buf`.
+ */
+ equals(otherBuffer: Uint8Array): boolean;
+ /**
+ * Compares `buf` with `target` and returns a number indicating whether `buf`comes before, after, or is the same as `target` in sort order.
+ * Comparison is based on the actual sequence of bytes in each `Buffer`.
+ *
+ * * `0` is returned if `target` is the same as `buf`
+ * * `1` is returned if `target` should come _before_`buf` when sorted.
+ * * `-1` is returned if `target` should come _after_`buf` when sorted.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf1 = Buffer.from('ABC');
+ * const buf2 = Buffer.from('BCD');
+ * const buf3 = Buffer.from('ABCD');
+ *
+ * console.log(buf1.compare(buf1));
+ * // Prints: 0
+ * console.log(buf1.compare(buf2));
+ * // Prints: -1
+ * console.log(buf1.compare(buf3));
+ * // Prints: -1
+ * console.log(buf2.compare(buf1));
+ * // Prints: 1
+ * console.log(buf2.compare(buf3));
+ * // Prints: 1
+ * console.log([buf1, buf2, buf3].sort(Buffer.compare));
+ * // Prints: [ , , ]
+ * // (This result is equal to: [buf1, buf3, buf2].)
+ * ```
+ *
+ * The optional `targetStart`, `targetEnd`, `sourceStart`, and `sourceEnd`arguments can be used to limit the comparison to specific ranges within `target`and `buf` respectively.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf1 = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8, 9]);
+ * const buf2 = Buffer.from([5, 6, 7, 8, 9, 1, 2, 3, 4]);
+ *
+ * console.log(buf1.compare(buf2, 5, 9, 0, 4));
+ * // Prints: 0
+ * console.log(buf1.compare(buf2, 0, 6, 4));
+ * // Prints: -1
+ * console.log(buf1.compare(buf2, 5, 6, 5));
+ * // Prints: 1
+ * ```
+ *
+ * `ERR_OUT_OF_RANGE` is thrown if `targetStart < 0`, `sourceStart < 0`,`targetEnd > target.byteLength`, or `sourceEnd > source.byteLength`.
+ * @since v0.11.13
+ * @param target A `Buffer` or {@link Uint8Array} with which to compare `buf`.
+ * @param [targetStart=0] The offset within `target` at which to begin comparison.
+ * @param [targetEnd=target.length] The offset within `target` at which to end comparison (not inclusive).
+ * @param [sourceStart=0] The offset within `buf` at which to begin comparison.
+ * @param [sourceEnd=buf.length] The offset within `buf` at which to end comparison (not inclusive).
+ */
+ compare(target: Uint8Array, targetStart?: number, targetEnd?: number, sourceStart?: number, sourceEnd?: number): number;
+ /**
+ * Copies data from a region of `buf` to a region in `target`, even if the `target`memory region overlaps with `buf`.
+ *
+ * [`TypedArray.prototype.set()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/set) performs the same operation, and is available
+ * for all TypedArrays, including Node.js `Buffer`s, although it takes
+ * different function arguments.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * // Create two `Buffer` instances.
+ * const buf1 = Buffer.allocUnsafe(26);
+ * const buf2 = Buffer.allocUnsafe(26).fill('!');
+ *
+ * for (let i = 0; i < 26; i++) {
+ * // 97 is the decimal ASCII value for 'a'.
+ * buf1[i] = i + 97;
+ * }
+ *
+ * // Copy `buf1` bytes 16 through 19 into `buf2` starting at byte 8 of `buf2`.
+ * buf1.copy(buf2, 8, 16, 20);
+ * // This is equivalent to:
+ * // buf2.set(buf1.subarray(16, 20), 8);
+ *
+ * console.log(buf2.toString('ascii', 0, 25));
+ * // Prints: !!!!!!!!qrst!!!!!!!!!!!!!
+ * ```
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * // Create a `Buffer` and copy data from one region to an overlapping region
+ * // within the same `Buffer`.
+ *
+ * const buf = Buffer.allocUnsafe(26);
+ *
+ * for (let i = 0; i < 26; i++) {
+ * // 97 is the decimal ASCII value for 'a'.
+ * buf[i] = i + 97;
+ * }
+ *
+ * buf.copy(buf, 0, 4, 10);
+ *
+ * console.log(buf.toString());
+ * // Prints: efghijghijklmnopqrstuvwxyz
+ * ```
+ * @since v0.1.90
+ * @param target A `Buffer` or {@link Uint8Array} to copy into.
+ * @param [targetStart=0] The offset within `target` at which to begin writing.
+ * @param [sourceStart=0] The offset within `buf` from which to begin copying.
+ * @param [sourceEnd=buf.length] The offset within `buf` at which to stop copying (not inclusive).
+ * @return The number of bytes copied.
+ */
+ copy(target: Uint8Array, targetStart?: number, sourceStart?: number, sourceEnd?: number): number;
+ /**
+ * Returns a new `Buffer` that references the same memory as the original, but
+ * offset and cropped by the `start` and `end` indices.
+ *
+ * This is the same behavior as `buf.subarray()`.
+ *
+ * This method is not compatible with the `Uint8Array.prototype.slice()`,
+ * which is a superclass of `Buffer`. To copy the slice, use`Uint8Array.prototype.slice()`.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.from('buffer');
+ *
+ * const copiedBuf = Uint8Array.prototype.slice.call(buf);
+ * copiedBuf[0]++;
+ * console.log(copiedBuf.toString());
+ * // Prints: cuffer
+ *
+ * console.log(buf.toString());
+ * // Prints: buffer
+ * ```
+ * @since v0.3.0
+ * @param [start=0] Where the new `Buffer` will start.
+ * @param [end=buf.length] Where the new `Buffer` will end (not inclusive).
+ */
+ slice(start?: number, end?: number): Buffer;
+ /**
+ * Returns a new `Buffer` that references the same memory as the original, but
+ * offset and cropped by the `start` and `end` indices.
+ *
+ * Specifying `end` greater than `buf.length` will return the same result as
+ * that of `end` equal to `buf.length`.
+ *
+ * This method is inherited from [`TypedArray.prototype.subarray()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/subarray).
+ *
+ * Modifying the new `Buffer` slice will modify the memory in the original `Buffer`because the allocated memory of the two objects overlap.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * // Create a `Buffer` with the ASCII alphabet, take a slice, and modify one byte
+ * // from the original `Buffer`.
+ *
+ * const buf1 = Buffer.allocUnsafe(26);
+ *
+ * for (let i = 0; i < 26; i++) {
+ * // 97 is the decimal ASCII value for 'a'.
+ * buf1[i] = i + 97;
+ * }
+ *
+ * const buf2 = buf1.subarray(0, 3);
+ *
+ * console.log(buf2.toString('ascii', 0, buf2.length));
+ * // Prints: abc
+ *
+ * buf1[0] = 33;
+ *
+ * console.log(buf2.toString('ascii', 0, buf2.length));
+ * // Prints: !bc
+ * ```
+ *
+ * Specifying negative indexes causes the slice to be generated relative to the
+ * end of `buf` rather than the beginning.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.from('buffer');
+ *
+ * console.log(buf.subarray(-6, -1).toString());
+ * // Prints: buffe
+ * // (Equivalent to buf.subarray(0, 5).)
+ *
+ * console.log(buf.subarray(-6, -2).toString());
+ * // Prints: buff
+ * // (Equivalent to buf.subarray(0, 4).)
+ *
+ * console.log(buf.subarray(-5, -2).toString());
+ * // Prints: uff
+ * // (Equivalent to buf.subarray(1, 4).)
+ * ```
+ * @since v3.0.0
+ * @param [start=0] Where the new `Buffer` will start.
+ * @param [end=buf.length] Where the new `Buffer` will end (not inclusive).
+ */
+ subarray(start?: number, end?: number): Buffer;
+ /**
+ * Writes `value` to `buf` at the specified `offset` as big-endian.
+ *
+ * `value` is interpreted and written as a two's complement signed integer.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.allocUnsafe(8);
+ *
+ * buf.writeBigInt64BE(0x0102030405060708n, 0);
+ *
+ * console.log(buf);
+ * // Prints:
+ * ```
+ * @since v12.0.0, v10.20.0
+ * @param value Number to be written to `buf`.
+ * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 8`.
+ * @return `offset` plus the number of bytes written.
+ */
+ writeBigInt64BE(value: bigint, offset?: number): number;
+ /**
+ * Writes `value` to `buf` at the specified `offset` as little-endian.
+ *
+ * `value` is interpreted and written as a two's complement signed integer.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.allocUnsafe(8);
+ *
+ * buf.writeBigInt64LE(0x0102030405060708n, 0);
+ *
+ * console.log(buf);
+ * // Prints:
+ * ```
+ * @since v12.0.0, v10.20.0
+ * @param value Number to be written to `buf`.
+ * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 8`.
+ * @return `offset` plus the number of bytes written.
+ */
+ writeBigInt64LE(value: bigint, offset?: number): number;
+ /**
+ * Writes `value` to `buf` at the specified `offset` as big-endian.
+ *
+ * This function is also available under the `writeBigUint64BE` alias.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.allocUnsafe(8);
+ *
+ * buf.writeBigUInt64BE(0xdecafafecacefaden, 0);
+ *
+ * console.log(buf);
+ * // Prints:
+ * ```
+ * @since v12.0.0, v10.20.0
+ * @param value Number to be written to `buf`.
+ * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 8`.
+ * @return `offset` plus the number of bytes written.
+ */
+ writeBigUInt64BE(value: bigint, offset?: number): number;
+ /**
+ * @alias Buffer.writeBigUInt64BE
+ * @since v14.10.0, v12.19.0
+ */
+ writeBigUint64BE(value: bigint, offset?: number): number;
+ /**
+ * Writes `value` to `buf` at the specified `offset` as little-endian
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.allocUnsafe(8);
+ *
+ * buf.writeBigUInt64LE(0xdecafafecacefaden, 0);
+ *
+ * console.log(buf);
+ * // Prints:
+ * ```
+ *
+ * This function is also available under the `writeBigUint64LE` alias.
+ * @since v12.0.0, v10.20.0
+ * @param value Number to be written to `buf`.
+ * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 8`.
+ * @return `offset` plus the number of bytes written.
+ */
+ writeBigUInt64LE(value: bigint, offset?: number): number;
+ /**
+ * @alias Buffer.writeBigUInt64LE
+ * @since v14.10.0, v12.19.0
+ */
+ writeBigUint64LE(value: bigint, offset?: number): number;
+ /**
+ * Writes `byteLength` bytes of `value` to `buf` at the specified `offset`as little-endian. Supports up to 48 bits of accuracy. Behavior is undefined
+ * when `value` is anything other than an unsigned integer.
+ *
+ * This function is also available under the `writeUintLE` alias.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.allocUnsafe(6);
+ *
+ * buf.writeUIntLE(0x1234567890ab, 0, 6);
+ *
+ * console.log(buf);
+ * // Prints:
+ * ```
+ * @since v0.5.5
+ * @param value Number to be written to `buf`.
+ * @param offset Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - byteLength`.
+ * @param byteLength Number of bytes to write. Must satisfy `0 < byteLength <= 6`.
+ * @return `offset` plus the number of bytes written.
+ */
+ writeUIntLE(value: number, offset: number, byteLength: number): number;
+ /**
+ * @alias Buffer.writeUIntLE
+ * @since v14.9.0, v12.19.0
+ */
+ writeUintLE(value: number, offset: number, byteLength: number): number;
+ /**
+ * Writes `byteLength` bytes of `value` to `buf` at the specified `offset`as big-endian. Supports up to 48 bits of accuracy. Behavior is undefined
+ * when `value` is anything other than an unsigned integer.
+ *
+ * This function is also available under the `writeUintBE` alias.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.allocUnsafe(6);
+ *
+ * buf.writeUIntBE(0x1234567890ab, 0, 6);
+ *
+ * console.log(buf);
+ * // Prints:
+ * ```
+ * @since v0.5.5
+ * @param value Number to be written to `buf`.
+ * @param offset Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - byteLength`.
+ * @param byteLength Number of bytes to write. Must satisfy `0 < byteLength <= 6`.
+ * @return `offset` plus the number of bytes written.
+ */
+ writeUIntBE(value: number, offset: number, byteLength: number): number;
+ /**
+ * @alias Buffer.writeUIntBE
+ * @since v14.9.0, v12.19.0
+ */
+ writeUintBE(value: number, offset: number, byteLength: number): number;
+ /**
+ * Writes `byteLength` bytes of `value` to `buf` at the specified `offset`as little-endian. Supports up to 48 bits of accuracy. Behavior is undefined
+ * when `value` is anything other than a signed integer.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.allocUnsafe(6);
+ *
+ * buf.writeIntLE(0x1234567890ab, 0, 6);
+ *
+ * console.log(buf);
+ * // Prints:
+ * ```
+ * @since v0.11.15
+ * @param value Number to be written to `buf`.
+ * @param offset Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - byteLength`.
+ * @param byteLength Number of bytes to write. Must satisfy `0 < byteLength <= 6`.
+ * @return `offset` plus the number of bytes written.
+ */
+ writeIntLE(value: number, offset: number, byteLength: number): number;
+ /**
+ * Writes `byteLength` bytes of `value` to `buf` at the specified `offset`as big-endian. Supports up to 48 bits of accuracy. Behavior is undefined when`value` is anything other than a
+ * signed integer.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.allocUnsafe(6);
+ *
+ * buf.writeIntBE(0x1234567890ab, 0, 6);
+ *
+ * console.log(buf);
+ * // Prints:
+ * ```
+ * @since v0.11.15
+ * @param value Number to be written to `buf`.
+ * @param offset Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - byteLength`.
+ * @param byteLength Number of bytes to write. Must satisfy `0 < byteLength <= 6`.
+ * @return `offset` plus the number of bytes written.
+ */
+ writeIntBE(value: number, offset: number, byteLength: number): number;
+ /**
+ * Reads an unsigned, big-endian 64-bit integer from `buf` at the specified`offset`.
+ *
+ * This function is also available under the `readBigUint64BE` alias.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);
+ *
+ * console.log(buf.readBigUInt64BE(0));
+ * // Prints: 4294967295n
+ * ```
+ * @since v12.0.0, v10.20.0
+ * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 8`.
+ */
+ readBigUInt64BE(offset?: number): bigint;
+ /**
+ * @alias Buffer.readBigUInt64BE
+ * @since v14.10.0, v12.19.0
+ */
+ readBigUint64BE(offset?: number): bigint;
+ /**
+ * Reads an unsigned, little-endian 64-bit integer from `buf` at the specified`offset`.
+ *
+ * This function is also available under the `readBigUint64LE` alias.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);
+ *
+ * console.log(buf.readBigUInt64LE(0));
+ * // Prints: 18446744069414584320n
+ * ```
+ * @since v12.0.0, v10.20.0
+ * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 8`.
+ */
+ readBigUInt64LE(offset?: number): bigint;
+ /**
+ * @alias Buffer.readBigUInt64LE
+ * @since v14.10.0, v12.19.0
+ */
+ readBigUint64LE(offset?: number): bigint;
+ /**
+ * Reads a signed, big-endian 64-bit integer from `buf` at the specified `offset`.
+ *
+ * Integers read from a `Buffer` are interpreted as two's complement signed
+ * values.
+ * @since v12.0.0, v10.20.0
+ * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 8`.
+ */
+ readBigInt64BE(offset?: number): bigint;
+ /**
+ * Reads a signed, little-endian 64-bit integer from `buf` at the specified`offset`.
+ *
+ * Integers read from a `Buffer` are interpreted as two's complement signed
+ * values.
+ * @since v12.0.0, v10.20.0
+ * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 8`.
+ */
+ readBigInt64LE(offset?: number): bigint;
+ /**
+ * Reads `byteLength` number of bytes from `buf` at the specified `offset`and interprets the result as an unsigned, little-endian integer supporting
+ * up to 48 bits of accuracy.
+ *
+ * This function is also available under the `readUintLE` alias.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
+ *
+ * console.log(buf.readUIntLE(0, 6).toString(16));
+ * // Prints: ab9078563412
+ * ```
+ * @since v0.11.15
+ * @param offset Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - byteLength`.
+ * @param byteLength Number of bytes to read. Must satisfy `0 < byteLength <= 6`.
+ */
+ readUIntLE(offset: number, byteLength: number): number;
+ /**
+ * @alias Buffer.readUIntLE
+ * @since v14.9.0, v12.19.0
+ */
+ readUintLE(offset: number, byteLength: number): number;
+ /**
+ * Reads `byteLength` number of bytes from `buf` at the specified `offset`and interprets the result as an unsigned big-endian integer supporting
+ * up to 48 bits of accuracy.
+ *
+ * This function is also available under the `readUintBE` alias.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
+ *
+ * console.log(buf.readUIntBE(0, 6).toString(16));
+ * // Prints: 1234567890ab
+ * console.log(buf.readUIntBE(1, 6).toString(16));
+ * // Throws ERR_OUT_OF_RANGE.
+ * ```
+ * @since v0.11.15
+ * @param offset Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - byteLength`.
+ * @param byteLength Number of bytes to read. Must satisfy `0 < byteLength <= 6`.
+ */
+ readUIntBE(offset: number, byteLength: number): number;
+ /**
+ * @alias Buffer.readUIntBE
+ * @since v14.9.0, v12.19.0
+ */
+ readUintBE(offset: number, byteLength: number): number;
+ /**
+ * Reads `byteLength` number of bytes from `buf` at the specified `offset`and interprets the result as a little-endian, two's complement signed value
+ * supporting up to 48 bits of accuracy.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
+ *
+ * console.log(buf.readIntLE(0, 6).toString(16));
+ * // Prints: -546f87a9cbee
+ * ```
+ * @since v0.11.15
+ * @param offset Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - byteLength`.
+ * @param byteLength Number of bytes to read. Must satisfy `0 < byteLength <= 6`.
+ */
+ readIntLE(offset: number, byteLength: number): number;
+ /**
+ * Reads `byteLength` number of bytes from `buf` at the specified `offset`and interprets the result as a big-endian, two's complement signed value
+ * supporting up to 48 bits of accuracy.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
+ *
+ * console.log(buf.readIntBE(0, 6).toString(16));
+ * // Prints: 1234567890ab
+ * console.log(buf.readIntBE(1, 6).toString(16));
+ * // Throws ERR_OUT_OF_RANGE.
+ * console.log(buf.readIntBE(1, 0).toString(16));
+ * // Throws ERR_OUT_OF_RANGE.
+ * ```
+ * @since v0.11.15
+ * @param offset Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - byteLength`.
+ * @param byteLength Number of bytes to read. Must satisfy `0 < byteLength <= 6`.
+ */
+ readIntBE(offset: number, byteLength: number): number;
+ /**
+ * Reads an unsigned 8-bit integer from `buf` at the specified `offset`.
+ *
+ * This function is also available under the `readUint8` alias.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.from([1, -2]);
+ *
+ * console.log(buf.readUInt8(0));
+ * // Prints: 1
+ * console.log(buf.readUInt8(1));
+ * // Prints: 254
+ * console.log(buf.readUInt8(2));
+ * // Throws ERR_OUT_OF_RANGE.
+ * ```
+ * @since v0.5.0
+ * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 1`.
+ */
+ readUInt8(offset?: number): number;
+ /**
+ * @alias Buffer.readUInt8
+ * @since v14.9.0, v12.19.0
+ */
+ readUint8(offset?: number): number;
+ /**
+ * Reads an unsigned, little-endian 16-bit integer from `buf` at the specified`offset`.
+ *
+ * This function is also available under the `readUint16LE` alias.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.from([0x12, 0x34, 0x56]);
+ *
+ * console.log(buf.readUInt16LE(0).toString(16));
+ * // Prints: 3412
+ * console.log(buf.readUInt16LE(1).toString(16));
+ * // Prints: 5634
+ * console.log(buf.readUInt16LE(2).toString(16));
+ * // Throws ERR_OUT_OF_RANGE.
+ * ```
+ * @since v0.5.5
+ * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 2`.
+ */
+ readUInt16LE(offset?: number): number;
+ /**
+ * @alias Buffer.readUInt16LE
+ * @since v14.9.0, v12.19.0
+ */
+ readUint16LE(offset?: number): number;
+ /**
+ * Reads an unsigned, big-endian 16-bit integer from `buf` at the specified`offset`.
+ *
+ * This function is also available under the `readUint16BE` alias.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.from([0x12, 0x34, 0x56]);
+ *
+ * console.log(buf.readUInt16BE(0).toString(16));
+ * // Prints: 1234
+ * console.log(buf.readUInt16BE(1).toString(16));
+ * // Prints: 3456
+ * ```
+ * @since v0.5.5
+ * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 2`.
+ */
+ readUInt16BE(offset?: number): number;
+ /**
+ * @alias Buffer.readUInt16BE
+ * @since v14.9.0, v12.19.0
+ */
+ readUint16BE(offset?: number): number;
+ /**
+ * Reads an unsigned, little-endian 32-bit integer from `buf` at the specified`offset`.
+ *
+ * This function is also available under the `readUint32LE` alias.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);
+ *
+ * console.log(buf.readUInt32LE(0).toString(16));
+ * // Prints: 78563412
+ * console.log(buf.readUInt32LE(1).toString(16));
+ * // Throws ERR_OUT_OF_RANGE.
+ * ```
+ * @since v0.5.5
+ * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 4`.
+ */
+ readUInt32LE(offset?: number): number;
+ /**
+ * @alias Buffer.readUInt32LE
+ * @since v14.9.0, v12.19.0
+ */
+ readUint32LE(offset?: number): number;
+ /**
+ * Reads an unsigned, big-endian 32-bit integer from `buf` at the specified`offset`.
+ *
+ * This function is also available under the `readUint32BE` alias.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);
+ *
+ * console.log(buf.readUInt32BE(0).toString(16));
+ * // Prints: 12345678
+ * ```
+ * @since v0.5.5
+ * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 4`.
+ */
+ readUInt32BE(offset?: number): number;
+ /**
+ * @alias Buffer.readUInt32BE
+ * @since v14.9.0, v12.19.0
+ */
+ readUint32BE(offset?: number): number;
+ /**
+ * Reads a signed 8-bit integer from `buf` at the specified `offset`.
+ *
+ * Integers read from a `Buffer` are interpreted as two's complement signed values.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.from([-1, 5]);
+ *
+ * console.log(buf.readInt8(0));
+ * // Prints: -1
+ * console.log(buf.readInt8(1));
+ * // Prints: 5
+ * console.log(buf.readInt8(2));
+ * // Throws ERR_OUT_OF_RANGE.
+ * ```
+ * @since v0.5.0
+ * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 1`.
+ */
+ readInt8(offset?: number): number;
+ /**
+ * Reads a signed, little-endian 16-bit integer from `buf` at the specified`offset`.
+ *
+ * Integers read from a `Buffer` are interpreted as two's complement signed values.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.from([0, 5]);
+ *
+ * console.log(buf.readInt16LE(0));
+ * // Prints: 1280
+ * console.log(buf.readInt16LE(1));
+ * // Throws ERR_OUT_OF_RANGE.
+ * ```
+ * @since v0.5.5
+ * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 2`.
+ */
+ readInt16LE(offset?: number): number;
+ /**
+ * Reads a signed, big-endian 16-bit integer from `buf` at the specified `offset`.
+ *
+ * Integers read from a `Buffer` are interpreted as two's complement signed values.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.from([0, 5]);
+ *
+ * console.log(buf.readInt16BE(0));
+ * // Prints: 5
+ * ```
+ * @since v0.5.5
+ * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 2`.
+ */
+ readInt16BE(offset?: number): number;
+ /**
+ * Reads a signed, little-endian 32-bit integer from `buf` at the specified`offset`.
+ *
+ * Integers read from a `Buffer` are interpreted as two's complement signed values.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.from([0, 0, 0, 5]);
+ *
+ * console.log(buf.readInt32LE(0));
+ * // Prints: 83886080
+ * console.log(buf.readInt32LE(1));
+ * // Throws ERR_OUT_OF_RANGE.
+ * ```
+ * @since v0.5.5
+ * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 4`.
+ */
+ readInt32LE(offset?: number): number;
+ /**
+ * Reads a signed, big-endian 32-bit integer from `buf` at the specified `offset`.
+ *
+ * Integers read from a `Buffer` are interpreted as two's complement signed values.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.from([0, 0, 0, 5]);
+ *
+ * console.log(buf.readInt32BE(0));
+ * // Prints: 5
+ * ```
+ * @since v0.5.5
+ * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 4`.
+ */
+ readInt32BE(offset?: number): number;
+ /**
+ * Reads a 32-bit, little-endian float from `buf` at the specified `offset`.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.from([1, 2, 3, 4]);
+ *
+ * console.log(buf.readFloatLE(0));
+ * // Prints: 1.539989614439558e-36
+ * console.log(buf.readFloatLE(1));
+ * // Throws ERR_OUT_OF_RANGE.
+ * ```
+ * @since v0.11.15
+ * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 4`.
+ */
+ readFloatLE(offset?: number): number;
+ /**
+ * Reads a 32-bit, big-endian float from `buf` at the specified `offset`.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.from([1, 2, 3, 4]);
+ *
+ * console.log(buf.readFloatBE(0));
+ * // Prints: 2.387939260590663e-38
+ * ```
+ * @since v0.11.15
+ * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 4`.
+ */
+ readFloatBE(offset?: number): number;
+ /**
+ * Reads a 64-bit, little-endian double from `buf` at the specified `offset`.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);
+ *
+ * console.log(buf.readDoubleLE(0));
+ * // Prints: 5.447603722011605e-270
+ * console.log(buf.readDoubleLE(1));
+ * // Throws ERR_OUT_OF_RANGE.
+ * ```
+ * @since v0.11.15
+ * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 8`.
+ */
+ readDoubleLE(offset?: number): number;
+ /**
+ * Reads a 64-bit, big-endian double from `buf` at the specified `offset`.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);
+ *
+ * console.log(buf.readDoubleBE(0));
+ * // Prints: 8.20788039913184e-304
+ * ```
+ * @since v0.11.15
+ * @param [offset=0] Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 8`.
+ */
+ readDoubleBE(offset?: number): number;
+ reverse(): this;
+ /**
+ * Interprets `buf` as an array of unsigned 16-bit integers and swaps the
+ * byte order _in-place_. Throws `ERR_INVALID_BUFFER_SIZE` if `buf.length` is not a multiple of 2.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
+ *
+ * console.log(buf1);
+ * // Prints:
+ *
+ * buf1.swap16();
+ *
+ * console.log(buf1);
+ * // Prints:
+ *
+ * const buf2 = Buffer.from([0x1, 0x2, 0x3]);
+ *
+ * buf2.swap16();
+ * // Throws ERR_INVALID_BUFFER_SIZE.
+ * ```
+ *
+ * One convenient use of `buf.swap16()` is to perform a fast in-place conversion
+ * between UTF-16 little-endian and UTF-16 big-endian:
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.from('This is little-endian UTF-16', 'utf16le');
+ * buf.swap16(); // Convert to big-endian UTF-16 text.
+ * ```
+ * @since v5.10.0
+ * @return A reference to `buf`.
+ */
+ swap16(): Buffer;
+ /**
+ * Interprets `buf` as an array of unsigned 32-bit integers and swaps the
+ * byte order _in-place_. Throws `ERR_INVALID_BUFFER_SIZE` if `buf.length` is not a multiple of 4.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
+ *
+ * console.log(buf1);
+ * // Prints:
+ *
+ * buf1.swap32();
+ *
+ * console.log(buf1);
+ * // Prints:
+ *
+ * const buf2 = Buffer.from([0x1, 0x2, 0x3]);
+ *
+ * buf2.swap32();
+ * // Throws ERR_INVALID_BUFFER_SIZE.
+ * ```
+ * @since v5.10.0
+ * @return A reference to `buf`.
+ */
+ swap32(): Buffer;
+ /**
+ * Interprets `buf` as an array of 64-bit numbers and swaps byte order _in-place_.
+ * Throws `ERR_INVALID_BUFFER_SIZE` if `buf.length` is not a multiple of 8.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
+ *
+ * console.log(buf1);
+ * // Prints:
+ *
+ * buf1.swap64();
+ *
+ * console.log(buf1);
+ * // Prints:
+ *
+ * const buf2 = Buffer.from([0x1, 0x2, 0x3]);
+ *
+ * buf2.swap64();
+ * // Throws ERR_INVALID_BUFFER_SIZE.
+ * ```
+ * @since v6.3.0
+ * @return A reference to `buf`.
+ */
+ swap64(): Buffer;
+ /**
+ * Writes `value` to `buf` at the specified `offset`. `value` must be a
+ * valid unsigned 8-bit integer. Behavior is undefined when `value` is anything
+ * other than an unsigned 8-bit integer.
+ *
+ * This function is also available under the `writeUint8` alias.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.allocUnsafe(4);
+ *
+ * buf.writeUInt8(0x3, 0);
+ * buf.writeUInt8(0x4, 1);
+ * buf.writeUInt8(0x23, 2);
+ * buf.writeUInt8(0x42, 3);
+ *
+ * console.log(buf);
+ * // Prints:
+ * ```
+ * @since v0.5.0
+ * @param value Number to be written to `buf`.
+ * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 1`.
+ * @return `offset` plus the number of bytes written.
+ */
+ writeUInt8(value: number, offset?: number): number;
+ /**
+ * @alias Buffer.writeUInt8
+ * @since v14.9.0, v12.19.0
+ */
+ writeUint8(value: number, offset?: number): number;
+ /**
+ * Writes `value` to `buf` at the specified `offset` as little-endian. The `value`must be a valid unsigned 16-bit integer. Behavior is undefined when `value` is
+ * anything other than an unsigned 16-bit integer.
+ *
+ * This function is also available under the `writeUint16LE` alias.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.allocUnsafe(4);
+ *
+ * buf.writeUInt16LE(0xdead, 0);
+ * buf.writeUInt16LE(0xbeef, 2);
+ *
+ * console.log(buf);
+ * // Prints:
+ * ```
+ * @since v0.5.5
+ * @param value Number to be written to `buf`.
+ * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 2`.
+ * @return `offset` plus the number of bytes written.
+ */
+ writeUInt16LE(value: number, offset?: number): number;
+ /**
+ * @alias Buffer.writeUInt16LE
+ * @since v14.9.0, v12.19.0
+ */
+ writeUint16LE(value: number, offset?: number): number;
+ /**
+ * Writes `value` to `buf` at the specified `offset` as big-endian. The `value`must be a valid unsigned 16-bit integer. Behavior is undefined when `value`is anything other than an
+ * unsigned 16-bit integer.
+ *
+ * This function is also available under the `writeUint16BE` alias.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.allocUnsafe(4);
+ *
+ * buf.writeUInt16BE(0xdead, 0);
+ * buf.writeUInt16BE(0xbeef, 2);
+ *
+ * console.log(buf);
+ * // Prints:
+ * ```
+ * @since v0.5.5
+ * @param value Number to be written to `buf`.
+ * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 2`.
+ * @return `offset` plus the number of bytes written.
+ */
+ writeUInt16BE(value: number, offset?: number): number;
+ /**
+ * @alias Buffer.writeUInt16BE
+ * @since v14.9.0, v12.19.0
+ */
+ writeUint16BE(value: number, offset?: number): number;
+ /**
+ * Writes `value` to `buf` at the specified `offset` as little-endian. The `value`must be a valid unsigned 32-bit integer. Behavior is undefined when `value` is
+ * anything other than an unsigned 32-bit integer.
+ *
+ * This function is also available under the `writeUint32LE` alias.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.allocUnsafe(4);
+ *
+ * buf.writeUInt32LE(0xfeedface, 0);
+ *
+ * console.log(buf);
+ * // Prints:
+ * ```
+ * @since v0.5.5
+ * @param value Number to be written to `buf`.
+ * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 4`.
+ * @return `offset` plus the number of bytes written.
+ */
+ writeUInt32LE(value: number, offset?: number): number;
+ /**
+ * @alias Buffer.writeUInt32LE
+ * @since v14.9.0, v12.19.0
+ */
+ writeUint32LE(value: number, offset?: number): number;
+ /**
+ * Writes `value` to `buf` at the specified `offset` as big-endian. The `value`must be a valid unsigned 32-bit integer. Behavior is undefined when `value`is anything other than an
+ * unsigned 32-bit integer.
+ *
+ * This function is also available under the `writeUint32BE` alias.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.allocUnsafe(4);
+ *
+ * buf.writeUInt32BE(0xfeedface, 0);
+ *
+ * console.log(buf);
+ * // Prints:
+ * ```
+ * @since v0.5.5
+ * @param value Number to be written to `buf`.
+ * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 4`.
+ * @return `offset` plus the number of bytes written.
+ */
+ writeUInt32BE(value: number, offset?: number): number;
+ /**
+ * @alias Buffer.writeUInt32BE
+ * @since v14.9.0, v12.19.0
+ */
+ writeUint32BE(value: number, offset?: number): number;
+ /**
+ * Writes `value` to `buf` at the specified `offset`. `value` must be a valid
+ * signed 8-bit integer. Behavior is undefined when `value` is anything other than
+ * a signed 8-bit integer.
+ *
+ * `value` is interpreted and written as a two's complement signed integer.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.allocUnsafe(2);
+ *
+ * buf.writeInt8(2, 0);
+ * buf.writeInt8(-2, 1);
+ *
+ * console.log(buf);
+ * // Prints:
+ * ```
+ * @since v0.5.0
+ * @param value Number to be written to `buf`.
+ * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 1`.
+ * @return `offset` plus the number of bytes written.
+ */
+ writeInt8(value: number, offset?: number): number;
+ /**
+ * Writes `value` to `buf` at the specified `offset` as little-endian. The `value`must be a valid signed 16-bit integer. Behavior is undefined when `value` is
+ * anything other than a signed 16-bit integer.
+ *
+ * The `value` is interpreted and written as a two's complement signed integer.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.allocUnsafe(2);
+ *
+ * buf.writeInt16LE(0x0304, 0);
+ *
+ * console.log(buf);
+ * // Prints:
+ * ```
+ * @since v0.5.5
+ * @param value Number to be written to `buf`.
+ * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 2`.
+ * @return `offset` plus the number of bytes written.
+ */
+ writeInt16LE(value: number, offset?: number): number;
+ /**
+ * Writes `value` to `buf` at the specified `offset` as big-endian. The `value`must be a valid signed 16-bit integer. Behavior is undefined when `value` is
+ * anything other than a signed 16-bit integer.
+ *
+ * The `value` is interpreted and written as a two's complement signed integer.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.allocUnsafe(2);
+ *
+ * buf.writeInt16BE(0x0102, 0);
+ *
+ * console.log(buf);
+ * // Prints:
+ * ```
+ * @since v0.5.5
+ * @param value Number to be written to `buf`.
+ * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 2`.
+ * @return `offset` plus the number of bytes written.
+ */
+ writeInt16BE(value: number, offset?: number): number;
+ /**
+ * Writes `value` to `buf` at the specified `offset` as little-endian. The `value`must be a valid signed 32-bit integer. Behavior is undefined when `value` is
+ * anything other than a signed 32-bit integer.
+ *
+ * The `value` is interpreted and written as a two's complement signed integer.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.allocUnsafe(4);
+ *
+ * buf.writeInt32LE(0x05060708, 0);
+ *
+ * console.log(buf);
+ * // Prints:
+ * ```
+ * @since v0.5.5
+ * @param value Number to be written to `buf`.
+ * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 4`.
+ * @return `offset` plus the number of bytes written.
+ */
+ writeInt32LE(value: number, offset?: number): number;
+ /**
+ * Writes `value` to `buf` at the specified `offset` as big-endian. The `value`must be a valid signed 32-bit integer. Behavior is undefined when `value` is
+ * anything other than a signed 32-bit integer.
+ *
+ * The `value` is interpreted and written as a two's complement signed integer.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.allocUnsafe(4);
+ *
+ * buf.writeInt32BE(0x01020304, 0);
+ *
+ * console.log(buf);
+ * // Prints:
+ * ```
+ * @since v0.5.5
+ * @param value Number to be written to `buf`.
+ * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 4`.
+ * @return `offset` plus the number of bytes written.
+ */
+ writeInt32BE(value: number, offset?: number): number;
+ /**
+ * Writes `value` to `buf` at the specified `offset` as little-endian. Behavior is
+ * undefined when `value` is anything other than a JavaScript number.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.allocUnsafe(4);
+ *
+ * buf.writeFloatLE(0xcafebabe, 0);
+ *
+ * console.log(buf);
+ * // Prints:
+ * ```
+ * @since v0.11.15
+ * @param value Number to be written to `buf`.
+ * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 4`.
+ * @return `offset` plus the number of bytes written.
+ */
+ writeFloatLE(value: number, offset?: number): number;
+ /**
+ * Writes `value` to `buf` at the specified `offset` as big-endian. Behavior is
+ * undefined when `value` is anything other than a JavaScript number.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.allocUnsafe(4);
+ *
+ * buf.writeFloatBE(0xcafebabe, 0);
+ *
+ * console.log(buf);
+ * // Prints:
+ * ```
+ * @since v0.11.15
+ * @param value Number to be written to `buf`.
+ * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 4`.
+ * @return `offset` plus the number of bytes written.
+ */
+ writeFloatBE(value: number, offset?: number): number;
+ /**
+ * Writes `value` to `buf` at the specified `offset` as little-endian. The `value`must be a JavaScript number. Behavior is undefined when `value` is anything
+ * other than a JavaScript number.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.allocUnsafe(8);
+ *
+ * buf.writeDoubleLE(123.456, 0);
+ *
+ * console.log(buf);
+ * // Prints:
+ * ```
+ * @since v0.11.15
+ * @param value Number to be written to `buf`.
+ * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 8`.
+ * @return `offset` plus the number of bytes written.
+ */
+ writeDoubleLE(value: number, offset?: number): number;
+ /**
+ * Writes `value` to `buf` at the specified `offset` as big-endian. The `value`must be a JavaScript number. Behavior is undefined when `value` is anything
+ * other than a JavaScript number.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.allocUnsafe(8);
+ *
+ * buf.writeDoubleBE(123.456, 0);
+ *
+ * console.log(buf);
+ * // Prints:
+ * ```
+ * @since v0.11.15
+ * @param value Number to be written to `buf`.
+ * @param [offset=0] Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 8`.
+ * @return `offset` plus the number of bytes written.
+ */
+ writeDoubleBE(value: number, offset?: number): number;
+ /**
+ * Fills `buf` with the specified `value`. If the `offset` and `end` are not given,
+ * the entire `buf` will be filled:
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * // Fill a `Buffer` with the ASCII character 'h'.
+ *
+ * const b = Buffer.allocUnsafe(50).fill('h');
+ *
+ * console.log(b.toString());
+ * // Prints: hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh
+ * ```
+ *
+ * `value` is coerced to a `uint32` value if it is not a string, `Buffer`, or
+ * integer. If the resulting integer is greater than `255` (decimal), `buf` will be
+ * filled with `value & 255`.
+ *
+ * If the final write of a `fill()` operation falls on a multi-byte character,
+ * then only the bytes of that character that fit into `buf` are written:
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * // Fill a `Buffer` with character that takes up two bytes in UTF-8.
+ *
+ * console.log(Buffer.allocUnsafe(5).fill('\u0222'));
+ * // Prints:
+ * ```
+ *
+ * If `value` contains invalid characters, it is truncated; if no valid
+ * fill data remains, an exception is thrown:
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.allocUnsafe(5);
+ *
+ * console.log(buf.fill('a'));
+ * // Prints:
+ * console.log(buf.fill('aazz', 'hex'));
+ * // Prints:
+ * console.log(buf.fill('zz', 'hex'));
+ * // Throws an exception.
+ * ```
+ * @since v0.5.0
+ * @param value The value with which to fill `buf`.
+ * @param [offset=0] Number of bytes to skip before starting to fill `buf`.
+ * @param [end=buf.length] Where to stop filling `buf` (not inclusive).
+ * @param [encoding='utf8'] The encoding for `value` if `value` is a string.
+ * @return A reference to `buf`.
+ */
+ fill(value: string | Uint8Array | number, offset?: number, end?: number, encoding?: BufferEncoding): this;
+ /**
+ * If `value` is:
+ *
+ * * a string, `value` is interpreted according to the character encoding in`encoding`.
+ * * a `Buffer` or [`Uint8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array), `value` will be used in its entirety.
+ * To compare a partial `Buffer`, use `buf.slice()`.
+ * * a number, `value` will be interpreted as an unsigned 8-bit integer
+ * value between `0` and `255`.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.from('this is a buffer');
+ *
+ * console.log(buf.indexOf('this'));
+ * // Prints: 0
+ * console.log(buf.indexOf('is'));
+ * // Prints: 2
+ * console.log(buf.indexOf(Buffer.from('a buffer')));
+ * // Prints: 8
+ * console.log(buf.indexOf(97));
+ * // Prints: 8 (97 is the decimal ASCII value for 'a')
+ * console.log(buf.indexOf(Buffer.from('a buffer example')));
+ * // Prints: -1
+ * console.log(buf.indexOf(Buffer.from('a buffer example').slice(0, 8)));
+ * // Prints: 8
+ *
+ * const utf16Buffer = Buffer.from('\u039a\u0391\u03a3\u03a3\u0395', 'utf16le');
+ *
+ * console.log(utf16Buffer.indexOf('\u03a3', 0, 'utf16le'));
+ * // Prints: 4
+ * console.log(utf16Buffer.indexOf('\u03a3', -4, 'utf16le'));
+ * // Prints: 6
+ * ```
+ *
+ * If `value` is not a string, number, or `Buffer`, this method will throw a`TypeError`. If `value` is a number, it will be coerced to a valid byte value,
+ * an integer between 0 and 255.
+ *
+ * If `byteOffset` is not a number, it will be coerced to a number. If the result
+ * of coercion is `NaN` or `0`, then the entire buffer will be searched. This
+ * behavior matches [`String.prototype.indexOf()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/indexOf).
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const b = Buffer.from('abcdef');
+ *
+ * // Passing a value that's a number, but not a valid byte.
+ * // Prints: 2, equivalent to searching for 99 or 'c'.
+ * console.log(b.indexOf(99.9));
+ * console.log(b.indexOf(256 + 99));
+ *
+ * // Passing a byteOffset that coerces to NaN or 0.
+ * // Prints: 1, searching the whole buffer.
+ * console.log(b.indexOf('b', undefined));
+ * console.log(b.indexOf('b', {}));
+ * console.log(b.indexOf('b', null));
+ * console.log(b.indexOf('b', []));
+ * ```
+ *
+ * If `value` is an empty string or empty `Buffer` and `byteOffset` is less
+ * than `buf.length`, `byteOffset` will be returned. If `value` is empty and`byteOffset` is at least `buf.length`, `buf.length` will be returned.
+ * @since v1.5.0
+ * @param value What to search for.
+ * @param [byteOffset=0] Where to begin searching in `buf`. If negative, then offset is calculated from the end of `buf`.
+ * @param [encoding='utf8'] If `value` is a string, this is the encoding used to determine the binary representation of the string that will be searched for in `buf`.
+ * @return The index of the first occurrence of `value` in `buf`, or `-1` if `buf` does not contain `value`.
+ */
+ indexOf(value: string | number | Uint8Array, byteOffset?: number, encoding?: BufferEncoding): number;
+ /**
+ * Identical to `buf.indexOf()`, except the last occurrence of `value` is found
+ * rather than the first occurrence.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.from('this buffer is a buffer');
+ *
+ * console.log(buf.lastIndexOf('this'));
+ * // Prints: 0
+ * console.log(buf.lastIndexOf('buffer'));
+ * // Prints: 17
+ * console.log(buf.lastIndexOf(Buffer.from('buffer')));
+ * // Prints: 17
+ * console.log(buf.lastIndexOf(97));
+ * // Prints: 15 (97 is the decimal ASCII value for 'a')
+ * console.log(buf.lastIndexOf(Buffer.from('yolo')));
+ * // Prints: -1
+ * console.log(buf.lastIndexOf('buffer', 5));
+ * // Prints: 5
+ * console.log(buf.lastIndexOf('buffer', 4));
+ * // Prints: -1
+ *
+ * const utf16Buffer = Buffer.from('\u039a\u0391\u03a3\u03a3\u0395', 'utf16le');
+ *
+ * console.log(utf16Buffer.lastIndexOf('\u03a3', undefined, 'utf16le'));
+ * // Prints: 6
+ * console.log(utf16Buffer.lastIndexOf('\u03a3', -5, 'utf16le'));
+ * // Prints: 4
+ * ```
+ *
+ * If `value` is not a string, number, or `Buffer`, this method will throw a`TypeError`. If `value` is a number, it will be coerced to a valid byte value,
+ * an integer between 0 and 255.
+ *
+ * If `byteOffset` is not a number, it will be coerced to a number. Any arguments
+ * that coerce to `NaN`, like `{}` or `undefined`, will search the whole buffer.
+ * This behavior matches [`String.prototype.lastIndexOf()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/lastIndexOf).
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const b = Buffer.from('abcdef');
+ *
+ * // Passing a value that's a number, but not a valid byte.
+ * // Prints: 2, equivalent to searching for 99 or 'c'.
+ * console.log(b.lastIndexOf(99.9));
+ * console.log(b.lastIndexOf(256 + 99));
+ *
+ * // Passing a byteOffset that coerces to NaN.
+ * // Prints: 1, searching the whole buffer.
+ * console.log(b.lastIndexOf('b', undefined));
+ * console.log(b.lastIndexOf('b', {}));
+ *
+ * // Passing a byteOffset that coerces to 0.
+ * // Prints: -1, equivalent to passing 0.
+ * console.log(b.lastIndexOf('b', null));
+ * console.log(b.lastIndexOf('b', []));
+ * ```
+ *
+ * If `value` is an empty string or empty `Buffer`, `byteOffset` will be returned.
+ * @since v6.0.0
+ * @param value What to search for.
+ * @param [byteOffset=buf.length - 1] Where to begin searching in `buf`. If negative, then offset is calculated from the end of `buf`.
+ * @param [encoding='utf8'] If `value` is a string, this is the encoding used to determine the binary representation of the string that will be searched for in `buf`.
+ * @return The index of the last occurrence of `value` in `buf`, or `-1` if `buf` does not contain `value`.
+ */
+ lastIndexOf(value: string | number | Uint8Array, byteOffset?: number, encoding?: BufferEncoding): number;
+ /**
+ * Creates and returns an [iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols) of `[index, byte]` pairs from the contents
+ * of `buf`.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * // Log the entire contents of a `Buffer`.
+ *
+ * const buf = Buffer.from('buffer');
+ *
+ * for (const pair of buf.entries()) {
+ * console.log(pair);
+ * }
+ * // Prints:
+ * // [0, 98]
+ * // [1, 117]
+ * // [2, 102]
+ * // [3, 102]
+ * // [4, 101]
+ * // [5, 114]
+ * ```
+ * @since v1.1.0
+ */
+ entries(): IterableIterator<[number, number]>;
+ /**
+ * Equivalent to `buf.indexOf() !== -1`.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.from('this is a buffer');
+ *
+ * console.log(buf.includes('this'));
+ * // Prints: true
+ * console.log(buf.includes('is'));
+ * // Prints: true
+ * console.log(buf.includes(Buffer.from('a buffer')));
+ * // Prints: true
+ * console.log(buf.includes(97));
+ * // Prints: true (97 is the decimal ASCII value for 'a')
+ * console.log(buf.includes(Buffer.from('a buffer example')));
+ * // Prints: false
+ * console.log(buf.includes(Buffer.from('a buffer example').slice(0, 8)));
+ * // Prints: true
+ * console.log(buf.includes('this', 4));
+ * // Prints: false
+ * ```
+ * @since v5.3.0
+ * @param value What to search for.
+ * @param [byteOffset=0] Where to begin searching in `buf`. If negative, then offset is calculated from the end of `buf`.
+ * @param [encoding='utf8'] If `value` is a string, this is its encoding.
+ * @return `true` if `value` was found in `buf`, `false` otherwise.
+ */
+ includes(value: string | number | Buffer, byteOffset?: number, encoding?: BufferEncoding): boolean;
+ /**
+ * Creates and returns an [iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols) of `buf` keys (indices).
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.from('buffer');
+ *
+ * for (const key of buf.keys()) {
+ * console.log(key);
+ * }
+ * // Prints:
+ * // 0
+ * // 1
+ * // 2
+ * // 3
+ * // 4
+ * // 5
+ * ```
+ * @since v1.1.0
+ */
+ keys(): IterableIterator;
+ /**
+ * Creates and returns an [iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols) for `buf` values (bytes). This function is
+ * called automatically when a `Buffer` is used in a `for..of` statement.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ *
+ * const buf = Buffer.from('buffer');
+ *
+ * for (const value of buf.values()) {
+ * console.log(value);
+ * }
+ * // Prints:
+ * // 98
+ * // 117
+ * // 102
+ * // 102
+ * // 101
+ * // 114
+ *
+ * for (const value of buf) {
+ * console.log(value);
+ * }
+ * // Prints:
+ * // 98
+ * // 117
+ * // 102
+ * // 102
+ * // 101
+ * // 114
+ * ```
+ * @since v1.1.0
+ */
+ values(): IterableIterator;
+ }
+ var Buffer: BufferConstructor;
+ /**
+ * Decodes a string of Base64-encoded data into bytes, and encodes those bytes
+ * into a string using Latin-1 (ISO-8859-1).
+ *
+ * The `data` may be any JavaScript-value that can be coerced into a string.
+ *
+ * **This function is only provided for compatibility with legacy web platform APIs**
+ * **and should never be used in new code, because they use strings to represent**
+ * **binary data and predate the introduction of typed arrays in JavaScript.**
+ * **For code running using Node.js APIs, converting between base64-encoded strings**
+ * **and binary data should be performed using `Buffer.from(str, 'base64')` and`buf.toString('base64')`.**
+ * @since v15.13.0
+ * @deprecated Use `Buffer.from(data, 'base64')` instead.
+ * @param data The Base64-encoded input string.
+ */
+ function atob(data: string): string;
+ /**
+ * Decodes a string into bytes using Latin-1 (ISO-8859), and encodes those bytes
+ * into a string using Base64.
+ *
+ * The `data` may be any JavaScript-value that can be coerced into a string.
+ *
+ * **This function is only provided for compatibility with legacy web platform APIs**
+ * **and should never be used in new code, because they use strings to represent**
+ * **binary data and predate the introduction of typed arrays in JavaScript.**
+ * **For code running using Node.js APIs, converting between base64-encoded strings**
+ * **and binary data should be performed using `Buffer.from(str, 'base64')` and`buf.toString('base64')`.**
+ * @since v15.13.0
+ * @deprecated Use `buf.toString('base64')` instead.
+ * @param data An ASCII (Latin1) string.
+ */
+ function btoa(data: string): string;
}
-
- export { BuffType as Buffer };
}
declare module 'node:buffer' {
export * from 'buffer';
diff --git a/packages/node_modules/@node-red/editor-client/src/types/node/child_process.d.ts b/packages/node_modules/@node-red/editor-client/src/types/node/child_process.d.ts
index a56583b28..d79c74a3b 100644
--- a/packages/node_modules/@node-red/editor-client/src/types/node/child_process.d.ts
+++ b/packages/node_modules/@node-red/editor-client/src/types/node/child_process.d.ts
@@ -1,42 +1,518 @@
/* NOTE: Do not edit directly! This file is generated using `npm run update-types` in https://github.com/Steve-Mcl/monaco-editor-esm-i18n */
+/**
+ * The `child_process` module provides the ability to spawn subprocesses in
+ * a manner that is similar, but not identical, to [`popen(3)`](http://man7.org/linux/man-pages/man3/popen.3.html). This capability
+ * is primarily provided by the {@link spawn} function:
+ *
+ * ```js
+ * const { spawn } = require('child_process');
+ * const ls = spawn('ls', ['-lh', '/usr']);
+ *
+ * ls.stdout.on('data', (data) => {
+ * console.log(`stdout: ${data}`);
+ * });
+ *
+ * ls.stderr.on('data', (data) => {
+ * console.error(`stderr: ${data}`);
+ * });
+ *
+ * ls.on('close', (code) => {
+ * console.log(`child process exited with code ${code}`);
+ * });
+ * ```
+ *
+ * By default, pipes for `stdin`, `stdout`, and `stderr` are established between
+ * the parent Node.js process and the spawned subprocess. These pipes have
+ * limited (and platform-specific) capacity. If the subprocess writes to
+ * stdout in excess of that limit without the output being captured, the
+ * subprocess blocks waiting for the pipe buffer to accept more data. This is
+ * identical to the behavior of pipes in the shell. Use the `{ stdio: 'ignore' }`option if the output will not be consumed.
+ *
+ * The command lookup is performed using the `options.env.PATH` environment
+ * variable if it is in the `options` object. Otherwise, `process.env.PATH` is
+ * used.
+ *
+ * On Windows, environment variables are case-insensitive. Node.js
+ * lexicographically sorts the `env` keys and uses the first one that
+ * case-insensitively matches. Only first (in lexicographic order) entry will be
+ * passed to the subprocess. This might lead to issues on Windows when passing
+ * objects to the `env` option that have multiple variants of the same key, such as`PATH` and `Path`.
+ *
+ * The {@link spawn} method spawns the child process asynchronously,
+ * without blocking the Node.js event loop. The {@link spawnSync} function provides equivalent functionality in a synchronous manner that blocks
+ * the event loop until the spawned process either exits or is terminated.
+ *
+ * For convenience, the `child_process` module provides a handful of synchronous
+ * and asynchronous alternatives to {@link spawn} and {@link spawnSync}. Each of these alternatives are implemented on
+ * top of {@link spawn} or {@link spawnSync}.
+ *
+ * * {@link exec}: spawns a shell and runs a command within that
+ * shell, passing the `stdout` and `stderr` to a callback function when
+ * complete.
+ * * {@link execFile}: similar to {@link exec} except
+ * that it spawns the command directly without first spawning a shell by
+ * default.
+ * * {@link fork}: spawns a new Node.js process and invokes a
+ * specified module with an IPC communication channel established that allows
+ * sending messages between parent and child.
+ * * {@link execSync}: a synchronous version of {@link exec} that will block the Node.js event loop.
+ * * {@link execFileSync}: a synchronous version of {@link execFile} that will block the Node.js event loop.
+ *
+ * For certain use cases, such as automating shell scripts, the `synchronous counterparts` may be more convenient. In many cases, however,
+ * the synchronous methods can have significant impact on performance due to
+ * stalling the event loop while spawned processes complete.
+ * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/child_process.js)
+ */
declare module 'child_process' {
- import { BaseEncodingOptions } from 'fs';
- import * as events from 'events';
- import * as net from 'net';
- import { Writable, Readable, Stream, Pipe } from 'stream';
-
- type Serializable = string | object | number | boolean;
+ import { ObjectEncodingOptions } from 'node:fs';
+ import { EventEmitter, Abortable } from 'node:events';
+ import * as net from 'node:net';
+ import { Writable, Readable, Stream, Pipe } from 'node:stream';
+ import { URL } from 'node:url';
+ type Serializable = string | object | number | boolean | bigint;
type SendHandle = net.Socket | net.Server;
-
- interface ChildProcess extends events.EventEmitter {
+ /**
+ * Instances of the `ChildProcess` represent spawned child processes.
+ *
+ * Instances of `ChildProcess` are not intended to be created directly. Rather,
+ * use the {@link spawn}, {@link exec},{@link execFile}, or {@link fork} methods to create
+ * instances of `ChildProcess`.
+ * @since v2.2.0
+ */
+ class ChildProcess extends EventEmitter {
+ /**
+ * A `Writable Stream` that represents the child process's `stdin`.
+ *
+ * If a child process waits to read all of its input, the child will not continue
+ * until this stream has been closed via `end()`.
+ *
+ * If the child was spawned with `stdio[0]` set to anything other than `'pipe'`,
+ * then this will be `null`.
+ *
+ * `subprocess.stdin` is an alias for `subprocess.stdio[0]`. Both properties will
+ * refer to the same value.
+ *
+ * The `subprocess.stdin` property can be `undefined` if the child process could
+ * not be successfully spawned.
+ * @since v0.1.90
+ */
stdin: Writable | null;
+ /**
+ * A `Readable Stream` that represents the child process's `stdout`.
+ *
+ * If the child was spawned with `stdio[1]` set to anything other than `'pipe'`,
+ * then this will be `null`.
+ *
+ * `subprocess.stdout` is an alias for `subprocess.stdio[1]`. Both properties will
+ * refer to the same value.
+ *
+ * ```js
+ * const { spawn } = require('child_process');
+ *
+ * const subprocess = spawn('ls');
+ *
+ * subprocess.stdout.on('data', (data) => {
+ * console.log(`Received chunk ${data}`);
+ * });
+ * ```
+ *
+ * The `subprocess.stdout` property can be `null` if the child process could
+ * not be successfully spawned.
+ * @since v0.1.90
+ */
stdout: Readable | null;
+ /**
+ * A `Readable Stream` that represents the child process's `stderr`.
+ *
+ * If the child was spawned with `stdio[2]` set to anything other than `'pipe'`,
+ * then this will be `null`.
+ *
+ * `subprocess.stderr` is an alias for `subprocess.stdio[2]`. Both properties will
+ * refer to the same value.
+ *
+ * The `subprocess.stderr` property can be `null` if the child process could
+ * not be successfully spawned.
+ * @since v0.1.90
+ */
stderr: Readable | null;
+ /**
+ * The `subprocess.channel` property is a reference to the child's IPC channel. If
+ * no IPC channel currently exists, this property is `undefined`.
+ * @since v7.1.0
+ */
readonly channel?: Pipe | null | undefined;
+ /**
+ * A sparse array of pipes to the child process, corresponding with positions in
+ * the `stdio` option passed to {@link spawn} that have been set
+ * to the value `'pipe'`. `subprocess.stdio[0]`, `subprocess.stdio[1]`, and`subprocess.stdio[2]` are also available as `subprocess.stdin`,`subprocess.stdout`, and `subprocess.stderr`,
+ * respectively.
+ *
+ * In the following example, only the child's fd `1` (stdout) is configured as a
+ * pipe, so only the parent's `subprocess.stdio[1]` is a stream, all other values
+ * in the array are `null`.
+ *
+ * ```js
+ * const assert = require('assert');
+ * const fs = require('fs');
+ * const child_process = require('child_process');
+ *
+ * const subprocess = child_process.spawn('ls', {
+ * stdio: [
+ * 0, // Use parent's stdin for child.
+ * 'pipe', // Pipe child's stdout to parent.
+ * fs.openSync('err.out', 'w'), // Direct child's stderr to a file.
+ * ]
+ * });
+ *
+ * assert.strictEqual(subprocess.stdio[0], null);
+ * assert.strictEqual(subprocess.stdio[0], subprocess.stdin);
+ *
+ * assert(subprocess.stdout);
+ * assert.strictEqual(subprocess.stdio[1], subprocess.stdout);
+ *
+ * assert.strictEqual(subprocess.stdio[2], null);
+ * assert.strictEqual(subprocess.stdio[2], subprocess.stderr);
+ * ```
+ *
+ * The `subprocess.stdio` property can be `undefined` if the child process could
+ * not be successfully spawned.
+ * @since v0.7.10
+ */
readonly stdio: [
- Writable | null, // stdin
- Readable | null, // stdout
- Readable | null, // stderr
- Readable | Writable | null | undefined, // extra
+ Writable | null,
+ // stdin
+ Readable | null,
+ // stdout
+ Readable | null,
+ // stderr
+ Readable | Writable | null | undefined,
+ // extra
Readable | Writable | null | undefined // extra
];
+ /**
+ * The `subprocess.killed` property indicates whether the child process
+ * successfully received a signal from `subprocess.kill()`. The `killed` property
+ * does not indicate that the child process has been terminated.
+ * @since v0.5.10
+ */
readonly killed: boolean;
- readonly pid: number;
+ /**
+ * Returns the process identifier (PID) of the child process. If the child process
+ * fails to spawn due to errors, then the value is `undefined` and `error` is
+ * emitted.
+ *
+ * ```js
+ * const { spawn } = require('child_process');
+ * const grep = spawn('grep', ['ssh']);
+ *
+ * console.log(`Spawned child pid: ${grep.pid}`);
+ * grep.stdin.end();
+ * ```
+ * @since v0.1.90
+ */
+ readonly pid?: number | undefined;
+ /**
+ * The `subprocess.connected` property indicates whether it is still possible to
+ * send and receive messages from a child process. When `subprocess.connected` is`false`, it is no longer possible to send or receive messages.
+ * @since v0.7.2
+ */
readonly connected: boolean;
+ /**
+ * The `subprocess.exitCode` property indicates the exit code of the child process.
+ * If the child process is still running, the field will be `null`.
+ */
readonly exitCode: number | null;
+ /**
+ * The `subprocess.signalCode` property indicates the signal received by
+ * the child process if any, else `null`.
+ */
readonly signalCode: NodeJS.Signals | null;
+ /**
+ * The `subprocess.spawnargs` property represents the full list of command-line
+ * arguments the child process was launched with.
+ */
readonly spawnargs: string[];
+ /**
+ * The `subprocess.spawnfile` property indicates the executable file name of
+ * the child process that is launched.
+ *
+ * For {@link fork}, its value will be equal to `process.execPath`.
+ * For {@link spawn}, its value will be the name of
+ * the executable file.
+ * For {@link exec}, its value will be the name of the shell
+ * in which the child process is launched.
+ */
readonly spawnfile: string;
+ /**
+ * The `subprocess.kill()` method sends a signal to the child process. If no
+ * argument is given, the process will be sent the `'SIGTERM'` signal. See [`signal(7)`](http://man7.org/linux/man-pages/man7/signal.7.html) for a list of available signals. This function
+ * returns `true` if [`kill(2)`](http://man7.org/linux/man-pages/man2/kill.2.html) succeeds, and `false` otherwise.
+ *
+ * ```js
+ * const { spawn } = require('child_process');
+ * const grep = spawn('grep', ['ssh']);
+ *
+ * grep.on('close', (code, signal) => {
+ * console.log(
+ * `child process terminated due to receipt of signal ${signal}`);
+ * });
+ *
+ * // Send SIGHUP to process.
+ * grep.kill('SIGHUP');
+ * ```
+ *
+ * The `ChildProcess` object may emit an `'error'` event if the signal
+ * cannot be delivered. Sending a signal to a child process that has already exited
+ * is not an error but may have unforeseen consequences. Specifically, if the
+ * process identifier (PID) has been reassigned to another process, the signal will
+ * be delivered to that process instead which can have unexpected results.
+ *
+ * While the function is called `kill`, the signal delivered to the child process
+ * may not actually terminate the process.
+ *
+ * See [`kill(2)`](http://man7.org/linux/man-pages/man2/kill.2.html) for reference.
+ *
+ * On Windows, where POSIX signals do not exist, the `signal` argument will be
+ * ignored, and the process will be killed forcefully and abruptly (similar to`'SIGKILL'`).
+ * See `Signal Events` for more details.
+ *
+ * On Linux, child processes of child processes will not be terminated
+ * when attempting to kill their parent. This is likely to happen when running a
+ * new process in a shell or with the use of the `shell` option of `ChildProcess`:
+ *
+ * ```js
+ * 'use strict';
+ * const { spawn } = require('child_process');
+ *
+ * const subprocess = spawn(
+ * 'sh',
+ * [
+ * '-c',
+ * `node -e "setInterval(() => {
+ * console.log(process.pid, 'is alive')
+ * }, 500);"`,
+ * ], {
+ * stdio: ['inherit', 'inherit', 'inherit']
+ * }
+ * );
+ *
+ * setTimeout(() => {
+ * subprocess.kill(); // Does not terminate the Node.js process in the shell.
+ * }, 2000);
+ * ```
+ * @since v0.1.90
+ */
kill(signal?: NodeJS.Signals | number): boolean;
+ /**
+ * When an IPC channel has been established between the parent and child (
+ * i.e. when using {@link fork}), the `subprocess.send()` method can
+ * be used to send messages to the child process. When the child process is a
+ * Node.js instance, these messages can be received via the `'message'` event.
+ *
+ * The message goes through serialization and parsing. The resulting
+ * message might not be the same as what is originally sent.
+ *
+ * For example, in the parent script:
+ *
+ * ```js
+ * const cp = require('child_process');
+ * const n = cp.fork(`${__dirname}/sub.js`);
+ *
+ * n.on('message', (m) => {
+ * console.log('PARENT got message:', m);
+ * });
+ *
+ * // Causes the child to print: CHILD got message: { hello: 'world' }
+ * n.send({ hello: 'world' });
+ * ```
+ *
+ * And then the child script, `'sub.js'` might look like this:
+ *
+ * ```js
+ * process.on('message', (m) => {
+ * console.log('CHILD got message:', m);
+ * });
+ *
+ * // Causes the parent to print: PARENT got message: { foo: 'bar', baz: null }
+ * process.send({ foo: 'bar', baz: NaN });
+ * ```
+ *
+ * Child Node.js processes will have a `process.send()` method of their own
+ * that allows the child to send messages back to the parent.
+ *
+ * There is a special case when sending a `{cmd: 'NODE_foo'}` message. Messages
+ * containing a `NODE_` prefix in the `cmd` property are reserved for use within
+ * Node.js core and will not be emitted in the child's `'message'` event. Rather, such messages are emitted using the`'internalMessage'` event and are consumed internally by Node.js.
+ * Applications should avoid using such messages or listening for`'internalMessage'` events as it is subject to change without notice.
+ *
+ * The optional `sendHandle` argument that may be passed to `subprocess.send()` is
+ * for passing a TCP server or socket object to the child process. The child will
+ * receive the object as the second argument passed to the callback function
+ * registered on the `'message'` event. Any data that is received
+ * and buffered in the socket will not be sent to the child.
+ *
+ * The optional `callback` is a function that is invoked after the message is
+ * sent but before the child may have received it. The function is called with a
+ * single argument: `null` on success, or an `Error` object on failure.
+ *
+ * If no `callback` function is provided and the message cannot be sent, an`'error'` event will be emitted by the `ChildProcess` object. This can
+ * happen, for instance, when the child process has already exited.
+ *
+ * `subprocess.send()` will return `false` if the channel has closed or when the
+ * backlog of unsent messages exceeds a threshold that makes it unwise to send
+ * more. Otherwise, the method returns `true`. The `callback` function can be
+ * used to implement flow control.
+ *
+ * #### Example: sending a server object
+ *
+ * The `sendHandle` argument can be used, for instance, to pass the handle of
+ * a TCP server object to the child process as illustrated in the example below:
+ *
+ * ```js
+ * const subprocess = require('child_process').fork('subprocess.js');
+ *
+ * // Open up the server object and send the handle.
+ * const server = require('net').createServer();
+ * server.on('connection', (socket) => {
+ * socket.end('handled by parent');
+ * });
+ * server.listen(1337, () => {
+ * subprocess.send('server', server);
+ * });
+ * ```
+ *
+ * The child would then receive the server object as:
+ *
+ * ```js
+ * process.on('message', (m, server) => {
+ * if (m === 'server') {
+ * server.on('connection', (socket) => {
+ * socket.end('handled by child');
+ * });
+ * }
+ * });
+ * ```
+ *
+ * Once the server is now shared between the parent and child, some connections
+ * can be handled by the parent and some by the child.
+ *
+ * While the example above uses a server created using the `net` module, `dgram`module servers use exactly the same workflow with the exceptions of listening on
+ * a `'message'` event instead of `'connection'` and using `server.bind()` instead
+ * of `server.listen()`. This is, however, currently only supported on Unix
+ * platforms.
+ *
+ * #### Example: sending a socket object
+ *
+ * Similarly, the `sendHandler` argument can be used to pass the handle of a
+ * socket to the child process. The example below spawns two children that each
+ * handle connections with "normal" or "special" priority:
+ *
+ * ```js
+ * const { fork } = require('child_process');
+ * const normal = fork('subprocess.js', ['normal']);
+ * const special = fork('subprocess.js', ['special']);
+ *
+ * // Open up the server and send sockets to child. Use pauseOnConnect to prevent
+ * // the sockets from being read before they are sent to the child process.
+ * const server = require('net').createServer({ pauseOnConnect: true });
+ * server.on('connection', (socket) => {
+ *
+ * // If this is special priority...
+ * if (socket.remoteAddress === '74.125.127.100') {
+ * special.send('socket', socket);
+ * return;
+ * }
+ * // This is normal priority.
+ * normal.send('socket', socket);
+ * });
+ * server.listen(1337);
+ * ```
+ *
+ * The `subprocess.js` would receive the socket handle as the second argument
+ * passed to the event callback function:
+ *
+ * ```js
+ * process.on('message', (m, socket) => {
+ * if (m === 'socket') {
+ * if (socket) {
+ * // Check that the client socket exists.
+ * // It is possible for the socket to be closed between the time it is
+ * // sent and the time it is received in the child process.
+ * socket.end(`Request handled with ${process.argv[2]} priority`);
+ * }
+ * }
+ * });
+ * ```
+ *
+ * Do not use `.maxConnections` on a socket that has been passed to a subprocess.
+ * The parent cannot track when the socket is destroyed.
+ *
+ * Any `'message'` handlers in the subprocess should verify that `socket` exists,
+ * as the connection may have been closed during the time it takes to send the
+ * connection to the child.
+ * @since v0.5.9
+ * @param options The `options` argument, if present, is an object used to parameterize the sending of certain types of handles. `options` supports the following properties:
+ */
send(message: Serializable, callback?: (error: Error | null) => void): boolean;
send(message: Serializable, sendHandle?: SendHandle, callback?: (error: Error | null) => void): boolean;
send(message: Serializable, sendHandle?: SendHandle, options?: MessageOptions, callback?: (error: Error | null) => void): boolean;
+ /**
+ * Closes the IPC channel between parent and child, allowing the child to exit
+ * gracefully once there are no other connections keeping it alive. After calling
+ * this method the `subprocess.connected` and `process.connected` properties in
+ * both the parent and child (respectively) will be set to `false`, and it will be
+ * no longer possible to pass messages between the processes.
+ *
+ * The `'disconnect'` event will be emitted when there are no messages in the
+ * process of being received. This will most often be triggered immediately after
+ * calling `subprocess.disconnect()`.
+ *
+ * When the child process is a Node.js instance (e.g. spawned using {@link fork}), the `process.disconnect()` method can be invoked
+ * within the child process to close the IPC channel as well.
+ * @since v0.7.2
+ */
disconnect(): void;
+ /**
+ * By default, the parent will wait for the detached child to exit. To prevent the
+ * parent from waiting for a given `subprocess` to exit, use the`subprocess.unref()` method. Doing so will cause the parent's event loop to not
+ * include the child in its reference count, allowing the parent to exit
+ * independently of the child, unless there is an established IPC channel between
+ * the child and the parent.
+ *
+ * ```js
+ * const { spawn } = require('child_process');
+ *
+ * const subprocess = spawn(process.argv[0], ['child_program.js'], {
+ * detached: true,
+ * stdio: 'ignore'
+ * });
+ *
+ * subprocess.unref();
+ * ```
+ * @since v0.7.10
+ */
unref(): void;
+ /**
+ * Calling `subprocess.ref()` after making a call to `subprocess.unref()` will
+ * restore the removed reference count for the child process, forcing the parent
+ * to wait for the child to exit before exiting itself.
+ *
+ * ```js
+ * const { spawn } = require('child_process');
+ *
+ * const subprocess = spawn(process.argv[0], ['child_program.js'], {
+ * detached: true,
+ * stdio: 'ignore'
+ * });
+ *
+ * subprocess.unref();
+ * subprocess.ref();
+ * ```
+ * @since v0.7.10
+ */
ref(): void;
-
/**
* events.EventEmitter
* 1. close
@@ -44,71 +520,68 @@ declare module 'child_process' {
* 3. error
* 4. exit
* 5. message
+ * 6. spawn
*/
-
addListener(event: string, listener: (...args: any[]) => void): this;
- addListener(event: "close", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
- addListener(event: "disconnect", listener: () => void): this;
- addListener(event: "error", listener: (err: Error) => void): this;
- addListener(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
- addListener(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this;
-
+ addListener(event: 'close', listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
+ addListener(event: 'disconnect', listener: () => void): this;
+ addListener(event: 'error', listener: (err: Error) => void): this;
+ addListener(event: 'exit', listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
+ addListener(event: 'message', listener: (message: Serializable, sendHandle: SendHandle) => void): this;
+ addListener(event: 'spawn', listener: () => void): this;
emit(event: string | symbol, ...args: any[]): boolean;
- emit(event: "close", code: number | null, signal: NodeJS.Signals | null): boolean;
- emit(event: "disconnect"): boolean;
- emit(event: "error", err: Error): boolean;
- emit(event: "exit", code: number | null, signal: NodeJS.Signals | null): boolean;
- emit(event: "message", message: Serializable, sendHandle: SendHandle): boolean;
-
+ emit(event: 'close', code: number | null, signal: NodeJS.Signals | null): boolean;
+ emit(event: 'disconnect'): boolean;
+ emit(event: 'error', err: Error): boolean;
+ emit(event: 'exit', code: number | null, signal: NodeJS.Signals | null): boolean;
+ emit(event: 'message', message: Serializable, sendHandle: SendHandle): boolean;
+ emit(event: 'spawn', listener: () => void): boolean;
on(event: string, listener: (...args: any[]) => void): this;
- on(event: "close", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
- on(event: "disconnect", listener: () => void): this;
- on(event: "error", listener: (err: Error) => void): this;
- on(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
- on(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this;
-
+ on(event: 'close', listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
+ on(event: 'disconnect', listener: () => void): this;
+ on(event: 'error', listener: (err: Error) => void): this;
+ on(event: 'exit', listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
+ on(event: 'message', listener: (message: Serializable, sendHandle: SendHandle) => void): this;
+ on(event: 'spawn', listener: () => void): this;
once(event: string, listener: (...args: any[]) => void): this;
- once(event: "close", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
- once(event: "disconnect", listener: () => void): this;
- once(event: "error", listener: (err: Error) => void): this;
- once(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
- once(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this;
-
+ once(event: 'close', listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
+ once(event: 'disconnect', listener: () => void): this;
+ once(event: 'error', listener: (err: Error) => void): this;
+ once(event: 'exit', listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
+ once(event: 'message', listener: (message: Serializable, sendHandle: SendHandle) => void): this;
+ once(event: 'spawn', listener: () => void): this;
prependListener(event: string, listener: (...args: any[]) => void): this;
- prependListener(event: "close", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
- prependListener(event: "disconnect", listener: () => void): this;
- prependListener(event: "error", listener: (err: Error) => void): this;
- prependListener(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
- prependListener(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this;
-
+ prependListener(event: 'close', listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
+ prependListener(event: 'disconnect', listener: () => void): this;
+ prependListener(event: 'error', listener: (err: Error) => void): this;
+ prependListener(event: 'exit', listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
+ prependListener(event: 'message', listener: (message: Serializable, sendHandle: SendHandle) => void): this;
+ prependListener(event: 'spawn', listener: () => void): this;
prependOnceListener(event: string, listener: (...args: any[]) => void): this;
- prependOnceListener(event: "close", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
- prependOnceListener(event: "disconnect", listener: () => void): this;
- prependOnceListener(event: "error", listener: (err: Error) => void): this;
- prependOnceListener(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
- prependOnceListener(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this;
+ prependOnceListener(event: 'close', listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
+ prependOnceListener(event: 'disconnect', listener: () => void): this;
+ prependOnceListener(event: 'error', listener: (err: Error) => void): this;
+ prependOnceListener(event: 'exit', listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
+ prependOnceListener(event: 'message', listener: (message: Serializable, sendHandle: SendHandle) => void): this;
+ prependOnceListener(event: 'spawn', listener: () => void): this;
}
-
// return this object when stdio option is undefined or not specified
interface ChildProcessWithoutNullStreams extends ChildProcess {
stdin: Writable;
stdout: Readable;
stderr: Readable;
readonly stdio: [
- Writable, // stdin
- Readable, // stdout
- Readable, // stderr
- Readable | Writable | null | undefined, // extra, no modification
+ Writable,
+ Readable,
+ Readable,
+ // stderr
+ Readable | Writable | null | undefined,
+ // extra, no modification
Readable | Writable | null | undefined // extra, no modification
];
}
-
// return this object when stdio option is a tuple of 3
- interface ChildProcessByStdio<
- I extends null | Writable,
- O extends null | Readable,
- E extends null | Readable,
- > extends ChildProcess {
+ interface ChildProcessByStdio extends ChildProcess {
stdin: I;
stdout: O;
stderr: E;
@@ -116,37 +589,42 @@ declare module 'child_process' {
I,
O,
E,
- Readable | Writable | null | undefined, // extra, no modification
+ Readable | Writable | null | undefined,
+ // extra, no modification
Readable | Writable | null | undefined // extra, no modification
];
}
-
interface MessageOptions {
keepOpen?: boolean | undefined;
}
-
- type StdioOptions = "pipe" | "ignore" | "inherit" | Array<("pipe" | "ipc" | "ignore" | "inherit" | Stream | number | null | undefined)>;
-
+ type IOType = 'overlapped' | 'pipe' | 'ignore' | 'inherit';
+ type StdioOptions = IOType | Array;
type SerializationType = 'json' | 'advanced';
-
- interface MessagingOptions {
+ interface MessagingOptions extends Abortable {
/**
* Specify the kind of serialization used for sending messages between processes.
* @default 'json'
*/
serialization?: SerializationType | undefined;
+ /**
+ * The signal value to be used when the spawned process will be killed by the abort signal.
+ * @default 'SIGTERM'
+ */
+ killSignal?: NodeJS.Signals | number | undefined;
+ /**
+ * In milliseconds the maximum amount of time the process is allowed to run.
+ */
+ timeout?: number | undefined;
}
-
interface ProcessEnvOptions {
uid?: number | undefined;
gid?: number | undefined;
- cwd?: string | undefined;
+ cwd?: string | URL | undefined;
env?: NodeJS.ProcessEnv | undefined;
}
-
interface CommonOptions extends ProcessEnvOptions {
/**
- * @default true
+ * @default false
*/
windowsHide?: boolean | undefined;
/**
@@ -154,183 +632,348 @@ declare module 'child_process' {
*/
timeout?: number | undefined;
}
-
- interface CommonSpawnOptions extends CommonOptions, MessagingOptions {
+ interface CommonSpawnOptions extends CommonOptions, MessagingOptions, Abortable {
argv0?: string | undefined;
stdio?: StdioOptions | undefined;
shell?: boolean | string | undefined;
windowsVerbatimArguments?: boolean | undefined;
}
-
interface SpawnOptions extends CommonSpawnOptions {
detached?: boolean | undefined;
}
-
interface SpawnOptionsWithoutStdio extends SpawnOptions {
- stdio?: 'pipe' | Array | undefined;
+ stdio?: StdioPipeNamed | StdioPipe[] | undefined;
}
-
type StdioNull = 'inherit' | 'ignore' | Stream;
- type StdioPipe = undefined | null | 'pipe';
-
- interface SpawnOptionsWithStdioTuple<
- Stdin extends StdioNull | StdioPipe,
- Stdout extends StdioNull | StdioPipe,
- Stderr extends StdioNull | StdioPipe,
- > extends SpawnOptions {
+ type StdioPipeNamed = 'pipe' | 'overlapped';
+ type StdioPipe = undefined | null | StdioPipeNamed;
+ interface SpawnOptionsWithStdioTuple extends SpawnOptions {
stdio: [Stdin, Stdout, Stderr];
}
-
- // overloads of spawn without 'args'
+ /**
+ * The `child_process.spawn()` method spawns a new process using the given`command`, with command-line arguments in `args`. If omitted, `args` defaults
+ * to an empty array.
+ *
+ * **If the `shell` option is enabled, do not pass unsanitized user input to this**
+ * **function. Any input containing shell metacharacters may be used to trigger**
+ * **arbitrary command execution.**
+ *
+ * A third argument may be used to specify additional options, with these defaults:
+ *
+ * ```js
+ * const defaults = {
+ * cwd: undefined,
+ * env: process.env
+ * };
+ * ```
+ *
+ * Use `cwd` to specify the working directory from which the process is spawned.
+ * If not given, the default is to inherit the current working directory. If given,
+ * but the path does not exist, the child process emits an `ENOENT` error
+ * and exits immediately. `ENOENT` is also emitted when the command
+ * does not exist.
+ *
+ * Use `env` to specify environment variables that will be visible to the new
+ * process, the default is `process.env`.
+ *
+ * `undefined` values in `env` will be ignored.
+ *
+ * Example of running `ls -lh /usr`, capturing `stdout`, `stderr`, and the
+ * exit code:
+ *
+ * ```js
+ * const { spawn } = require('child_process');
+ * const ls = spawn('ls', ['-lh', '/usr']);
+ *
+ * ls.stdout.on('data', (data) => {
+ * console.log(`stdout: ${data}`);
+ * });
+ *
+ * ls.stderr.on('data', (data) => {
+ * console.error(`stderr: ${data}`);
+ * });
+ *
+ * ls.on('close', (code) => {
+ * console.log(`child process exited with code ${code}`);
+ * });
+ * ```
+ *
+ * Example: A very elaborate way to run `ps ax | grep ssh`
+ *
+ * ```js
+ * const { spawn } = require('child_process');
+ * const ps = spawn('ps', ['ax']);
+ * const grep = spawn('grep', ['ssh']);
+ *
+ * ps.stdout.on('data', (data) => {
+ * grep.stdin.write(data);
+ * });
+ *
+ * ps.stderr.on('data', (data) => {
+ * console.error(`ps stderr: ${data}`);
+ * });
+ *
+ * ps.on('close', (code) => {
+ * if (code !== 0) {
+ * console.log(`ps process exited with code ${code}`);
+ * }
+ * grep.stdin.end();
+ * });
+ *
+ * grep.stdout.on('data', (data) => {
+ * console.log(data.toString());
+ * });
+ *
+ * grep.stderr.on('data', (data) => {
+ * console.error(`grep stderr: ${data}`);
+ * });
+ *
+ * grep.on('close', (code) => {
+ * if (code !== 0) {
+ * console.log(`grep process exited with code ${code}`);
+ * }
+ * });
+ * ```
+ *
+ * Example of checking for failed `spawn`:
+ *
+ * ```js
+ * const { spawn } = require('child_process');
+ * const subprocess = spawn('bad_command');
+ *
+ * subprocess.on('error', (err) => {
+ * console.error('Failed to start subprocess.');
+ * });
+ * ```
+ *
+ * Certain platforms (macOS, Linux) will use the value of `argv[0]` for the process
+ * title while others (Windows, SunOS) will use `command`.
+ *
+ * Node.js currently overwrites `argv[0]` with `process.execPath` on startup, so`process.argv[0]` in a Node.js child process will not match the `argv0`parameter passed to `spawn` from the parent,
+ * retrieve it with the`process.argv0` property instead.
+ *
+ * If the `signal` option is enabled, calling `.abort()` on the corresponding`AbortController` is similar to calling `.kill()` on the child process except
+ * the error passed to the callback will be an `AbortError`:
+ *
+ * ```js
+ * const { spawn } = require('child_process');
+ * const controller = new AbortController();
+ * const { signal } = controller;
+ * const grep = spawn('grep', ['ssh'], { signal });
+ * grep.on('error', (err) => {
+ * // This will be called with err being an AbortError if the controller aborts
+ * });
+ * controller.abort(); // Stops the child process
+ * ```
+ * @since v0.1.90
+ * @param command The command to run.
+ * @param args List of string arguments.
+ */
function spawn(command: string, options?: SpawnOptionsWithoutStdio): ChildProcessWithoutNullStreams;
-
- function spawn(
- command: string,
- options: SpawnOptionsWithStdioTuple,
- ): ChildProcessByStdio;
- function spawn(
- command: string,
- options: SpawnOptionsWithStdioTuple,
- ): ChildProcessByStdio;
- function spawn(
- command: string,
- options: SpawnOptionsWithStdioTuple,
- ): ChildProcessByStdio;
- function spawn(
- command: string,
- options: SpawnOptionsWithStdioTuple,
- ): ChildProcessByStdio;
- function spawn(
- command: string,
- options: SpawnOptionsWithStdioTuple,
- ): ChildProcessByStdio;
- function spawn(
- command: string,
- options: SpawnOptionsWithStdioTuple,
- ): ChildProcessByStdio;
- function spawn(
- command: string,
- options: SpawnOptionsWithStdioTuple,
- ): ChildProcessByStdio;
- function spawn(
- command: string,
- options: SpawnOptionsWithStdioTuple,
- ): ChildProcessByStdio;
-
+ function spawn(command: string, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio;
+ function spawn(command: string, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio;
+ function spawn(command: string, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio;
+ function spawn(command: string, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio;
+ function spawn(command: string, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio;
+ function spawn(command: string, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio;
+ function spawn(command: string, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio;
+ function spawn(command: string, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio;
function spawn(command: string, options: SpawnOptions): ChildProcess;
-
// overloads of spawn with 'args'
function spawn(command: string, args?: ReadonlyArray, options?: SpawnOptionsWithoutStdio): ChildProcessWithoutNullStreams;
-
- function spawn(
- command: string,
- args: ReadonlyArray,
- options: SpawnOptionsWithStdioTuple,
- ): ChildProcessByStdio;
- function spawn(
- command: string,
- args: ReadonlyArray,
- options: SpawnOptionsWithStdioTuple,
- ): ChildProcessByStdio;
- function spawn(
- command: string,
- args: ReadonlyArray,
- options: SpawnOptionsWithStdioTuple,
- ): ChildProcessByStdio;
- function spawn(
- command: string,
- args: ReadonlyArray,
- options: SpawnOptionsWithStdioTuple,
- ): ChildProcessByStdio;
- function spawn(
- command: string,
- args: ReadonlyArray,
- options: SpawnOptionsWithStdioTuple,
- ): ChildProcessByStdio;
- function spawn(
- command: string,
- args: ReadonlyArray,
- options: SpawnOptionsWithStdioTuple,
- ): ChildProcessByStdio;
- function spawn(
- command: string,
- args: ReadonlyArray,
- options: SpawnOptionsWithStdioTuple,
- ): ChildProcessByStdio;
- function spawn(
- command: string,
- args: ReadonlyArray,
- options: SpawnOptionsWithStdioTuple,
- ): ChildProcessByStdio;
-
+ function spawn(command: string, args: ReadonlyArray, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio;
+ function spawn(command: string, args: ReadonlyArray, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio;
+ function spawn(command: string, args: ReadonlyArray, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio;
+ function spawn(command: string, args: ReadonlyArray, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio;
+ function spawn(command: string, args: ReadonlyArray, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio;
+ function spawn(command: string, args: ReadonlyArray, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio;
+ function spawn(command: string, args: ReadonlyArray, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio;
+ function spawn(command: string, args: ReadonlyArray, options: SpawnOptionsWithStdioTuple): ChildProcessByStdio;
function spawn(command: string, args: ReadonlyArray, options: SpawnOptions): ChildProcess;
-
interface ExecOptions extends CommonOptions {
shell?: string | undefined;
+ signal?: AbortSignal | undefined;
maxBuffer?: number | undefined;
killSignal?: NodeJS.Signals | number | undefined;
}
-
interface ExecOptionsWithStringEncoding extends ExecOptions {
encoding: BufferEncoding;
}
-
interface ExecOptionsWithBufferEncoding extends ExecOptions {
encoding: BufferEncoding | null; // specify `null`.
}
-
interface ExecException extends Error {
cmd?: string | undefined;
killed?: boolean | undefined;
code?: number | undefined;
signal?: NodeJS.Signals | undefined;
}
-
- // no `options` definitely means stdout/stderr are `string`.
+ /**
+ * Spawns a shell then executes the `command` within that shell, buffering any
+ * generated output. The `command` string passed to the exec function is processed
+ * directly by the shell and special characters (vary based on [shell](https://en.wikipedia.org/wiki/List_of_command-line_interpreters))
+ * need to be dealt with accordingly:
+ *
+ * ```js
+ * const { exec } = require('child_process');
+ *
+ * exec('"/path/to/test file/test.sh" arg1 arg2');
+ * // Double quotes are used so that the space in the path is not interpreted as
+ * // a delimiter of multiple arguments.
+ *
+ * exec('echo "The \\$HOME variable is $HOME"');
+ * // The $HOME variable is escaped in the first instance, but not in the second.
+ * ```
+ *
+ * **Never pass unsanitized user input to this function. Any input containing shell**
+ * **metacharacters may be used to trigger arbitrary command execution.**
+ *
+ * If a `callback` function is provided, it is called with the arguments`(error, stdout, stderr)`. On success, `error` will be `null`. On error,`error` will be an instance of `Error`. The
+ * `error.code` property will be
+ * the exit code of the process. By convention, any exit code other than `0`indicates an error. `error.signal` will be the signal that terminated the
+ * process.
+ *
+ * The `stdout` and `stderr` arguments passed to the callback will contain the
+ * stdout and stderr output of the child process. By default, Node.js will decode
+ * the output as UTF-8 and pass strings to the callback. The `encoding` option
+ * can be used to specify the character encoding used to decode the stdout and
+ * stderr output. If `encoding` is `'buffer'`, or an unrecognized character
+ * encoding, `Buffer` objects will be passed to the callback instead.
+ *
+ * ```js
+ * const { exec } = require('child_process');
+ * exec('cat *.js missing_file | wc -l', (error, stdout, stderr) => {
+ * if (error) {
+ * console.error(`exec error: ${error}`);
+ * return;
+ * }
+ * console.log(`stdout: ${stdout}`);
+ * console.error(`stderr: ${stderr}`);
+ * });
+ * ```
+ *
+ * If `timeout` is greater than `0`, the parent will send the signal
+ * identified by the `killSignal` property (the default is `'SIGTERM'`) if the
+ * child runs longer than `timeout` milliseconds.
+ *
+ * Unlike the [`exec(3)`](http://man7.org/linux/man-pages/man3/exec.3.html) POSIX system call, `child_process.exec()` does not replace
+ * the existing process and uses a shell to execute the command.
+ *
+ * If this method is invoked as its `util.promisify()` ed version, it returns
+ * a `Promise` for an `Object` with `stdout` and `stderr` properties. The returned`ChildProcess` instance is attached to the `Promise` as a `child` property. In
+ * case of an error (including any error resulting in an exit code other than 0), a
+ * rejected promise is returned, with the same `error` object given in the
+ * callback, but with two additional properties `stdout` and `stderr`.
+ *
+ * ```js
+ * const util = require('util');
+ * const exec = util.promisify(require('child_process').exec);
+ *
+ * async function lsExample() {
+ * const { stdout, stderr } = await exec('ls');
+ * console.log('stdout:', stdout);
+ * console.error('stderr:', stderr);
+ * }
+ * lsExample();
+ * ```
+ *
+ * If the `signal` option is enabled, calling `.abort()` on the corresponding`AbortController` is similar to calling `.kill()` on the child process except
+ * the error passed to the callback will be an `AbortError`:
+ *
+ * ```js
+ * const { exec } = require('child_process');
+ * const controller = new AbortController();
+ * const { signal } = controller;
+ * const child = exec('grep ssh', { signal }, (error) => {
+ * console.log(error); // an AbortError
+ * });
+ * controller.abort();
+ * ```
+ * @since v0.1.90
+ * @param command The command to run, with space-separated arguments.
+ * @param callback called with the output when process terminates.
+ */
function exec(command: string, callback?: (error: ExecException | null, stdout: string, stderr: string) => void): ChildProcess;
-
// `options` with `"buffer"` or `null` for `encoding` means stdout/stderr are definitely `Buffer`.
- function exec(command: string, options: { encoding: "buffer" | null } & ExecOptions, callback?: (error: ExecException | null, stdout: Buffer, stderr: Buffer) => void): ChildProcess;
-
+ function exec(
+ command: string,
+ options: {
+ encoding: 'buffer' | null;
+ } & ExecOptions,
+ callback?: (error: ExecException | null, stdout: Buffer, stderr: Buffer) => void
+ ): ChildProcess;
// `options` with well known `encoding` means stdout/stderr are definitely `string`.
- function exec(command: string, options: { encoding: BufferEncoding } & ExecOptions, callback?: (error: ExecException | null, stdout: string, stderr: string) => void): ChildProcess;
-
+ function exec(
+ command: string,
+ options: {
+ encoding: BufferEncoding;
+ } & ExecOptions,
+ callback?: (error: ExecException | null, stdout: string, stderr: string) => void
+ ): ChildProcess;
// `options` with an `encoding` whose type is `string` means stdout/stderr could either be `Buffer` or `string`.
// There is no guarantee the `encoding` is unknown as `string` is a superset of `BufferEncoding`.
function exec(
command: string,
- options: { encoding: BufferEncoding } & ExecOptions,
- callback?: (error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void,
+ options: {
+ encoding: BufferEncoding;
+ } & ExecOptions,
+ callback?: (error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void
): ChildProcess;
-
// `options` without an `encoding` means stdout/stderr are definitely `string`.
function exec(command: string, options: ExecOptions, callback?: (error: ExecException | null, stdout: string, stderr: string) => void): ChildProcess;
-
// fallback if nothing else matches. Worst case is always `string | Buffer`.
function exec(
command: string,
- options: (BaseEncodingOptions & ExecOptions) | undefined | null,
- callback?: (error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void,
+ options: (ObjectEncodingOptions & ExecOptions) | undefined | null,
+ callback?: (error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void
): ChildProcess;
-
interface PromiseWithChild extends Promise {
child: ChildProcess;
}
-
- // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime.
namespace exec {
- function __promisify__(command: string): PromiseWithChild<{ stdout: string, stderr: string }>;
- function __promisify__(command: string, options: { encoding: "buffer" | null } & ExecOptions): PromiseWithChild<{ stdout: Buffer, stderr: Buffer }>;
- function __promisify__(command: string, options: { encoding: BufferEncoding } & ExecOptions): PromiseWithChild<{ stdout: string, stderr: string }>;
- function __promisify__(command: string, options: ExecOptions): PromiseWithChild<{ stdout: string, stderr: string }>;
- function __promisify__(command: string, options?: (BaseEncodingOptions & ExecOptions) | null): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>;
+ function __promisify__(command: string): PromiseWithChild<{
+ stdout: string;
+ stderr: string;
+ }>;
+ function __promisify__(
+ command: string,
+ options: {
+ encoding: 'buffer' | null;
+ } & ExecOptions
+ ): PromiseWithChild<{
+ stdout: Buffer;
+ stderr: Buffer;
+ }>;
+ function __promisify__(
+ command: string,
+ options: {
+ encoding: BufferEncoding;
+ } & ExecOptions
+ ): PromiseWithChild<{
+ stdout: string;
+ stderr: string;
+ }>;
+ function __promisify__(
+ command: string,
+ options: ExecOptions
+ ): PromiseWithChild<{
+ stdout: string;
+ stderr: string;
+ }>;
+ function __promisify__(
+ command: string,
+ options?: (ObjectEncodingOptions & ExecOptions) | null
+ ): PromiseWithChild<{
+ stdout: string | Buffer;
+ stderr: string | Buffer;
+ }>;
}
-
- interface ExecFileOptions extends CommonOptions {
+ interface ExecFileOptions extends CommonOptions, Abortable {
maxBuffer?: number | undefined;
killSignal?: NodeJS.Signals | number | undefined;
windowsVerbatimArguments?: boolean | undefined;
shell?: boolean | string | undefined;
+ signal?: AbortSignal | undefined;
}
interface ExecFileOptionsWithStringEncoding extends ExecFileOptions {
encoding: BufferEncoding;
@@ -342,48 +985,101 @@ declare module 'child_process' {
encoding: BufferEncoding;
}
type ExecFileException = ExecException & NodeJS.ErrnoException;
-
+ /**
+ * The `child_process.execFile()` function is similar to {@link exec} except that it does not spawn a shell by default. Rather, the specified
+ * executable `file` is spawned directly as a new process making it slightly more
+ * efficient than {@link exec}.
+ *
+ * The same options as {@link exec} are supported. Since a shell is
+ * not spawned, behaviors such as I/O redirection and file globbing are not
+ * supported.
+ *
+ * ```js
+ * const { execFile } = require('child_process');
+ * const child = execFile('node', ['--version'], (error, stdout, stderr) => {
+ * if (error) {
+ * throw error;
+ * }
+ * console.log(stdout);
+ * });
+ * ```
+ *
+ * The `stdout` and `stderr` arguments passed to the callback will contain the
+ * stdout and stderr output of the child process. By default, Node.js will decode
+ * the output as UTF-8 and pass strings to the callback. The `encoding` option
+ * can be used to specify the character encoding used to decode the stdout and
+ * stderr output. If `encoding` is `'buffer'`, or an unrecognized character
+ * encoding, `Buffer` objects will be passed to the callback instead.
+ *
+ * If this method is invoked as its `util.promisify()` ed version, it returns
+ * a `Promise` for an `Object` with `stdout` and `stderr` properties. The returned`ChildProcess` instance is attached to the `Promise` as a `child` property. In
+ * case of an error (including any error resulting in an exit code other than 0), a
+ * rejected promise is returned, with the same `error` object given in the
+ * callback, but with two additional properties `stdout` and `stderr`.
+ *
+ * ```js
+ * const util = require('util');
+ * const execFile = util.promisify(require('child_process').execFile);
+ * async function getVersion() {
+ * const { stdout } = await execFile('node', ['--version']);
+ * console.log(stdout);
+ * }
+ * getVersion();
+ * ```
+ *
+ * **If the `shell` option is enabled, do not pass unsanitized user input to this**
+ * **function. Any input containing shell metacharacters may be used to trigger**
+ * **arbitrary command execution.**
+ *
+ * If the `signal` option is enabled, calling `.abort()` on the corresponding`AbortController` is similar to calling `.kill()` on the child process except
+ * the error passed to the callback will be an `AbortError`:
+ *
+ * ```js
+ * const { execFile } = require('child_process');
+ * const controller = new AbortController();
+ * const { signal } = controller;
+ * const child = execFile('node', ['--version'], { signal }, (error) => {
+ * console.log(error); // an AbortError
+ * });
+ * controller.abort();
+ * ```
+ * @since v0.1.91
+ * @param file The name or path of the executable file to run.
+ * @param args List of string arguments.
+ * @param callback Called with the output when process terminates.
+ */
function execFile(file: string): ChildProcess;
- function execFile(file: string, options: (BaseEncodingOptions & ExecFileOptions) | undefined | null): ChildProcess;
+ function execFile(file: string, options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null): ChildProcess;
function execFile(file: string, args?: ReadonlyArray | null): ChildProcess;
- function execFile(file: string, args: ReadonlyArray | undefined | null, options: (BaseEncodingOptions & ExecFileOptions) | undefined | null): ChildProcess;
-
+ function execFile(file: string, args: ReadonlyArray | undefined | null, options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null): ChildProcess;
// no `options` definitely means stdout/stderr are `string`.
function execFile(file: string, callback: (error: ExecFileException | null, stdout: string, stderr: string) => void): ChildProcess;
function execFile(file: string, args: ReadonlyArray | undefined | null, callback: (error: ExecFileException | null, stdout: string, stderr: string) => void): ChildProcess;
-
// `options` with `"buffer"` or `null` for `encoding` means stdout/stderr are definitely `Buffer`.
function execFile(file: string, options: ExecFileOptionsWithBufferEncoding, callback: (error: ExecFileException | null, stdout: Buffer, stderr: Buffer) => void): ChildProcess;
function execFile(
file: string,
args: ReadonlyArray | undefined | null,
options: ExecFileOptionsWithBufferEncoding,
- callback: (error: ExecFileException | null, stdout: Buffer, stderr: Buffer) => void,
+ callback: (error: ExecFileException | null, stdout: Buffer, stderr: Buffer) => void
): ChildProcess;
-
// `options` with well known `encoding` means stdout/stderr are definitely `string`.
function execFile(file: string, options: ExecFileOptionsWithStringEncoding, callback: (error: ExecFileException | null, stdout: string, stderr: string) => void): ChildProcess;
function execFile(
file: string,
args: ReadonlyArray | undefined | null,
options: ExecFileOptionsWithStringEncoding,
- callback: (error: ExecFileException | null, stdout: string, stderr: string) => void,
+ callback: (error: ExecFileException | null, stdout: string, stderr: string) => void
): ChildProcess;
-
// `options` with an `encoding` whose type is `string` means stdout/stderr could either be `Buffer` or `string`.
// There is no guarantee the `encoding` is unknown as `string` is a superset of `BufferEncoding`.
- function execFile(
- file: string,
- options: ExecFileOptionsWithOtherEncoding,
- callback: (error: ExecFileException | null, stdout: string | Buffer, stderr: string | Buffer) => void,
- ): ChildProcess;
+ function execFile(file: string, options: ExecFileOptionsWithOtherEncoding, callback: (error: ExecFileException | null, stdout: string | Buffer, stderr: string | Buffer) => void): ChildProcess;
function execFile(
file: string,
args: ReadonlyArray | undefined | null,
options: ExecFileOptionsWithOtherEncoding,
- callback: (error: ExecFileException | null, stdout: string | Buffer, stderr: string | Buffer) => void,
+ callback: (error: ExecFileException | null, stdout: string | Buffer, stderr: string | Buffer) => void
): ChildProcess;
-
// `options` without an `encoding` means stdout/stderr are definitely `string`.
function execFile(file: string, options: ExecFileOptions, callback: (error: ExecFileException | null, stdout: string, stderr: string) => void): ChildProcess;
function execFile(
@@ -392,45 +1088,107 @@ declare module 'child_process' {
options: ExecFileOptions,
callback: (error: ExecFileException | null, stdout: string, stderr: string) => void
): ChildProcess;
-
// fallback if nothing else matches. Worst case is always `string | Buffer`.
function execFile(
file: string,
- options: (BaseEncodingOptions & ExecFileOptions) | undefined | null,
- callback: ((error: ExecFileException | null, stdout: string | Buffer, stderr: string | Buffer) => void) | undefined | null,
+ options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null,
+ callback: ((error: ExecFileException | null, stdout: string | Buffer, stderr: string | Buffer) => void) | undefined | null
): ChildProcess;
function execFile(
file: string,
args: ReadonlyArray | undefined | null,
- options: (BaseEncodingOptions & ExecFileOptions) | undefined | null,
- callback: ((error: ExecFileException | null, stdout: string | Buffer, stderr: string | Buffer) => void) | undefined | null,
+ options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null,
+ callback: ((error: ExecFileException | null, stdout: string | Buffer, stderr: string | Buffer) => void) | undefined | null
): ChildProcess;
-
- // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime.
namespace execFile {
- function __promisify__(file: string): PromiseWithChild<{ stdout: string, stderr: string }>;
- function __promisify__(file: string, args: ReadonlyArray | undefined | null): PromiseWithChild<{ stdout: string, stderr: string }>;
- function __promisify__(file: string, options: ExecFileOptionsWithBufferEncoding): PromiseWithChild<{ stdout: Buffer, stderr: Buffer }>;
- function __promisify__(file: string, args: ReadonlyArray | undefined | null, options: ExecFileOptionsWithBufferEncoding): PromiseWithChild<{ stdout: Buffer, stderr: Buffer }>;
- function __promisify__(file: string, options: ExecFileOptionsWithStringEncoding): PromiseWithChild<{ stdout: string, stderr: string }>;
- function __promisify__(file: string, args: ReadonlyArray | undefined | null, options: ExecFileOptionsWithStringEncoding): PromiseWithChild<{ stdout: string, stderr: string }>;
- function __promisify__(file: string, options: ExecFileOptionsWithOtherEncoding): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>;
+ function __promisify__(file: string): PromiseWithChild<{
+ stdout: string;
+ stderr: string;
+ }>;
+ function __promisify__(
+ file: string,
+ args: ReadonlyArray | undefined | null
+ ): PromiseWithChild<{
+ stdout: string;
+ stderr: string;
+ }>;
+ function __promisify__(
+ file: string,
+ options: ExecFileOptionsWithBufferEncoding
+ ): PromiseWithChild<{
+ stdout: Buffer;
+ stderr: Buffer;
+ }>;
function __promisify__(
file: string,
args: ReadonlyArray | undefined | null,
- options: ExecFileOptionsWithOtherEncoding,
- ): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>;
- function __promisify__(file: string, options: ExecFileOptions): PromiseWithChild<{ stdout: string, stderr: string }>;
- function __promisify__(file: string, args: ReadonlyArray | undefined | null, options: ExecFileOptions): PromiseWithChild<{ stdout: string, stderr: string }>;
- function __promisify__(file: string, options: (BaseEncodingOptions & ExecFileOptions) | undefined | null): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>;
+ options: ExecFileOptionsWithBufferEncoding
+ ): PromiseWithChild<{
+ stdout: Buffer;
+ stderr: Buffer;
+ }>;
+ function __promisify__(
+ file: string,
+ options: ExecFileOptionsWithStringEncoding
+ ): PromiseWithChild<{
+ stdout: string;
+ stderr: string;
+ }>;
function __promisify__(
file: string,
args: ReadonlyArray | undefined | null,
- options: (BaseEncodingOptions & ExecFileOptions) | undefined | null,
- ): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>;
+ options: ExecFileOptionsWithStringEncoding
+ ): PromiseWithChild<{
+ stdout: string;
+ stderr: string;
+ }>;
+ function __promisify__(
+ file: string,
+ options: ExecFileOptionsWithOtherEncoding
+ ): PromiseWithChild<{
+ stdout: string | Buffer;
+ stderr: string | Buffer;
+ }>;
+ function __promisify__(
+ file: string,
+ args: ReadonlyArray | undefined | null,
+ options: ExecFileOptionsWithOtherEncoding
+ ): PromiseWithChild<{
+ stdout: string | Buffer;
+ stderr: string | Buffer;
+ }>;
+ function __promisify__(
+ file: string,
+ options: ExecFileOptions
+ ): PromiseWithChild<{
+ stdout: string;
+ stderr: string;
+ }>;
+ function __promisify__(
+ file: string,
+ args: ReadonlyArray | undefined | null,
+ options: ExecFileOptions
+ ): PromiseWithChild<{
+ stdout: string;
+ stderr: string;
+ }>;
+ function __promisify__(
+ file: string,
+ options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null
+ ): PromiseWithChild<{
+ stdout: string | Buffer;
+ stderr: string | Buffer;
+ }>;
+ function __promisify__(
+ file: string,
+ args: ReadonlyArray | undefined | null,
+ options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null
+ ): PromiseWithChild<{
+ stdout: string | Buffer;
+ stderr: string | Buffer;
+ }>;
}
-
- interface ForkOptions extends ProcessEnvOptions, MessagingOptions {
+ interface ForkOptions extends ProcessEnvOptions, MessagingOptions, Abortable {
execPath?: string | undefined;
execArgv?: string[] | undefined;
silent?: boolean | undefined;
@@ -438,12 +1196,59 @@ declare module 'child_process' {
detached?: boolean | undefined;
windowsVerbatimArguments?: boolean | undefined;
}
+ /**
+ * The `child_process.fork()` method is a special case of {@link spawn} used specifically to spawn new Node.js processes.
+ * Like {@link spawn}, a `ChildProcess` object is returned. The
+ * returned `ChildProcess` will have an additional communication channel
+ * built-in that allows messages to be passed back and forth between the parent and
+ * child. See `subprocess.send()` for details.
+ *
+ * Keep in mind that spawned Node.js child processes are
+ * independent of the parent with exception of the IPC communication channel
+ * that is established between the two. Each process has its own memory, with
+ * their own V8 instances. Because of the additional resource allocations
+ * required, spawning a large number of child Node.js processes is not
+ * recommended.
+ *
+ * By default, `child_process.fork()` will spawn new Node.js instances using the `process.execPath` of the parent process. The `execPath` property in the`options` object allows for an alternative
+ * execution path to be used.
+ *
+ * Node.js processes launched with a custom `execPath` will communicate with the
+ * parent process using the file descriptor (fd) identified using the
+ * environment variable `NODE_CHANNEL_FD` on the child process.
+ *
+ * Unlike the [`fork(2)`](http://man7.org/linux/man-pages/man2/fork.2.html) POSIX system call, `child_process.fork()` does not clone the
+ * current process.
+ *
+ * The `shell` option available in {@link spawn} is not supported by`child_process.fork()` and will be ignored if set.
+ *
+ * If the `signal` option is enabled, calling `.abort()` on the corresponding`AbortController` is similar to calling `.kill()` on the child process except
+ * the error passed to the callback will be an `AbortError`:
+ *
+ * ```js
+ * if (process.argv[2] === 'child') {
+ * setTimeout(() => {
+ * console.log(`Hello from ${process.argv[2]}!`);
+ * }, 1_000);
+ * } else {
+ * const { fork } = require('child_process');
+ * const controller = new AbortController();
+ * const { signal } = controller;
+ * const child = fork(__filename, ['child'], { signal });
+ * child.on('error', (err) => {
+ * // This will be called with err being an AbortError if the controller aborts
+ * });
+ * controller.abort(); // Stops the child process
+ * }
+ * ```
+ * @since v0.5.0
+ * @param modulePath The module to run in the child.
+ * @param args List of string arguments.
+ */
function fork(modulePath: string, options?: ForkOptions): ChildProcess;
function fork(modulePath: string, args?: ReadonlyArray, options?: ForkOptions): ChildProcess;
-
interface SpawnSyncOptions extends CommonSpawnOptions {
input?: string | NodeJS.ArrayBufferView | undefined;
- killSignal?: NodeJS.Signals | number | undefined;
maxBuffer?: number | undefined;
encoding?: BufferEncoding | 'buffer' | null | undefined;
}
@@ -462,55 +1267,102 @@ declare module 'child_process' {
signal: NodeJS.Signals | null;
error?: Error | undefined;
}
+ /**
+ * The `child_process.spawnSync()` method is generally identical to {@link spawn} with the exception that the function will not return
+ * until the child process has fully closed. When a timeout has been encountered
+ * and `killSignal` is sent, the method won't return until the process has
+ * completely exited. If the process intercepts and handles the `SIGTERM` signal
+ * and doesn't exit, the parent process will wait until the child process has
+ * exited.
+ *
+ * **If the `shell` option is enabled, do not pass unsanitized user input to this**
+ * **function. Any input containing shell metacharacters may be used to trigger**
+ * **arbitrary command execution.**
+ * @since v0.11.12
+ * @param command The command to run.
+ * @param args List of string arguments.
+ */
function spawnSync(command: string): SpawnSyncReturns;
- function spawnSync(command: string, options?: SpawnSyncOptionsWithStringEncoding): SpawnSyncReturns;
- function spawnSync(command: string, options?: SpawnSyncOptionsWithBufferEncoding): SpawnSyncReturns;
+ function spawnSync(command: string, options: SpawnSyncOptionsWithStringEncoding): SpawnSyncReturns;
+ function spawnSync(command: string, options: SpawnSyncOptionsWithBufferEncoding): SpawnSyncReturns;
function spawnSync(command: string, options?: SpawnSyncOptions): SpawnSyncReturns;
- function spawnSync(command: string, args?: ReadonlyArray, options?: SpawnSyncOptionsWithStringEncoding): SpawnSyncReturns;
- function spawnSync(command: string, args?: ReadonlyArray, options?: SpawnSyncOptionsWithBufferEncoding): SpawnSyncReturns;
+ function spawnSync(command: string, args: ReadonlyArray): SpawnSyncReturns;
+ function spawnSync(command: string, args: ReadonlyArray, options: SpawnSyncOptionsWithStringEncoding): SpawnSyncReturns;
+ function spawnSync(command: string, args: ReadonlyArray, options: SpawnSyncOptionsWithBufferEncoding): SpawnSyncReturns;
function spawnSync(command: string, args?: ReadonlyArray, options?: SpawnSyncOptions): SpawnSyncReturns;
-
- interface ExecSyncOptions extends CommonOptions {
- input?: string | Uint8Array | undefined;
+ interface CommonExecOptions extends CommonOptions {
+ input?: string | NodeJS.ArrayBufferView | undefined;
stdio?: StdioOptions | undefined;
- shell?: string | undefined;
killSignal?: NodeJS.Signals | number | undefined;
maxBuffer?: number | undefined;
encoding?: BufferEncoding | 'buffer' | null | undefined;
}
+ interface ExecSyncOptions extends CommonExecOptions {
+ shell?: string | undefined;
+ }
interface ExecSyncOptionsWithStringEncoding extends ExecSyncOptions {
encoding: BufferEncoding;
}
interface ExecSyncOptionsWithBufferEncoding extends ExecSyncOptions {
encoding?: 'buffer' | null | undefined;
}
+ /**
+ * The `child_process.execSync()` method is generally identical to {@link exec} with the exception that the method will not return
+ * until the child process has fully closed. When a timeout has been encountered
+ * and `killSignal` is sent, the method won't return until the process has
+ * completely exited. If the child process intercepts and handles the `SIGTERM`signal and doesn't exit, the parent process will wait until the child process
+ * has exited.
+ *
+ * If the process times out or has a non-zero exit code, this method will throw.
+ * The `Error` object will contain the entire result from {@link spawnSync}.
+ *
+ * **Never pass unsanitized user input to this function. Any input containing shell**
+ * **metacharacters may be used to trigger arbitrary command execution.**
+ * @since v0.11.12
+ * @param command The command to run.
+ * @return The stdout from the command.
+ */
function execSync(command: string): Buffer;
function execSync(command: string, options: ExecSyncOptionsWithStringEncoding): string;
function execSync(command: string, options: ExecSyncOptionsWithBufferEncoding): Buffer;
function execSync(command: string, options?: ExecSyncOptions): string | Buffer;
-
- interface ExecFileSyncOptions extends CommonOptions {
- input?: string | NodeJS.ArrayBufferView | undefined;
- stdio?: StdioOptions | undefined;
- killSignal?: NodeJS.Signals | number | undefined;
- maxBuffer?: number | undefined;
- encoding?: BufferEncoding | undefined;
+ interface ExecFileSyncOptions extends CommonExecOptions {
shell?: boolean | string | undefined;
}
interface ExecFileSyncOptionsWithStringEncoding extends ExecFileSyncOptions {
encoding: BufferEncoding;
}
interface ExecFileSyncOptionsWithBufferEncoding extends ExecFileSyncOptions {
- encoding: BufferEncoding; // specify `null`.
+ encoding?: 'buffer' | null; // specify `null`.
}
- function execFileSync(command: string): Buffer;
- function execFileSync(command: string, options: ExecFileSyncOptionsWithStringEncoding): string;
- function execFileSync(command: string, options: ExecFileSyncOptionsWithBufferEncoding): Buffer;
- function execFileSync(command: string, options?: ExecFileSyncOptions): string | Buffer;
- function execFileSync(command: string, args: ReadonlyArray): Buffer;
- function execFileSync(command: string, args: ReadonlyArray, options: ExecFileSyncOptionsWithStringEncoding): string;
- function execFileSync(command: string, args: ReadonlyArray, options: ExecFileSyncOptionsWithBufferEncoding): Buffer;
- function execFileSync(command: string, args?: ReadonlyArray, options?: ExecFileSyncOptions): string | Buffer;
+ /**
+ * The `child_process.execFileSync()` method is generally identical to {@link execFile} with the exception that the method will not
+ * return until the child process has fully closed. When a timeout has been
+ * encountered and `killSignal` is sent, the method won't return until the process
+ * has completely exited.
+ *
+ * If the child process intercepts and handles the `SIGTERM` signal and
+ * does not exit, the parent process will still wait until the child process has
+ * exited.
+ *
+ * If the process times out or has a non-zero exit code, this method will throw an `Error` that will include the full result of the underlying {@link spawnSync}.
+ *
+ * **If the `shell` option is enabled, do not pass unsanitized user input to this**
+ * **function. Any input containing shell metacharacters may be used to trigger**
+ * **arbitrary command execution.**
+ * @since v0.11.12
+ * @param file The name or path of the executable file to run.
+ * @param args List of string arguments.
+ * @return The stdout from the command.
+ */
+ function execFileSync(file: string): Buffer;
+ function execFileSync(file: string, options: ExecFileSyncOptionsWithStringEncoding): string;
+ function execFileSync(file: string, options: ExecFileSyncOptionsWithBufferEncoding): Buffer;
+ function execFileSync(file: string, options?: ExecFileSyncOptions): string | Buffer;
+ function execFileSync(file: string, args: ReadonlyArray): Buffer;
+ function execFileSync(file: string, args: ReadonlyArray, options: ExecFileSyncOptionsWithStringEncoding): string;
+ function execFileSync(file: string, args: ReadonlyArray, options: ExecFileSyncOptionsWithBufferEncoding): Buffer;
+ function execFileSync(file: string, args?: ReadonlyArray, options?: ExecFileSyncOptions): string | Buffer;
}
declare module 'node:child_process' {
export * from 'child_process';
diff --git a/packages/node_modules/@node-red/editor-client/src/types/node/cluster.d.ts b/packages/node_modules/@node-red/editor-client/src/types/node/cluster.d.ts
index c2c7cd435..335275948 100644
--- a/packages/node_modules/@node-red/editor-client/src/types/node/cluster.d.ts
+++ b/packages/node_modules/@node-red/editor-client/src/types/node/cluster.d.ts
@@ -1,13 +1,64 @@
/* NOTE: Do not edit directly! This file is generated using `npm run update-types` in https://github.com/Steve-Mcl/monaco-editor-esm-i18n */
+/**
+ * A single instance of Node.js runs in a single thread. To take advantage of
+ * multi-core systems, the user will sometimes want to launch a cluster of Node.js
+ * processes to handle the load.
+ *
+ * The cluster module allows easy creation of child processes that all share
+ * server ports.
+ *
+ * ```js
+ * import cluster from 'cluster';
+ * import http from 'http';
+ * import { cpus } from 'os';
+ * import process from 'process';
+ *
+ * const numCPUs = cpus().length;
+ *
+ * if (cluster.isPrimary) {
+ * console.log(`Primary ${process.pid} is running`);
+ *
+ * // Fork workers.
+ * for (let i = 0; i < numCPUs; i++) {
+ * cluster.fork();
+ * }
+ *
+ * cluster.on('exit', (worker, code, signal) => {
+ * console.log(`worker ${worker.process.pid} died`);
+ * });
+ * } else {
+ * // Workers can share any TCP connection
+ * // In this case it is an HTTP server
+ * http.createServer((req, res) => {
+ * res.writeHead(200);
+ * res.end('hello world\n');
+ * }).listen(8000);
+ *
+ * console.log(`Worker ${process.pid} started`);
+ * }
+ * ```
+ *
+ * Running Node.js will now share port 8000 between the workers:
+ *
+ * ```console
+ * $ node server.js
+ * Primary 3596 is running
+ * Worker 4324 started
+ * Worker 4520 started
+ * Worker 6056 started
+ * Worker 5644 started
+ * ```
+ *
+ * On Windows, it is not yet possible to set up a named pipe server in a worker.
+ * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/cluster.js)
+ */
declare module 'cluster' {
- import * as child from 'child_process';
- import EventEmitter = require('events');
- import * as net from 'net';
-
- // interfaces
- interface ClusterSettings {
+ import * as child from 'node:child_process';
+ import EventEmitter = require('node:events');
+ import * as net from 'node:net';
+ export interface ClusterSettings {
execArgv?: string[] | undefined; // default: process.execArgv
exec?: string | undefined;
args?: string[] | undefined;
@@ -17,24 +68,214 @@ declare module 'cluster' {
gid?: number | undefined;
inspectPort?: number | (() => number) | undefined;
}
-
- interface Address {
+ export interface Address {
address: string;
port: number;
- addressType: number | "udp4" | "udp6"; // 4, 6, -1, "udp4", "udp6"
+ addressType: number | 'udp4' | 'udp6'; // 4, 6, -1, "udp4", "udp6"
}
-
- class Worker extends EventEmitter {
+ /**
+ * A `Worker` object contains all public information and method about a worker.
+ * In the primary it can be obtained using `cluster.workers`. In a worker
+ * it can be obtained using `cluster.worker`.
+ * @since v0.7.0
+ */
+ export class Worker extends EventEmitter {
+ /**
+ * Each new worker is given its own unique id, this id is stored in the`id`.
+ *
+ * While a worker is alive, this is the key that indexes it in`cluster.workers`.
+ * @since v0.8.0
+ */
id: number;
+ /**
+ * All workers are created using `child_process.fork()`, the returned object
+ * from this function is stored as `.process`. In a worker, the global `process`is stored.
+ *
+ * See: `Child Process module`.
+ *
+ * Workers will call `process.exit(0)` if the `'disconnect'` event occurs
+ * on `process` and `.exitedAfterDisconnect` is not `true`. This protects against
+ * accidental disconnection.
+ * @since v0.7.0
+ */
process: child.ChildProcess;
- send(message: child.Serializable, sendHandle?: child.SendHandle, callback?: (error: Error | null) => void): boolean;
+ /**
+ * Send a message to a worker or primary, optionally with a handle.
+ *
+ * In the primary this sends a message to a specific worker. It is identical to `ChildProcess.send()`.
+ *
+ * In a worker this sends a message to the primary. It is identical to`process.send()`.
+ *
+ * This example will echo back all messages from the primary:
+ *
+ * ```js
+ * if (cluster.isPrimary) {
+ * const worker = cluster.fork();
+ * worker.send('hi there');
+ *
+ * } else if (cluster.isWorker) {
+ * process.on('message', (msg) => {
+ * process.send(msg);
+ * });
+ * }
+ * ```
+ * @since v0.7.0
+ * @param options The `options` argument, if present, is an object used to parameterize the sending of certain types of handles. `options` supports the following properties:
+ */
+ send(message: child.Serializable, callback?: (error: Error | null) => void): boolean;
+ send(message: child.Serializable, sendHandle: child.SendHandle, callback?: (error: Error | null) => void): boolean;
+ send(message: child.Serializable, sendHandle: child.SendHandle, options?: child.MessageOptions, callback?: (error: Error | null) => void): boolean;
+ /**
+ * This function will kill the worker. In the primary, it does this
+ * by disconnecting the `worker.process`, and once disconnected, killing
+ * with `signal`. In the worker, it does it by disconnecting the channel,
+ * and then exiting with code `0`.
+ *
+ * Because `kill()` attempts to gracefully disconnect the worker process, it is
+ * susceptible to waiting indefinitely for the disconnect to complete. For example,
+ * if the worker enters an infinite loop, a graceful disconnect will never occur.
+ * If the graceful disconnect behavior is not needed, use `worker.process.kill()`.
+ *
+ * Causes `.exitedAfterDisconnect` to be set.
+ *
+ * This method is aliased as `worker.destroy()` for backward compatibility.
+ *
+ * In a worker, `process.kill()` exists, but it is not this function;
+ * it is `kill()`.
+ * @since v0.9.12
+ * @param [signal='SIGTERM'] Name of the kill signal to send to the worker process.
+ */
kill(signal?: string): void;
destroy(signal?: string): void;
+ /**
+ * In a worker, this function will close all servers, wait for the `'close'` event
+ * on those servers, and then disconnect the IPC channel.
+ *
+ * In the primary, an internal message is sent to the worker causing it to call`.disconnect()` on itself.
+ *
+ * Causes `.exitedAfterDisconnect` to be set.
+ *
+ * After a server is closed, it will no longer accept new connections,
+ * but connections may be accepted by any other listening worker. Existing
+ * connections will be allowed to close as usual. When no more connections exist,
+ * see `server.close()`, the IPC channel to the worker will close allowing it
+ * to die gracefully.
+ *
+ * The above applies _only_ to server connections, client connections are not
+ * automatically closed by workers, and disconnect does not wait for them to close
+ * before exiting.
+ *
+ * In a worker, `process.disconnect` exists, but it is not this function;
+ * it is `disconnect()`.
+ *
+ * Because long living server connections may block workers from disconnecting, it
+ * may be useful to send a message, so application specific actions may be taken to
+ * close them. It also may be useful to implement a timeout, killing a worker if
+ * the `'disconnect'` event has not been emitted after some time.
+ *
+ * ```js
+ * if (cluster.isPrimary) {
+ * const worker = cluster.fork();
+ * let timeout;
+ *
+ * worker.on('listening', (address) => {
+ * worker.send('shutdown');
+ * worker.disconnect();
+ * timeout = setTimeout(() => {
+ * worker.kill();
+ * }, 2000);
+ * });
+ *
+ * worker.on('disconnect', () => {
+ * clearTimeout(timeout);
+ * });
+ *
+ * } else if (cluster.isWorker) {
+ * const net = require('net');
+ * const server = net.createServer((socket) => {
+ * // Connections never end
+ * });
+ *
+ * server.listen(8000);
+ *
+ * process.on('message', (msg) => {
+ * if (msg === 'shutdown') {
+ * // Initiate graceful close of any connections to server
+ * }
+ * });
+ * }
+ * ```
+ * @since v0.7.7
+ * @return A reference to `worker`.
+ */
disconnect(): void;
+ /**
+ * This function returns `true` if the worker is connected to its primary via its
+ * IPC channel, `false` otherwise. A worker is connected to its primary after it
+ * has been created. It is disconnected after the `'disconnect'` event is emitted.
+ * @since v0.11.14
+ */
isConnected(): boolean;
+ /**
+ * This function returns `true` if the worker's process has terminated (either
+ * because of exiting or being signaled). Otherwise, it returns `false`.
+ *
+ * ```js
+ * import cluster from 'cluster';
+ * import http from 'http';
+ * import { cpus } from 'os';
+ * import process from 'process';
+ *
+ * const numCPUs = cpus().length;
+ *
+ * if (cluster.isPrimary) {
+ * console.log(`Primary ${process.pid} is running`);
+ *
+ * // Fork workers.
+ * for (let i = 0; i < numCPUs; i++) {
+ * cluster.fork();
+ * }
+ *
+ * cluster.on('fork', (worker) => {
+ * console.log('worker is dead:', worker.isDead());
+ * });
+ *
+ * cluster.on('exit', (worker, code, signal) => {
+ * console.log('worker is dead:', worker.isDead());
+ * });
+ * } else {
+ * // Workers can share any TCP connection. In this case, it is an HTTP server.
+ * http.createServer((req, res) => {
+ * res.writeHead(200);
+ * res.end(`Current process\n ${process.pid}`);
+ * process.kill(process.pid);
+ * }).listen(8000);
+ * }
+ * ```
+ * @since v0.11.14
+ */
isDead(): boolean;
+ /**
+ * This property is `true` if the worker exited due to `.kill()` or`.disconnect()`. If the worker exited any other way, it is `false`. If the
+ * worker has not exited, it is `undefined`.
+ *
+ * The boolean `worker.exitedAfterDisconnect` allows distinguishing between
+ * voluntary and accidental exit, the primary may choose not to respawn a worker
+ * based on this value.
+ *
+ * ```js
+ * cluster.on('exit', (worker, code, signal) => {
+ * if (worker.exitedAfterDisconnect === true) {
+ * console.log('Oh, it was just voluntary – no need to worry');
+ * }
+ * });
+ *
+ * // kill worker
+ * worker.kill();
+ * ```
+ * @since v6.0.0
+ */
exitedAfterDisconnect: boolean;
-
/**
* events.EventEmitter
* 1. disconnect
@@ -45,69 +286,67 @@ declare module 'cluster' {
* 6. online
*/
addListener(event: string, listener: (...args: any[]) => void): this;
- addListener(event: "disconnect", listener: () => void): this;
- addListener(event: "error", listener: (error: Error) => void): this;
- addListener(event: "exit", listener: (code: number, signal: string) => void): this;
- addListener(event: "listening", listener: (address: Address) => void): this;
- addListener(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
- addListener(event: "online", listener: () => void): this;
-
+ addListener(event: 'disconnect', listener: () => void): this;
+ addListener(event: 'error', listener: (error: Error) => void): this;
+ addListener(event: 'exit', listener: (code: number, signal: string) => void): this;
+ addListener(event: 'listening', listener: (address: Address) => void): this;
+ addListener(event: 'message', listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
+ addListener(event: 'online', listener: () => void): this;
emit(event: string | symbol, ...args: any[]): boolean;
- emit(event: "disconnect"): boolean;
- emit(event: "error", error: Error): boolean;
- emit(event: "exit", code: number, signal: string): boolean;
- emit(event: "listening", address: Address): boolean;
- emit(event: "message", message: any, handle: net.Socket | net.Server): boolean;
- emit(event: "online"): boolean;
-
+ emit(event: 'disconnect'): boolean;
+ emit(event: 'error', error: Error): boolean;
+ emit(event: 'exit', code: number, signal: string): boolean;
+ emit(event: 'listening', address: Address): boolean;
+ emit(event: 'message', message: any, handle: net.Socket | net.Server): boolean;
+ emit(event: 'online'): boolean;
on(event: string, listener: (...args: any[]) => void): this;
- on(event: "disconnect", listener: () => void): this;
- on(event: "error", listener: (error: Error) => void): this;
- on(event: "exit", listener: (code: number, signal: string) => void): this;
- on(event: "listening", listener: (address: Address) => void): this;
- on(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
- on(event: "online", listener: () => void): this;
-
+ on(event: 'disconnect', listener: () => void): this;
+ on(event: 'error', listener: (error: Error) => void): this;
+ on(event: 'exit', listener: (code: number, signal: string) => void): this;
+ on(event: 'listening', listener: (address: Address) => void): this;
+ on(event: 'message', listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
+ on(event: 'online', listener: () => void): this;
once(event: string, listener: (...args: any[]) => void): this;
- once(event: "disconnect", listener: () => void): this;
- once(event: "error", listener: (error: Error) => void): this;
- once(event: "exit", listener: (code: number, signal: string) => void): this;
- once(event: "listening", listener: (address: Address) => void): this;
- once(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
- once(event: "online", listener: () => void): this;
-
+ once(event: 'disconnect', listener: () => void): this;
+ once(event: 'error', listener: (error: Error) => void): this;
+ once(event: 'exit', listener: (code: number, signal: string) => void): this;
+ once(event: 'listening', listener: (address: Address) => void): this;
+ once(event: 'message', listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
+ once(event: 'online', listener: () => void): this;
prependListener(event: string, listener: (...args: any[]) => void): this;
- prependListener(event: "disconnect", listener: () => void): this;
- prependListener(event: "error", listener: (error: Error) => void): this;
- prependListener(event: "exit", listener: (code: number, signal: string) => void): this;
- prependListener(event: "listening", listener: (address: Address) => void): this;
- prependListener(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
- prependListener(event: "online", listener: () => void): this;
-
+ prependListener(event: 'disconnect', listener: () => void): this;
+ prependListener(event: 'error', listener: (error: Error) => void): this;
+ prependListener(event: 'exit', listener: (code: number, signal: string) => void): this;
+ prependListener(event: 'listening', listener: (address: Address) => void): this;
+ prependListener(event: 'message', listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
+ prependListener(event: 'online', listener: () => void): this;
prependOnceListener(event: string, listener: (...args: any[]) => void): this;
- prependOnceListener(event: "disconnect", listener: () => void): this;
- prependOnceListener(event: "error", listener: (error: Error) => void): this;
- prependOnceListener(event: "exit", listener: (code: number, signal: string) => void): this;
- prependOnceListener(event: "listening", listener: (address: Address) => void): this;
- prependOnceListener(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
- prependOnceListener(event: "online", listener: () => void): this;
+ prependOnceListener(event: 'disconnect', listener: () => void): this;
+ prependOnceListener(event: 'error', listener: (error: Error) => void): this;
+ prependOnceListener(event: 'exit', listener: (code: number, signal: string) => void): this;
+ prependOnceListener(event: 'listening', listener: (address: Address) => void): this;
+ prependOnceListener(event: 'message', listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
+ prependOnceListener(event: 'online', listener: () => void): this;
}
-
- interface Cluster extends EventEmitter {
- Worker: Worker;
+ export interface Cluster extends EventEmitter {
disconnect(callback?: () => void): void;
fork(env?: any): Worker;
- isMaster: boolean;
- isWorker: boolean;
+ /** @deprecated since v16.0.0 - use isPrimary. */
+ readonly isMaster: boolean;
+ readonly isPrimary: boolean;
+ readonly isWorker: boolean;
schedulingPolicy: number;
- settings: ClusterSettings;
+ readonly settings: ClusterSettings;
+ /** @deprecated since v16.0.0 - use setupPrimary. */
setupMaster(settings?: ClusterSettings): void;
- worker?: Worker | undefined;
- workers?: NodeJS.Dict | undefined;
-
+ /**
+ * `setupPrimary` is used to change the default 'fork' behavior. Once called, the settings will be present in cluster.settings.
+ */
+ setupPrimary(settings?: ClusterSettings): void;
+ readonly worker?: Worker | undefined;
+ readonly workers?: NodeJS.Dict | undefined;
readonly SCHED_NONE: number;
readonly SCHED_RR: number;
-
/**
* events.EventEmitter
* 1. disconnect
@@ -119,150 +358,60 @@ declare module 'cluster' {
* 7. setup
*/
addListener(event: string, listener: (...args: any[]) => void): this;
- addListener(event: "disconnect", listener: (worker: Worker) => void): this;
- addListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this;
- addListener(event: "fork", listener: (worker: Worker) => void): this;
- addListener(event: "listening", listener: (worker: Worker, address: Address) => void): this;
- addListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
- addListener(event: "online", listener: (worker: Worker) => void): this;
- addListener(event: "setup", listener: (settings: ClusterSettings) => void): this;
-
+ addListener(event: 'disconnect', listener: (worker: Worker) => void): this;
+ addListener(event: 'exit', listener: (worker: Worker, code: number, signal: string) => void): this;
+ addListener(event: 'fork', listener: (worker: Worker) => void): this;
+ addListener(event: 'listening', listener: (worker: Worker, address: Address) => void): this;
+ addListener(event: 'message', listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
+ addListener(event: 'online', listener: (worker: Worker) => void): this;
+ addListener(event: 'setup', listener: (settings: ClusterSettings) => void): this;
emit(event: string | symbol, ...args: any[]): boolean;
- emit(event: "disconnect", worker: Worker): boolean;
- emit(event: "exit", worker: Worker, code: number, signal: string): boolean;
- emit(event: "fork", worker: Worker): boolean;
- emit(event: "listening", worker: Worker, address: Address): boolean;
- emit(event: "message", worker: Worker, message: any, handle: net.Socket | net.Server): boolean;
- emit(event: "online", worker: Worker): boolean;
- emit(event: "setup", settings: ClusterSettings): boolean;
-
+ emit(event: 'disconnect', worker: Worker): boolean;
+ emit(event: 'exit', worker: Worker, code: number, signal: string): boolean;
+ emit(event: 'fork', worker: Worker): boolean;
+ emit(event: 'listening', worker: Worker, address: Address): boolean;
+ emit(event: 'message', worker: Worker, message: any, handle: net.Socket | net.Server): boolean;
+ emit(event: 'online', worker: Worker): boolean;
+ emit(event: 'setup', settings: ClusterSettings): boolean;
on(event: string, listener: (...args: any[]) => void): this;
- on(event: "disconnect", listener: (worker: Worker) => void): this;
- on(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this;
- on(event: "fork", listener: (worker: Worker) => void): this;
- on(event: "listening", listener: (worker: Worker, address: Address) => void): this;
- on(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
- on(event: "online", listener: (worker: Worker) => void): this;
- on(event: "setup", listener: (settings: ClusterSettings) => void): this;
-
+ on(event: 'disconnect', listener: (worker: Worker) => void): this;
+ on(event: 'exit', listener: (worker: Worker, code: number, signal: string) => void): this;
+ on(event: 'fork', listener: (worker: Worker) => void): this;
+ on(event: 'listening', listener: (worker: Worker, address: Address) => void): this;
+ on(event: 'message', listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
+ on(event: 'online', listener: (worker: Worker) => void): this;
+ on(event: 'setup', listener: (settings: ClusterSettings) => void): this;
once(event: string, listener: (...args: any[]) => void): this;
- once(event: "disconnect", listener: (worker: Worker) => void): this;
- once(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this;
- once(event: "fork", listener: (worker: Worker) => void): this;
- once(event: "listening", listener: (worker: Worker, address: Address) => void): this;
- once(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
- once(event: "online", listener: (worker: Worker) => void): this;
- once(event: "setup", listener: (settings: ClusterSettings) => void): this;
-
+ once(event: 'disconnect', listener: (worker: Worker) => void): this;
+ once(event: 'exit', listener: (worker: Worker, code: number, signal: string) => void): this;
+ once(event: 'fork', listener: (worker: Worker) => void): this;
+ once(event: 'listening', listener: (worker: Worker, address: Address) => void): this;
+ once(event: 'message', listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
+ once(event: 'online', listener: (worker: Worker) => void): this;
+ once(event: 'setup', listener: (settings: ClusterSettings) => void): this;
prependListener(event: string, listener: (...args: any[]) => void): this;
- prependListener(event: "disconnect", listener: (worker: Worker) => void): this;
- prependListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this;
- prependListener(event: "fork", listener: (worker: Worker) => void): this;
- prependListener(event: "listening", listener: (worker: Worker, address: Address) => void): this;
- prependListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
- prependListener(event: "online", listener: (worker: Worker) => void): this;
- prependListener(event: "setup", listener: (settings: ClusterSettings) => void): this;
-
- prependOnceListener(event: string, listener: (...args: any[]) => void): this;
- prependOnceListener(event: "disconnect", listener: (worker: Worker) => void): this;
- prependOnceListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this;
- prependOnceListener(event: "fork", listener: (worker: Worker) => void): this;
- prependOnceListener(event: "listening", listener: (worker: Worker, address: Address) => void): this;
+ prependListener(event: 'disconnect', listener: (worker: Worker) => void): this;
+ prependListener(event: 'exit', listener: (worker: Worker, code: number, signal: string) => void): this;
+ prependListener(event: 'fork', listener: (worker: Worker) => void): this;
+ prependListener(event: 'listening', listener: (worker: Worker, address: Address) => void): this;
// the handle is a net.Socket or net.Server object, or undefined.
- prependOnceListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this;
- prependOnceListener(event: "online", listener: (worker: Worker) => void): this;
- prependOnceListener(event: "setup", listener: (settings: ClusterSettings) => void): this;
+ prependListener(event: 'message', listener: (worker: Worker, message: any, handle?: net.Socket | net.Server) => void): this;
+ prependListener(event: 'online', listener: (worker: Worker) => void): this;
+ prependListener(event: 'setup', listener: (settings: ClusterSettings) => void): this;
+ prependOnceListener(event: string, listener: (...args: any[]) => void): this;
+ prependOnceListener(event: 'disconnect', listener: (worker: Worker) => void): this;
+ prependOnceListener(event: 'exit', listener: (worker: Worker, code: number, signal: string) => void): this;
+ prependOnceListener(event: 'fork', listener: (worker: Worker) => void): this;
+ prependOnceListener(event: 'listening', listener: (worker: Worker, address: Address) => void): this;
+ // the handle is a net.Socket or net.Server object, or undefined.
+ prependOnceListener(event: 'message', listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this;
+ prependOnceListener(event: 'online', listener: (worker: Worker) => void): this;
+ prependOnceListener(event: 'setup', listener: (settings: ClusterSettings) => void): this;
}
-
- const SCHED_NONE: number;
- const SCHED_RR: number;
-
- function disconnect(callback?: () => void): void;
- function fork(env?: any): Worker;
- const isMaster: boolean;
- const isWorker: boolean;
- let schedulingPolicy: number;
- const settings: ClusterSettings;
- function setupMaster(settings?: ClusterSettings): void;
- const worker: Worker;
- const workers: NodeJS.Dict;
-
- /**
- * events.EventEmitter
- * 1. disconnect
- * 2. exit
- * 3. fork
- * 4. listening
- * 5. message
- * 6. online
- * 7. setup
- */
- function addListener(event: string, listener: (...args: any[]) => void): Cluster;
- function addListener(event: "disconnect", listener: (worker: Worker) => void): Cluster;
- function addListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster;
- function addListener(event: "fork", listener: (worker: Worker) => void): Cluster;
- function addListener(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster;
- // the handle is a net.Socket or net.Server object, or undefined.
- function addListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster;
- function addListener(event: "online", listener: (worker: Worker) => void): Cluster;
- function addListener(event: "setup", listener: (settings: ClusterSettings) => void): Cluster;
-
- function emit(event: string | symbol, ...args: any[]): boolean;
- function emit(event: "disconnect", worker: Worker): boolean;
- function emit(event: "exit", worker: Worker, code: number, signal: string): boolean;
- function emit(event: "fork", worker: Worker): boolean;
- function emit(event: "listening", worker: Worker, address: Address): boolean;
- function emit(event: "message", worker: Worker, message: any, handle: net.Socket | net.Server): boolean;
- function emit(event: "online", worker: Worker): boolean;
- function emit(event: "setup", settings: ClusterSettings): boolean;
-
- function on(event: string, listener: (...args: any[]) => void): Cluster;
- function on(event: "disconnect", listener: (worker: Worker) => void): Cluster;
- function on(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster;
- function on(event: "fork", listener: (worker: Worker) => void): Cluster;
- function on(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster;
- function on(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster; // the handle is a net.Socket or net.Server object, or undefined.
- function on(event: "online", listener: (worker: Worker) => void): Cluster;
- function on(event: "setup", listener: (settings: ClusterSettings) => void): Cluster;
-
- function once(event: string, listener: (...args: any[]) => void): Cluster;
- function once(event: "disconnect", listener: (worker: Worker) => void): Cluster;
- function once(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster;
- function once(event: "fork", listener: (worker: Worker) => void): Cluster;
- function once(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster;
- function once(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster; // the handle is a net.Socket or net.Server object, or undefined.
- function once(event: "online", listener: (worker: Worker) => void): Cluster;
- function once(event: "setup", listener: (settings: ClusterSettings) => void): Cluster;
-
- function removeListener(event: string, listener: (...args: any[]) => void): Cluster;
- function removeAllListeners(event?: string): Cluster;
- function setMaxListeners(n: number): Cluster;
- function getMaxListeners(): number;
- function listeners(event: string): Function[];
- function listenerCount(type: string): number;
-
- function prependListener(event: string, listener: (...args: any[]) => void): Cluster;
- function prependListener(event: "disconnect", listener: (worker: Worker) => void): Cluster;
- function prependListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster;
- function prependListener(event: "fork", listener: (worker: Worker) => void): Cluster;
- function prependListener(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster;
- // the handle is a net.Socket or net.Server object, or undefined.
- function prependListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster;
- function prependListener(event: "online", listener: (worker: Worker) => void): Cluster;
- function prependListener(event: "setup", listener: (settings: ClusterSettings) => void): Cluster;
-
- function prependOnceListener(event: string, listener: (...args: any[]) => void): Cluster;
- function prependOnceListener(event: "disconnect", listener: (worker: Worker) => void): Cluster;
- function prependOnceListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster;
- function prependOnceListener(event: "fork", listener: (worker: Worker) => void): Cluster;
- function prependOnceListener(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster;
- // the handle is a net.Socket or net.Server object, or undefined.
- function prependOnceListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster;
- function prependOnceListener(event: "online", listener: (worker: Worker) => void): Cluster;
- function prependOnceListener(event: "setup", listener: (settings: ClusterSettings) => void): Cluster;
-
- function eventNames(): string[];
+ const cluster: Cluster;
+ export default cluster;
}
declare module 'node:cluster' {
export * from 'cluster';
+ export { default as default } from 'cluster';
}
diff --git a/packages/node_modules/@node-red/editor-client/src/types/node/console.d.ts b/packages/node_modules/@node-red/editor-client/src/types/node/console.d.ts
index f89ecaa57..7dae84bd4 100644
--- a/packages/node_modules/@node-red/editor-client/src/types/node/console.d.ts
+++ b/packages/node_modules/@node-red/editor-client/src/types/node/console.d.ts
@@ -1,100 +1,321 @@
/* NOTE: Do not edit directly! This file is generated using `npm run update-types` in https://github.com/Steve-Mcl/monaco-editor-esm-i18n */
+/**
+ * The `console` module provides a simple debugging console that is similar to the
+ * JavaScript console mechanism provided by web browsers.
+ *
+ * The module exports two specific components:
+ *
+ * * A `Console` class with methods such as `console.log()`, `console.error()` and`console.warn()` that can be used to write to any Node.js stream.
+ * * A global `console` instance configured to write to `process.stdout` and `process.stderr`. The global `console` can be used without calling`require('console')`.
+ *
+ * _**Warning**_: The global console object's methods are neither consistently
+ * synchronous like the browser APIs they resemble, nor are they consistently
+ * asynchronous like all other Node.js streams. See the `note on process I/O` for
+ * more information.
+ *
+ * Example using the global `console`:
+ *
+ * ```js
+ * console.log('hello world');
+ * // Prints: hello world, to stdout
+ * console.log('hello %s', 'world');
+ * // Prints: hello world, to stdout
+ * console.error(new Error('Whoops, something bad happened'));
+ * // Prints error message and stack trace to stderr:
+ * // Error: Whoops, something bad happened
+ * // at [eval]:5:15
+ * // at Script.runInThisContext (node:vm:132:18)
+ * // at Object.runInThisContext (node:vm:309:38)
+ * // at node:internal/process/execution:77:19
+ * // at [eval]-wrapper:6:22
+ * // at evalScript (node:internal/process/execution:76:60)
+ * // at node:internal/main/eval_string:23:3
+ *
+ * const name = 'Will Robinson';
+ * console.warn(`Danger ${name}! Danger!`);
+ * // Prints: Danger Will Robinson! Danger!, to stderr
+ * ```
+ *
+ * Example using the `Console` class:
+ *
+ * ```js
+ * const out = getStreamSomehow();
+ * const err = getStreamSomehow();
+ * const myConsole = new console.Console(out, err);
+ *
+ * myConsole.log('hello world');
+ * // Prints: hello world, to out
+ * myConsole.log('hello %s', 'world');
+ * // Prints: hello world, to out
+ * myConsole.error(new Error('Whoops, something bad happened'));
+ * // Prints: [Error: Whoops, something bad happened], to err
+ *
+ * const name = 'Will Robinson';
+ * myConsole.warn(`Danger ${name}! Danger!`);
+ * // Prints: Danger Will Robinson! Danger!, to err
+ * ```
+ * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/console.js)
+ */
declare module 'console' {
import console = require('node:console');
export = console;
}
declare module 'node:console' {
- import { InspectOptions } from 'util';
-
+ import { InspectOptions } from 'node:util';
global {
// This needs to be global to avoid TS2403 in case lib.dom.d.ts is present in the same build
interface Console {
- Console: NodeJS.ConsoleConstructor;
+ Console: console.ConsoleConstructor;
/**
- * A simple assertion test that verifies whether `value` is truthy.
- * If it is not, an `AssertionError` is thrown.
- * If provided, the error `message` is formatted using `util.format()` and used as the error message.
+ * `console.assert()` writes a message if `value` is [falsy](https://developer.mozilla.org/en-US/docs/Glossary/Falsy) or omitted. It only
+ * writes a message and does not otherwise affect execution. The output always
+ * starts with `"Assertion failed"`. If provided, `message` is formatted using `util.format()`.
+ *
+ * If `value` is [truthy](https://developer.mozilla.org/en-US/docs/Glossary/Truthy), nothing happens.
+ *
+ * ```js
+ * console.assert(true, 'does nothing');
+ *
+ * console.assert(false, 'Whoops %s work', 'didn\'t');
+ * // Assertion failed: Whoops didn't work
+ *
+ * console.assert();
+ * // Assertion failed
+ * ```
+ * @since v0.1.101
+ * @param value The value tested for being truthy.
+ * @param message All arguments besides `value` are used as error message.
*/
assert(value: any, message?: string, ...optionalParams: any[]): void;
/**
- * When `stdout` is a TTY, calling `console.clear()` will attempt to clear the TTY.
- * When `stdout` is not a TTY, this method does nothing.
+ * When `stdout` is a TTY, calling `console.clear()` will attempt to clear the
+ * TTY. When `stdout` is not a TTY, this method does nothing.
+ *
+ * The specific operation of `console.clear()` can vary across operating systems
+ * and terminal types. For most Linux operating systems, `console.clear()`operates similarly to the `clear` shell command. On Windows, `console.clear()`will clear only the output in the
+ * current terminal viewport for the Node.js
+ * binary.
+ * @since v8.3.0
*/
clear(): void;
/**
- * Maintains an internal counter specific to `label` and outputs to `stdout` the number of times `console.count()` has been called with the given `label`.
+ * Maintains an internal counter specific to `label` and outputs to `stdout` the
+ * number of times `console.count()` has been called with the given `label`.
+ *
+ * ```js
+ * > console.count()
+ * default: 1
+ * undefined
+ * > console.count('default')
+ * default: 2
+ * undefined
+ * > console.count('abc')
+ * abc: 1
+ * undefined
+ * > console.count('xyz')
+ * xyz: 1
+ * undefined
+ * > console.count('abc')
+ * abc: 2
+ * undefined
+ * > console.count()
+ * default: 3
+ * undefined
+ * >
+ * ```
+ * @since v8.3.0
+ * @param label The display label for the counter.
*/
count(label?: string): void;
/**
* Resets the internal counter specific to `label`.
+ *
+ * ```js
+ * > console.count('abc');
+ * abc: 1
+ * undefined
+ * > console.countReset('abc');
+ * undefined
+ * > console.count('abc');
+ * abc: 1
+ * undefined
+ * >
+ * ```
+ * @since v8.3.0
+ * @param label The display label for the counter.
*/
countReset(label?: string): void;
/**
- * The `console.debug()` function is an alias for {@link console.log}.
+ * The `console.debug()` function is an alias for {@link log}.
+ * @since v8.0.0
*/
debug(message?: any, ...optionalParams: any[]): void;
/**
- * Uses {@link util.inspect} on `obj` and prints the resulting string to `stdout`.
+ * Uses `util.inspect()` on `obj` and prints the resulting string to `stdout`.
* This function bypasses any custom `inspect()` function defined on `obj`.
+ * @since v0.1.101
*/
dir(obj: any, options?: InspectOptions): void;
/**
- * This method calls {@link console.log} passing it the arguments received. Please note that this method does not produce any XML formatting
+ * This method calls `console.log()` passing it the arguments received.
+ * This method does not produce any XML formatting.
+ * @since v8.0.0
*/
dirxml(...data: any[]): void;
/**
- * Prints to `stderr` with newline.
+ * Prints to `stderr` with newline. Multiple arguments can be passed, with the
+ * first used as the primary message and all additional used as substitution
+ * values similar to [`printf(3)`](http://man7.org/linux/man-pages/man3/printf.3.html) (the arguments are all passed to `util.format()`).
+ *
+ * ```js
+ * const code = 5;
+ * console.error('error #%d', code);
+ * // Prints: error #5, to stderr
+ * console.error('error', code);
+ * // Prints: error 5, to stderr
+ * ```
+ *
+ * If formatting elements (e.g. `%d`) are not found in the first string then `util.inspect()` is called on each argument and the resulting string
+ * values are concatenated. See `util.format()` for more information.
+ * @since v0.1.100
*/
error(message?: any, ...optionalParams: any[]): void;
/**
- * Increases indentation of subsequent lines by two spaces.
- * If one or more `label`s are provided, those are printed first without the additional indentation.
+ * Increases indentation of subsequent lines by spaces for `groupIndentation`length.
+ *
+ * If one or more `label`s are provided, those are printed first without the
+ * additional indentation.
+ * @since v8.5.0
*/
group(...label: any[]): void;
/**
- * The `console.groupCollapsed()` function is an alias for {@link console.group}.
+ * An alias for {@link group}.
+ * @since v8.5.0
*/
groupCollapsed(...label: any[]): void;
/**
- * Decreases indentation of subsequent lines by two spaces.
+ * Decreases indentation of subsequent lines by spaces for `groupIndentation`length.
+ * @since v8.5.0
*/
groupEnd(): void;
/**
- * The {@link console.info} function is an alias for {@link console.log}.
+ * The `console.info()` function is an alias for {@link log}.
+ * @since v0.1.100
*/
info(message?: any, ...optionalParams: any[]): void;
/**
- * Prints to `stdout` with newline.
+ * Prints to `stdout` with newline. Multiple arguments can be passed, with the
+ * first used as the primary message and all additional used as substitution
+ * values similar to [`printf(3)`](http://man7.org/linux/man-pages/man3/printf.3.html) (the arguments are all passed to `util.format()`).
+ *
+ * ```js
+ * const count = 5;
+ * console.log('count: %d', count);
+ * // Prints: count: 5, to stdout
+ * console.log('count:', count);
+ * // Prints: count: 5, to stdout
+ * ```
+ *
+ * See `util.format()` for more information.
+ * @since v0.1.100
*/
log(message?: any, ...optionalParams: any[]): void;
/**
- * This method does not display anything unless used in the inspector.
- * Prints to `stdout` the array `array` formatted as a table.
+ * Try to construct a table with the columns of the properties of `tabularData`(or use `properties`) and rows of `tabularData` and log it. Falls back to just
+ * logging the argument if it can’t be parsed as tabular.
+ *
+ * ```js
+ * // These can't be parsed as tabular data
+ * console.table(Symbol());
+ * // Symbol()
+ *
+ * console.table(undefined);
+ * // undefined
+ *
+ * console.table([{ a: 1, b: 'Y' }, { a: 'Z', b: 2 }]);
+ * // ┌─────────┬─────┬─────┐
+ * // │ (index) │ a │ b │
+ * // ├─────────┼─────┼─────┤
+ * // │ 0 │ 1 │ 'Y' │
+ * // │ 1 │ 'Z' │ 2 │
+ * // └─────────┴─────┴─────┘
+ *
+ * console.table([{ a: 1, b: 'Y' }, { a: 'Z', b: 2 }], ['a']);
+ * // ┌─────────┬─────┐
+ * // │ (index) │ a │
+ * // ├─────────┼─────┤
+ * // │ 0 │ 1 │
+ * // │ 1 │ 'Z' │
+ * // └─────────┴─────┘
+ * ```
+ * @since v10.0.0
+ * @param properties Alternate properties for constructing the table.
*/
table(tabularData: any, properties?: ReadonlyArray): void;
/**
- * Starts a timer that can be used to compute the duration of an operation. Timers are identified by a unique `label`.
+ * Starts a timer that can be used to compute the duration of an operation. Timers
+ * are identified by a unique `label`. Use the same `label` when calling {@link timeEnd} to stop the timer and output the elapsed time in
+ * suitable time units to `stdout`. For example, if the elapsed
+ * time is 3869ms, `console.timeEnd()` displays "3.869s".
+ * @since v0.1.104
*/
time(label?: string): void;
/**
- * Stops a timer that was previously started by calling {@link console.time} and prints the result to `stdout`.
+ * Stops a timer that was previously started by calling {@link time} and
+ * prints the result to `stdout`:
+ *
+ * ```js
+ * console.time('100-elements');
+ * for (let i = 0; i < 100; i++) {}
+ * console.timeEnd('100-elements');
+ * // prints 100-elements: 225.438ms
+ * ```
+ * @since v0.1.104
*/
timeEnd(label?: string): void;
/**
- * For a timer that was previously started by calling {@link console.time}, prints the elapsed time and other `data` arguments to `stdout`.
+ * For a timer that was previously started by calling {@link time}, prints
+ * the elapsed time and other `data` arguments to `stdout`:
+ *
+ * ```js
+ * console.time('process');
+ * const value = expensiveProcess1(); // Returns 42
+ * console.timeLog('process', value);
+ * // Prints "process: 365.227ms 42".
+ * doExpensiveProcess2(value);
+ * console.timeEnd('process');
+ * ```
+ * @since v10.7.0
*/
timeLog(label?: string, ...data: any[]): void;
/**
- * Prints to `stderr` the string 'Trace :', followed by the {@link util.format} formatted message and stack trace to the current position in the code.
+ * Prints to `stderr` the string `'Trace: '`, followed by the `util.format()` formatted message and stack trace to the current position in the code.
+ *
+ * ```js
+ * console.trace('Show me');
+ * // Prints: (stack trace will vary based on where trace is called)
+ * // Trace: Show me
+ * // at repl:2:9
+ * // at REPLServer.defaultEval (repl.js:248:27)
+ * // at bound (domain.js:287:14)
+ * // at REPLServer.runBound [as eval] (domain.js:300:12)
+ * // at REPLServer. (repl.js:412:12)
+ * // at emitOne (events.js:82:20)
+ * // at REPLServer.emit (events.js:169:7)
+ * // at REPLServer.Interface._onLine (readline.js:210:10)
+ * // at REPLServer.Interface._line (readline.js:549:8)
+ * // at REPLServer.Interface._ttyWrite (readline.js:826:14)
+ * ```
+ * @since v0.1.104
*/
trace(message?: any, ...optionalParams: any[]): void;
/**
- * The {@link console.warn} function is an alias for {@link console.error}.
+ * The `console.warn()` function is an alias for {@link error}.
+ * @since v0.1.100
*/
warn(message?: any, ...optionalParams: any[]): void;
-
// --- Inspector mode only ---
/**
* This method does not display anything unless used in the inspector.
@@ -112,13 +333,67 @@ declare module 'node:console' {
*/
timeStamp(label?: string): void;
}
-
- var console: Console;
-
- namespace NodeJS {
+ /**
+ * The `console` module provides a simple debugging console that is similar to the
+ * JavaScript console mechanism provided by web browsers.
+ *
+ * The module exports two specific components:
+ *
+ * * A `Console` class with methods such as `console.log()`, `console.error()` and`console.warn()` that can be used to write to any Node.js stream.
+ * * A global `console` instance configured to write to `process.stdout` and `process.stderr`. The global `console` can be used without calling`require('console')`.
+ *
+ * _**Warning**_: The global console object's methods are neither consistently
+ * synchronous like the browser APIs they resemble, nor are they consistently
+ * asynchronous like all other Node.js streams. See the `note on process I/O` for
+ * more information.
+ *
+ * Example using the global `console`:
+ *
+ * ```js
+ * console.log('hello world');
+ * // Prints: hello world, to stdout
+ * console.log('hello %s', 'world');
+ * // Prints: hello world, to stdout
+ * console.error(new Error('Whoops, something bad happened'));
+ * // Prints error message and stack trace to stderr:
+ * // Error: Whoops, something bad happened
+ * // at [eval]:5:15
+ * // at Script.runInThisContext (node:vm:132:18)
+ * // at Object.runInThisContext (node:vm:309:38)
+ * // at node:internal/process/execution:77:19
+ * // at [eval]-wrapper:6:22
+ * // at evalScript (node:internal/process/execution:76:60)
+ * // at node:internal/main/eval_string:23:3
+ *
+ * const name = 'Will Robinson';
+ * console.warn(`Danger ${name}! Danger!`);
+ * // Prints: Danger Will Robinson! Danger!, to stderr
+ * ```
+ *
+ * Example using the `Console` class:
+ *
+ * ```js
+ * const out = getStreamSomehow();
+ * const err = getStreamSomehow();
+ * const myConsole = new console.Console(out, err);
+ *
+ * myConsole.log('hello world');
+ * // Prints: hello world, to out
+ * myConsole.log('hello %s', 'world');
+ * // Prints: hello world, to out
+ * myConsole.error(new Error('Whoops, something bad happened'));
+ * // Prints: [Error: Whoops, something bad happened], to err
+ *
+ * const name = 'Will Robinson';
+ * myConsole.warn(`Danger ${name}! Danger!`);
+ * // Prints: Danger Will Robinson! Danger!, to err
+ * ```
+ * @see [source](https://github.com/nodejs/node/blob/v16.4.2/lib/console.js)
+ */
+ namespace console {
interface ConsoleConstructorOptions {
- stdout: WritableStream;
- stderr?: WritableStream | undefined;
+ stdout: NodeJS.WritableStream;
+ stderr?: NodeJS.WritableStream | undefined;
ignoreErrors?: boolean | undefined;
colorMode?: boolean | 'auto' | undefined;
inspectOptions?: InspectOptions | undefined;
@@ -126,20 +401,15 @@ declare module 'node:console' {
* Set group indentation
* @default 2
*/
- groupIndentation?: number | undefined;
+ groupIndentation?: number | undefined;
}
-
interface ConsoleConstructor {
prototype: Console;
- new(stdout: WritableStream, stderr?: WritableStream, ignoreErrors?: boolean): Console;
- new(options: ConsoleConstructorOptions): Console;
- }
-
- interface Global {
- console: typeof console;
+ new (stdout: NodeJS.WritableStream, stderr?: NodeJS.WritableStream, ignoreErrors?: boolean): Console;
+ new (options: ConsoleConstructorOptions): Console;
}
}
+ var console: Console;
}
-
- export = console;
+ export = globalThis.console;
}
diff --git a/packages/node_modules/@node-red/editor-client/src/types/node/crypto.d.ts b/packages/node_modules/@node-red/editor-client/src/types/node/crypto.d.ts
index 4085825c6..7983fc0c0 100644
--- a/packages/node_modules/@node-red/editor-client/src/types/node/crypto.d.ts
+++ b/packages/node_modules/@node-red/editor-client/src/types/node/crypto.d.ts
@@ -1,10 +1,55 @@
/* NOTE: Do not edit directly! This file is generated using `npm run update-types` in https://github.com/Steve-Mcl/monaco-editor-esm-i18n */
+/**
+ * The `crypto` module provides cryptographic functionality that includes a set of
+ * wrappers for OpenSSL's hash, HMAC, cipher, decipher, sign, and verify functions.
+ *
+ * ```js
+ * const { createHmac } = await import('crypto');
+ *
+ * const secret = 'abcdefg';
+ * const hash = createHmac('sha256', secret)
+ * .update('I love cupcakes')
+ * .digest('hex');
+ * console.log(hash);
+ * // Prints:
+ * // c0fa1bc00531bd78ef38c628449c5102aeabd49b5dc3a2a516ea6ea959d6658e
+ * ```
+ * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/crypto.js)
+ */
declare module 'crypto' {
- import * as stream from 'stream';
-
+ import * as stream from 'node:stream';
+ import { PeerCertificate } from 'node:tls';
interface Certificate {
+ /**
+ * @deprecated
+ * @param spkac
+ * @returns The challenge component of the `spkac` data structure,
+ * which includes a public key and a challenge.
+ */
+ exportChallenge(spkac: BinaryLike): Buffer;
+ /**
+ * @deprecated
+ * @param spkac
+ * @param encoding The encoding of the spkac string.
+ * @returns The public key component of the `spkac` data structure,
+ * which includes a public key and a challenge.
+ */
+ exportPublicKey(spkac: BinaryLike, encoding?: string): Buffer;
+ /**
+ * @deprecated
+ * @param spkac
+ * @returns `true` if the given `spkac` data structure is valid,
+ * `false` otherwise.
+ */
+ verifySpkac(spkac: NodeJS.ArrayBufferView): boolean;
+ }
+ const Certificate: Certificate & {
+ /** @deprecated since v14.9.0 - Use static methods of `crypto.Certificate` instead. */
+ new (): Certificate;
+ /** @deprecated since v14.9.0 - Use static methods of `crypto.Certificate` instead. */
+ (): Certificate;
/**
* @param spkac
* @returns The challenge component of the `spkac` data structure,
@@ -24,18 +69,10 @@ declare module 'crypto' {
* `false` otherwise.
*/
verifySpkac(spkac: NodeJS.ArrayBufferView): boolean;
- }
- const Certificate: Certificate & {
- /** @deprecated since v14.9.0 - Use static methods of `crypto.Certificate` instead. */
- new (): Certificate;
- /** @deprecated since v14.9.0 - Use static methods of `crypto.Certificate` instead. */
- (): Certificate;
};
-
namespace constants {
// https://nodejs.org/dist/latest-v10.x/docs/api/crypto.html#crypto_crypto_constants
const OPENSSL_VERSION_NUMBER: number;
-
/** Applies multiple bug workarounds within OpenSSL. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_options.html for detail. */
const SSL_OP_ALL: number;
/** Allows legacy insecure renegotiation between OpenSSL and unpatched clients or servers. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_options.html. */
@@ -85,7 +122,6 @@ declare module 'crypto' {
const SSL_OP_TLS_D5_BUG: number;
/** Instructs OpenSSL to disable version rollback attack detection. */
const SSL_OP_TLS_ROLLBACK_BUG: number;
-
const ENGINE_METHOD_RSA: number;
const ENGINE_METHOD_DSA: number;
const ENGINE_METHOD_DH: number;
@@ -97,14 +133,11 @@ declare module 'crypto' {
const ENGINE_METHOD_PKEY_ASN1_METHS: number;
const ENGINE_METHOD_ALL: number;
const ENGINE_METHOD_NONE: number;
-
const DH_CHECK_P_NOT_SAFE_PRIME: number;
const DH_CHECK_P_NOT_PRIME: number;
const DH_UNABLE_TO_CHECK_GENERATOR: number;
const DH_NOT_SUITABLE_GENERATOR: number;
-
const ALPN_ENABLED: number;
-
const RSA_PKCS1_PADDING: number;
const RSA_SSLV23_PADDING: number;
const RSA_NO_PADDING: number;
@@ -117,17 +150,14 @@ declare module 'crypto' {
const RSA_PSS_SALTLEN_MAX_SIGN: number;
/** Causes the salt length for RSA_PKCS1_PSS_PADDING to be determined automatically when verifying a signature. */
const RSA_PSS_SALTLEN_AUTO: number;
-
const POINT_CONVERSION_COMPRESSED: number;
const POINT_CONVERSION_UNCOMPRESSED: number;
const POINT_CONVERSION_HYBRID: number;
-
/** Specifies the built-in default cipher list used by Node.js (colon-separated values). */
const defaultCoreCipherList: string;
/** Specifies the active default cipher list used by the current Node.js process (colon-separated values). */
const defaultCipherList: string;
}
-
interface HashOptions extends stream.TransformOptions {
/**
* For XOF hash functions such as `shake256`, the
@@ -135,188 +165,1104 @@ declare module 'crypto' {
*/
outputLength?: number | undefined;
}
-
/** @deprecated since v10.0.0 */
const fips: boolean;
-
+ /**
+ * Creates and returns a `Hash` object that can be used to generate hash digests
+ * using the given `algorithm`. Optional `options` argument controls stream
+ * behavior. For XOF hash functions such as `'shake256'`, the `outputLength` option
+ * can be used to specify the desired output length in bytes.
+ *
+ * The `algorithm` is dependent on the available algorithms supported by the
+ * version of OpenSSL on the platform. Examples are `'sha256'`, `'sha512'`, etc.
+ * On recent releases of OpenSSL, `openssl list -digest-algorithms`(`openssl list-message-digest-algorithms` for older versions of OpenSSL) will
+ * display the available digest algorithms.
+ *
+ * Example: generating the sha256 sum of a file
+ *
+ * ```js
+ * import {
+ * createReadStream
+ * } from 'fs';
+ * import { argv } from 'process';
+ * const {
+ * createHash
+ * } = await import('crypto');
+ *
+ * const filename = argv[2];
+ *
+ * const hash = createHash('sha256');
+ *
+ * const input = createReadStream(filename);
+ * input.on('readable', () => {
+ * // Only one element is going to be produced by the
+ * // hash stream.
+ * const data = input.read();
+ * if (data)
+ * hash.update(data);
+ * else {
+ * console.log(`${hash.digest('hex')} ${filename}`);
+ * }
+ * });
+ * ```
+ * @since v0.1.92
+ * @param options `stream.transform` options
+ */
function createHash(algorithm: string, options?: HashOptions): Hash;
+ /**
+ * Creates and returns an `Hmac` object that uses the given `algorithm` and `key`.
+ * Optional `options` argument controls stream behavior.
+ *
+ * The `algorithm` is dependent on the available algorithms supported by the
+ * version of OpenSSL on the platform. Examples are `'sha256'`, `'sha512'`, etc.
+ * On recent releases of OpenSSL, `openssl list -digest-algorithms`(`openssl list-message-digest-algorithms` for older versions of OpenSSL) will
+ * display the available digest algorithms.
+ *
+ * The `key` is the HMAC key used to generate the cryptographic HMAC hash. If it is
+ * a `KeyObject`, its type must be `secret`.
+ *
+ * Example: generating the sha256 HMAC of a file
+ *
+ * ```js
+ * import {
+ * createReadStream
+ * } from 'fs';
+ * import { argv } from 'process';
+ * const {
+ * createHmac
+ * } = await import('crypto');
+ *
+ * const filename = argv[2];
+ *
+ * const hmac = createHmac('sha256', 'a secret');
+ *
+ * const input = createReadStream(filename);
+ * input.on('readable', () => {
+ * // Only one element is going to be produced by the
+ * // hash stream.
+ * const data = input.read();
+ * if (data)
+ * hmac.update(data);
+ * else {
+ * console.log(`${hmac.digest('hex')} ${filename}`);
+ * }
+ * });
+ * ```
+ * @since v0.1.94
+ * @param options `stream.transform` options
+ */
function createHmac(algorithm: string, key: BinaryLike | KeyObject, options?: stream.TransformOptions): Hmac;
-
// https://nodejs.org/api/buffer.html#buffer_buffers_and_character_encodings
type BinaryToTextEncoding = 'base64' | 'base64url' | 'hex';
type CharacterEncoding = 'utf8' | 'utf-8' | 'utf16le' | 'latin1';
type LegacyCharacterEncoding = 'ascii' | 'binary' | 'ucs2' | 'ucs-2';
-
type Encoding = BinaryToTextEncoding | CharacterEncoding | LegacyCharacterEncoding;
-
type ECDHKeyFormat = 'compressed' | 'uncompressed' | 'hybrid';
-
+ /**
+ * The `Hash` class is a utility for creating hash digests of data. It can be
+ * used in one of two ways:
+ *
+ * * As a `stream` that is both readable and writable, where data is written
+ * to produce a computed hash digest on the readable side, or
+ * * Using the `hash.update()` and `hash.digest()` methods to produce the
+ * computed hash.
+ *
+ * The {@link createHash} method is used to create `Hash` instances. `Hash`objects are not to be created directly using the `new` keyword.
+ *
+ * Example: Using `Hash` objects as streams:
+ *
+ * ```js
+ * const {
+ * createHash
+ * } = await import('crypto');
+ *
+ * const hash = createHash('sha256');
+ *
+ * hash.on('readable', () => {
+ * // Only one element is going to be produced by the
+ * // hash stream.
+ * const data = hash.read();
+ * if (data) {
+ * console.log(data.toString('hex'));
+ * // Prints:
+ * // 6a2da20943931e9834fc12cfe5bb47bbd9ae43489a30726962b576f4e3993e50
+ * }
+ * });
+ *
+ * hash.write('some data to hash');
+ * hash.end();
+ * ```
+ *
+ * Example: Using `Hash` and piped streams:
+ *
+ * ```js
+ * import { createReadStream } from 'fs';
+ * import { stdout } from 'process';
+ * const { createHash } = await import('crypto');
+ *
+ * const hash = createHash('sha256');
+ *
+ * const input = createReadStream('test.js');
+ * input.pipe(hash).setEncoding('hex').pipe(stdout);
+ * ```
+ *
+ * Example: Using the `hash.update()` and `hash.digest()` methods:
+ *
+ * ```js
+ * const {
+ * createHash
+ * } = await import('crypto');
+ *
+ * const hash = createHash('sha256');
+ *
+ * hash.update('some data to hash');
+ * console.log(hash.digest('hex'));
+ * // Prints:
+ * // 6a2da20943931e9834fc12cfe5bb47bbd9ae43489a30726962b576f4e3993e50
+ * ```
+ * @since v0.1.92
+ */
class Hash extends stream.Transform {
private constructor();
- copy(): Hash;
+ /**
+ * Creates a new `Hash` object that contains a deep copy of the internal state
+ * of the current `Hash` object.
+ *
+ * The optional `options` argument controls stream behavior. For XOF hash
+ * functions such as `'shake256'`, the `outputLength` option can be used to
+ * specify the desired output length in bytes.
+ *
+ * An error is thrown when an attempt is made to copy the `Hash` object after
+ * its `hash.digest()` method has been called.
+ *
+ * ```js
+ * // Calculate a rolling hash.
+ * const {
+ * createHash
+ * } = await import('crypto');
+ *
+ * const hash = createHash('sha256');
+ *
+ * hash.update('one');
+ * console.log(hash.copy().digest('hex'));
+ *
+ * hash.update('two');
+ * console.log(hash.copy().digest('hex'));
+ *
+ * hash.update('three');
+ * console.log(hash.copy().digest('hex'));
+ *
+ * // Etc.
+ * ```
+ * @since v13.1.0
+ * @param options `stream.transform` options
+ */
+ copy(options?: stream.TransformOptions): Hash;
+ /**
+ * Updates the hash content with the given `data`, the encoding of which
+ * is given in `inputEncoding`.
+ * If `encoding` is not provided, and the `data` is a string, an
+ * encoding of `'utf8'` is enforced. If `data` is a `Buffer`, `TypedArray`, or`DataView`, then `inputEncoding` is ignored.
+ *
+ * This can be called many times with new data as it is streamed.
+ * @since v0.1.92
+ * @param inputEncoding The `encoding` of the `data` string.
+ */
update(data: BinaryLike): Hash;
- update(data: string, input_encoding: Encoding): Hash;
+ update(data: string, inputEncoding: Encoding): Hash;
+ /**
+ * Calculates the digest of all of the data passed to be hashed (using the `hash.update()` method).
+ * If `encoding` is provided a string will be returned; otherwise
+ * a `Buffer` is returned.
+ *
+ * The `Hash` object can not be used again after `hash.digest()` method has been
+ * called. Multiple calls will cause an error to be thrown.
+ * @since v0.1.92
+ * @param encoding The `encoding` of the return value.
+ */
digest(): Buffer;
digest(encoding: BinaryToTextEncoding): string;
}
+ /**
+ * The `Hmac` class is a utility for creating cryptographic HMAC digests. It can
+ * be used in one of two ways:
+ *
+ * * As a `stream` that is both readable and writable, where data is written
+ * to produce a computed HMAC digest on the readable side, or
+ * * Using the `hmac.update()` and `hmac.digest()` methods to produce the
+ * computed HMAC digest.
+ *
+ * The {@link createHmac} method is used to create `Hmac` instances. `Hmac`objects are not to be created directly using the `new` keyword.
+ *
+ * Example: Using `Hmac` objects as streams:
+ *
+ * ```js
+ * const {
+ * createHmac
+ * } = await import('crypto');
+ *
+ * const hmac = createHmac('sha256', 'a secret');
+ *
+ * hmac.on('readable', () => {
+ * // Only one element is going to be produced by the
+ * // hash stream.
+ * const data = hmac.read();
+ * if (data) {
+ * console.log(data.toString('hex'));
+ * // Prints:
+ * // 7fd04df92f636fd450bc841c9418e5825c17f33ad9c87c518115a45971f7f77e
+ * }
+ * });
+ *
+ * hmac.write('some data to hash');
+ * hmac.end();
+ * ```
+ *
+ * Example: Using `Hmac` and piped streams:
+ *
+ * ```js
+ * import { createReadStream } from 'fs';
+ * import { stdout } from 'process';
+ * const {
+ * createHmac
+ * } = await import('crypto');
+ *
+ * const hmac = createHmac('sha256', 'a secret');
+ *
+ * const input = createReadStream('test.js');
+ * input.pipe(hmac).pipe(stdout);
+ * ```
+ *
+ * Example: Using the `hmac.update()` and `hmac.digest()` methods:
+ *
+ * ```js
+ * const {
+ * createHmac
+ * } = await import('crypto');
+ *
+ * const hmac = createHmac('sha256', 'a secret');
+ *
+ * hmac.update('some data to hash');
+ * console.log(hmac.digest('hex'));
+ * // Prints:
+ * // 7fd04df92f636fd450bc841c9418e5825c17f33ad9c87c518115a45971f7f77e
+ * ```
+ * @since v0.1.94
+ */
class Hmac extends stream.Transform {
private constructor();
+ /**
+ * Updates the `Hmac` content with the given `data`, the encoding of which
+ * is given in `inputEncoding`.
+ * If `encoding` is not provided, and the `data` is a string, an
+ * encoding of `'utf8'` is enforced. If `data` is a `Buffer`, `TypedArray`, or`DataView`, then `inputEncoding` is ignored.
+ *
+ * This can be called many times with new data as it is streamed.
+ * @since v0.1.94
+ * @param inputEncoding The `encoding` of the `data` string.
+ */
update(data: BinaryLike): Hmac;
- update(data: string, input_encoding: Encoding): Hmac;
+ update(data: string, inputEncoding: Encoding): Hmac;
+ /**
+ * Calculates the HMAC digest of all of the data passed using `hmac.update()`.
+ * If `encoding` is
+ * provided a string is returned; otherwise a `Buffer` is returned;
+ *
+ * The `Hmac` object can not be used again after `hmac.digest()` has been
+ * called. Multiple calls to `hmac.digest()` will result in an error being thrown.
+ * @since v0.1.94
+ * @param encoding The `encoding` of the return value.
+ */
digest(): Buffer;
digest(encoding: BinaryToTextEncoding): string;
}
-
type KeyObjectType = 'secret' | 'public' | 'private';
-
interface KeyExportOptions {
type: 'pkcs1' | 'spki' | 'pkcs8' | 'sec1';
format: T;
cipher?: string | undefined;
passphrase?: string | Buffer | undefined;
}
-
+ interface JwkKeyExportOptions {
+ format: 'jwk';
+ }
+ interface JsonWebKey {
+ crv?: string | undefined;
+ d?: string | undefined;
+ dp?: string | undefined;
+ dq?: string | undefined;
+ e?: string | undefined;
+ k?: string | undefined;
+ kty?: string | undefined;
+ n?: string | undefined;
+ p?: string | undefined;
+ q?: string | undefined;
+ qi?: string | undefined;
+ x?: string | undefined;
+ y?: string | undefined;
+ [key: string]: unknown;
+ }
+ interface AsymmetricKeyDetails {
+ /**
+ * Key size in bits (RSA, DSA).
+ */
+ modulusLength?: number | undefined;
+ /**
+ * Public exponent (RSA).
+ */
+ publicExponent?: bigint | undefined;
+ /**
+ * Name of the message digest (RSA-PSS).
+ */
+ hashAlgorithm?: string | undefined;
+ /**
+ * Name of the message digest used by MGF1 (RSA-PSS).
+ */
+ mgf1HashAlgorithm?: string | undefined;
+ /**
+ * Minimal salt length in bytes (RSA-PSS).
+ */
+ saltLength?: number | undefined;
+ /**
+ * Size of q in bits (DSA).
+ */
+ divisorLength?: number | undefined;
+ /**
+ * Name of the curve (EC).
+ */
+ namedCurve?: string | undefined;
+ }
+ /**
+ * Node.js uses a `KeyObject` class to represent a symmetric or asymmetric key,
+ * and each kind of key exposes different functions. The {@link createSecretKey}, {@link createPublicKey} and {@link createPrivateKey} methods are used to create `KeyObject`instances. `KeyObject`
+ * objects are not to be created directly using the `new`keyword.
+ *
+ * Most applications should consider using the new `KeyObject` API instead of
+ * passing keys as strings or `Buffer`s due to improved security features.
+ *
+ * `KeyObject` instances can be passed to other threads via `postMessage()`.
+ * The receiver obtains a cloned `KeyObject`, and the `KeyObject` does not need to
+ * be listed in the `transferList` argument.
+ * @since v11.6.0
+ */
class KeyObject {
private constructor();
+ /**
+ * Example: Converting a `CryptoKey` instance to a `KeyObject`:
+ *
+ * ```js
+ * const { webcrypto, KeyObject } = await import('crypto');
+ * const { subtle } = webcrypto;
+ *
+ * const key = await subtle.generateKey({
+ * name: 'HMAC',
+ * hash: 'SHA-256',
+ * length: 256
+ * }, true, ['sign', 'verify']);
+ *
+ * const keyObject = KeyObject.from(key);
+ * console.log(keyObject.symmetricKeySize);
+ * // Prints: 32 (symmetric key size in bytes)
+ * ```
+ * @since v15.0.0
+ */
+ static from(key: webcrypto.CryptoKey): KeyObject;
+ /**
+ * For asymmetric keys, this property represents the type of the key. Supported key
+ * types are:
+ *
+ * * `'rsa'` (OID 1.2.840.113549.1.1.1)
+ * * `'rsa-pss'` (OID 1.2.840.113549.1.1.10)
+ * * `'dsa'` (OID 1.2.840.10040.4.1)
+ * * `'ec'` (OID 1.2.840.10045.2.1)
+ * * `'x25519'` (OID 1.3.101.110)
+ * * `'x448'` (OID 1.3.101.111)
+ * * `'ed25519'` (OID 1.3.101.112)
+ * * `'ed448'` (OID 1.3.101.113)
+ * * `'dh'` (OID 1.2.840.113549.1.3.1)
+ *
+ * This property is `undefined` for unrecognized `KeyObject` types and symmetric
+ * keys.
+ * @since v11.6.0
+ */
asymmetricKeyType?: KeyType | undefined;
/**
* For asymmetric keys, this property represents the size of the embedded key in
* bytes. This property is `undefined` for symmetric keys.
*/
asymmetricKeySize?: number | undefined;
+ /**
+ * This property exists only on asymmetric keys. Depending on the type of the key,
+ * this object contains information about the key. None of the information obtained
+ * through this property can be used to uniquely identify a key or to compromise
+ * the security of the key.
+ *
+ * For RSA-PSS keys, if the key material contains a `RSASSA-PSS-params` sequence,
+ * the `hashAlgorithm`, `mgf1HashAlgorithm`, and `saltLength` properties will be
+ * set.
+ *
+ * Other key details might be exposed via this API using additional attributes.
+ * @since v15.7.0
+ */
+ asymmetricKeyDetails?: AsymmetricKeyDetails | undefined;
+ /**
+ * For symmetric keys, the following encoding options can be used:
+ *
+ * For public keys, the following encoding options can be used:
+ *
+ * For private keys, the following encoding options can be used:
+ *
+ * The result type depends on the selected encoding format, when PEM the
+ * result is a string, when DER it will be a buffer containing the data
+ * encoded as DER, when [JWK](https://tools.ietf.org/html/rfc7517) it will be an object.
+ *
+ * When [JWK](https://tools.ietf.org/html/rfc7517) encoding format was selected, all other encoding options are
+ * ignored.
+ *
+ * PKCS#1, SEC1, and PKCS#8 type keys can be encrypted by using a combination of
+ * the `cipher` and `format` options. The PKCS#8 `type` can be used with any`format` to encrypt any key algorithm (RSA, EC, or DH) by specifying a`cipher`. PKCS#1 and SEC1 can only be
+ * encrypted by specifying a `cipher`when the PEM `format` is used. For maximum compatibility, use PKCS#8 for
+ * encrypted private keys. Since PKCS#8 defines its own
+ * encryption mechanism, PEM-level encryption is not supported when encrypting
+ * a PKCS#8 key. See [RFC 5208](https://www.rfc-editor.org/rfc/rfc5208.txt) for PKCS#8 encryption and [RFC 1421](https://www.rfc-editor.org/rfc/rfc1421.txt) for
+ * PKCS#1 and SEC1 encryption.
+ * @since v11.6.0
+ */
export(options: KeyExportOptions<'pem'>): string | Buffer;
export(options?: KeyExportOptions<'der'>): Buffer;
+ export(options?: JwkKeyExportOptions): JsonWebKey;
+ /**
+ * For secret keys, this property represents the size of the key in bytes. This
+ * property is `undefined` for asymmetric keys.
+ * @since v11.6.0
+ */
symmetricKeySize?: number | undefined;
+ /**
+ * Depending on the type of this `KeyObject`, this property is either`'secret'` for secret (symmetric) keys, `'public'` for public (asymmetric) keys
+ * or `'private'` for private (asymmetric) keys.
+ * @since v11.6.0
+ */
type: KeyObjectType;
}
-
type CipherCCMTypes = 'aes-128-ccm' | 'aes-192-ccm' | 'aes-256-ccm' | 'chacha20-poly1305';
type CipherGCMTypes = 'aes-128-gcm' | 'aes-192-gcm' | 'aes-256-gcm';
-
+ type CipherOCBTypes = 'aes-128-ocb' | 'aes-192-ocb' | 'aes-256-ocb';
type BinaryLike = string | NodeJS.ArrayBufferView;
-
type CipherKey = BinaryLike | KeyObject;
-
interface CipherCCMOptions extends stream.TransformOptions {
authTagLength: number;
}
interface CipherGCMOptions extends stream.TransformOptions {
authTagLength?: number | undefined;
}
- /** @deprecated since v10.0.0 use `createCipheriv()` */
+ interface CipherOCBOptions extends stream.TransformOptions {
+ authTagLength: number;
+ }
+ /**
+ * Creates and returns a `Cipher` object that uses the given `algorithm` and`password`.
+ *
+ * The `options` argument controls stream behavior and is optional except when a
+ * cipher in CCM or OCB mode is used (e.g. `'aes-128-ccm'`). In that case, the`authTagLength` option is required and specifies the length of the
+ * authentication tag in bytes, see `CCM mode`. In GCM mode, the `authTagLength`option is not required but can be used to set the length of the authentication
+ * tag that will be returned by `getAuthTag()` and defaults to 16 bytes.
+ *
+ * The `algorithm` is dependent on OpenSSL, examples are `'aes192'`, etc. On
+ * recent OpenSSL releases, `openssl list -cipher-algorithms`(`openssl list-cipher-algorithms` for older versions of OpenSSL) will
+ * display the available cipher algorithms.
+ *
+ * The `password` is used to derive the cipher key and initialization vector (IV).
+ * The value must be either a `'latin1'` encoded string, a `Buffer`, a`TypedArray`, or a `DataView`.
+ *
+ * The implementation of `crypto.createCipher()` derives keys using the OpenSSL
+ * function [`EVP_BytesToKey`](https://www.openssl.org/docs/man1.1.0/crypto/EVP_BytesToKey.html) with the digest algorithm set to MD5, one
+ * iteration, and no salt. The lack of salt allows dictionary attacks as the same
+ * password always creates the same key. The low iteration count and
+ * non-cryptographically secure hash algorithm allow passwords to be tested very
+ * rapidly.
+ *
+ * In line with OpenSSL's recommendation to use a more modern algorithm instead of [`EVP_BytesToKey`](https://www.openssl.org/docs/man1.1.0/crypto/EVP_BytesToKey.html) it is recommended that
+ * developers derive a key and IV on
+ * their own using {@link scrypt} and to use {@link createCipheriv} to create the `Cipher` object. Users should not use ciphers with counter mode
+ * (e.g. CTR, GCM, or CCM) in `crypto.createCipher()`. A warning is emitted when
+ * they are used in order to avoid the risk of IV reuse that causes
+ * vulnerabilities. For the case when IV is reused in GCM, see [Nonce-Disrespecting Adversaries](https://github.com/nonce-disrespect/nonce-disrespect) for details.
+ * @since v0.1.94
+ * @deprecated Since v10.0.0 - Use {@link createCipheriv} instead.
+ * @param options `stream.transform` options
+ */
function createCipher(algorithm: CipherCCMTypes, password: BinaryLike, options: CipherCCMOptions): CipherCCM;
/** @deprecated since v10.0.0 use `createCipheriv()` */
function createCipher(algorithm: CipherGCMTypes, password: BinaryLike, options?: CipherGCMOptions): CipherGCM;
/** @deprecated since v10.0.0 use `createCipheriv()` */
function createCipher(algorithm: string, password: BinaryLike, options?: stream.TransformOptions): Cipher;
-
- function createCipheriv(
- algorithm: CipherCCMTypes,
- key: CipherKey,
- iv: BinaryLike | null,
- options: CipherCCMOptions,
- ): CipherCCM;
- function createCipheriv(
- algorithm: CipherGCMTypes,
- key: CipherKey,
- iv: BinaryLike | null,
- options?: CipherGCMOptions,
- ): CipherGCM;
- function createCipheriv(
- algorithm: string,
- key: CipherKey,
- iv: BinaryLike | null,
- options?: stream.TransformOptions,
- ): Cipher;
-
+ /**
+ * Creates and returns a `Cipher` object, with the given `algorithm`, `key` and
+ * initialization vector (`iv`).
+ *
+ * The `options` argument controls stream behavior and is optional except when a
+ * cipher in CCM or OCB mode is used (e.g. `'aes-128-ccm'`). In that case, the`authTagLength` option is required and specifies the length of the
+ * authentication tag in bytes, see `CCM mode`. In GCM mode, the `authTagLength`option is not required but can be used to set the length of the authentication
+ * tag that will be returned by `getAuthTag()` and defaults to 16 bytes.
+ *
+ * The `algorithm` is dependent on OpenSSL, examples are `'aes192'`, etc. On
+ * recent OpenSSL releases, `openssl list -cipher-algorithms`(`openssl list-cipher-algorithms` for older versions of OpenSSL) will
+ * display the available cipher algorithms.
+ *
+ * The `key` is the raw key used by the `algorithm` and `iv` is an [initialization vector](https://en.wikipedia.org/wiki/Initialization_vector). Both arguments must be `'utf8'` encoded
+ * strings,`Buffers`, `TypedArray`, or `DataView`s. The `key` may optionally be
+ * a `KeyObject` of type `secret`. If the cipher does not need
+ * an initialization vector, `iv` may be `null`.
+ *
+ * When passing strings for `key` or `iv`, please consider `caveats when using strings as inputs to cryptographic APIs`.
+ *
+ * Initialization vectors should be unpredictable and unique; ideally, they will be
+ * cryptographically random. They do not have to be secret: IVs are typically just
+ * added to ciphertext messages unencrypted. It may sound contradictory that
+ * something has to be unpredictable and unique, but does not have to be secret;
+ * remember that an attacker must not be able to predict ahead of time what a
+ * given IV will be.
+ * @since v0.1.94
+ * @param options `stream.transform` options
+ */
+ function createCipheriv(algorithm: CipherCCMTypes, key: CipherKey, iv: BinaryLike, options: CipherCCMOptions): CipherCCM;
+ function createCipheriv(algorithm: CipherOCBTypes, key: CipherKey, iv: BinaryLike, options: CipherOCBOptions): CipherOCB;
+ function createCipheriv(algorithm: CipherGCMTypes, key: CipherKey, iv: BinaryLike, options?: CipherGCMOptions): CipherGCM;
+ function createCipheriv(algorithm: string, key: CipherKey, iv: BinaryLike | null, options?: stream.TransformOptions): Cipher;
+ /**
+ * Instances of the `Cipher` class are used to encrypt data. The class can be
+ * used in one of two ways:
+ *
+ * * As a `stream` that is both readable and writable, where plain unencrypted
+ * data is written to produce encrypted data on the readable side, or
+ * * Using the `cipher.update()` and `cipher.final()` methods to produce
+ * the encrypted data.
+ *
+ * The {@link createCipher} or {@link createCipheriv} methods are
+ * used to create `Cipher` instances. `Cipher` objects are not to be created
+ * directly using the `new` keyword.
+ *
+ * Example: Using `Cipher` objects as streams:
+ *
+ * ```js
+ * const {
+ * scrypt,
+ * randomFill,
+ * createCipheriv
+ * } = await import('crypto');
+ *
+ * const algorithm = 'aes-192-cbc';
+ * const password = 'Password used to generate key';
+ *
+ * // First, we'll generate the key. The key length is dependent on the algorithm.
+ * // In this case for aes192, it is 24 bytes (192 bits).
+ * scrypt(password, 'salt', 24, (err, key) => {
+ * if (err) throw err;
+ * // Then, we'll generate a random initialization vector
+ * randomFill(new Uint8Array(16), (err, iv) => {
+ * if (err) throw err;
+ *
+ * // Once we have the key and iv, we can create and use the cipher...
+ * const cipher = createCipheriv(algorithm, key, iv);
+ *
+ * let encrypted = '';
+ * cipher.setEncoding('hex');
+ *
+ * cipher.on('data', (chunk) => encrypted += chunk);
+ * cipher.on('end', () => console.log(encrypted));
+ *
+ * cipher.write('some clear text data');
+ * cipher.end();
+ * });
+ * });
+ * ```
+ *
+ * Example: Using `Cipher` and piped streams:
+ *
+ * ```js
+ * import {
+ * createReadStream,
+ * createWriteStream,
+ * } from 'fs';
+ *
+ * import {
+ * pipeline
+ * } from 'stream';
+ *
+ * const {
+ * scrypt,
+ * randomFill,
+ * createCipheriv
+ * } = await import('crypto');
+ *
+ * const algorithm = 'aes-192-cbc';
+ * const password = 'Password used to generate key';
+ *
+ * // First, we'll generate the key. The key length is dependent on the algorithm.
+ * // In this case for aes192, it is 24 bytes (192 bits).
+ * scrypt(password, 'salt', 24, (err, key) => {
+ * if (err) throw err;
+ * // Then, we'll generate a random initialization vector
+ * randomFill(new Uint8Array(16), (err, iv) => {
+ * if (err) throw err;
+ *
+ * const cipher = createCipheriv(algorithm, key, iv);
+ *
+ * const input = createReadStream('test.js');
+ * const output = createWriteStream('test.enc');
+ *
+ * pipeline(input, cipher, output, (err) => {
+ * if (err) throw err;
+ * });
+ * });
+ * });
+ * ```
+ *
+ * Example: Using the `cipher.update()` and `cipher.final()` methods:
+ *
+ * ```js
+ * const {
+ * scrypt,
+ * randomFill,
+ * createCipheriv
+ * } = await import('crypto');
+ *
+ * const algorithm = 'aes-192-cbc';
+ * const password = 'Password used to generate key';
+ *
+ * // First, we'll generate the key. The key length is dependent on the algorithm.
+ * // In this case for aes192, it is 24 bytes (192 bits).
+ * scrypt(password, 'salt', 24, (err, key) => {
+ * if (err) throw err;
+ * // Then, we'll generate a random initialization vector
+ * randomFill(new Uint8Array(16), (err, iv) => {
+ * if (err) throw err;
+ *
+ * const cipher = createCipheriv(algorithm, key, iv);
+ *
+ * let encrypted = cipher.update('some clear text data', 'utf8', 'hex');
+ * encrypted += cipher.final('hex');
+ * console.log(encrypted);
+ * });
+ * });
+ * ```
+ * @since v0.1.94
+ */
class Cipher extends stream.Transform {
private constructor();
+ /**
+ * Updates the cipher with `data`. If the `inputEncoding` argument is given,
+ * the `data`argument is a string using the specified encoding. If the `inputEncoding`argument is not given, `data` must be a `Buffer`, `TypedArray`, or`DataView`. If `data` is a `Buffer`,
+ * `TypedArray`, or `DataView`, then`inputEncoding` is ignored.
+ *
+ * The `outputEncoding` specifies the output format of the enciphered
+ * data. If the `outputEncoding`is specified, a string using the specified encoding is returned. If no`outputEncoding` is provided, a `Buffer` is returned.
+ *
+ * The `cipher.update()` method can be called multiple times with new data until `cipher.final()` is called. Calling `cipher.update()` after `cipher.final()` will result in an error being
+ * thrown.
+ * @since v0.1.94
+ * @param inputEncoding The `encoding` of the data.
+ * @param outputEncoding The `encoding` of the return value.
+ */
update(data: BinaryLike): Buffer;
- update(data: string, input_encoding: Encoding): Buffer;
- update(data: NodeJS.ArrayBufferView, input_encoding: undefined, output_encoding: Encoding): string;
- update(data: string, input_encoding: Encoding | undefined, output_encoding: Encoding): string;
+ update(data: string, inputEncoding: Encoding): Buffer;
+ update(data: NodeJS.ArrayBufferView, inputEncoding: undefined, outputEncoding: Encoding): string;
+ update(data: string, inputEncoding: Encoding | undefined, outputEncoding: Encoding): string;
+ /**
+ * Once the `cipher.final()` method has been called, the `Cipher` object can no
+ * longer be used to encrypt data. Attempts to call `cipher.final()` more than
+ * once will result in an error being thrown.
+ * @since v0.1.94
+ * @param outputEncoding The `encoding` of the return value.
+ * @return Any remaining enciphered contents. If `outputEncoding` is specified, a string is returned. If an `outputEncoding` is not provided, a {@link Buffer} is returned.
+ */
final(): Buffer;
- final(output_encoding: BufferEncoding): string;
- setAutoPadding(auto_padding?: boolean): this;
- // getAuthTag(): Buffer;
- // setAAD(buffer: NodeJS.ArrayBufferView): this;
+ final(outputEncoding: BufferEncoding): string;
+ /**
+ * When using block encryption algorithms, the `Cipher` class will automatically
+ * add padding to the input data to the appropriate block size. To disable the
+ * default padding call `cipher.setAutoPadding(false)`.
+ *
+ * When `autoPadding` is `false`, the length of the entire input data must be a
+ * multiple of the cipher's block size or `cipher.final()` will throw an error.
+ * Disabling automatic padding is useful for non-standard padding, for instance
+ * using `0x0` instead of PKCS padding.
+ *
+ * The `cipher.setAutoPadding()` method must be called before `cipher.final()`.
+ * @since v0.7.1
+ * @param [autoPadding=true]
+ * @return for method chaining.
+ */
+ setAutoPadding(autoPadding?: boolean): this;
}
interface CipherCCM extends Cipher {
- setAAD(buffer: NodeJS.ArrayBufferView, options: { plaintextLength: number }): this;
+ setAAD(
+ buffer: NodeJS.ArrayBufferView,
+ options: {
+ plaintextLength: number;
+ }
+ ): this;
getAuthTag(): Buffer;
}
interface CipherGCM extends Cipher {
- setAAD(buffer: NodeJS.ArrayBufferView, options?: { plaintextLength: number }): this;
+ setAAD(
+ buffer: NodeJS.ArrayBufferView,
+ options?: {
+ plaintextLength: number;
+ }
+ ): this;
getAuthTag(): Buffer;
}
- /** @deprecated since v10.0.0 use `createDecipheriv()` */
+ interface CipherOCB extends Cipher {
+ setAAD(
+ buffer: NodeJS.ArrayBufferView,
+ options?: {
+ plaintextLength: number;
+ }
+ ): this;
+ getAuthTag(): Buffer;
+ }
+ /**
+ * Creates and returns a `Decipher` object that uses the given `algorithm` and`password` (key).
+ *
+ * The `options` argument controls stream behavior and is optional except when a
+ * cipher in CCM or OCB mode is used (e.g. `'aes-128-ccm'`). In that case, the`authTagLength` option is required and specifies the length of the
+ * authentication tag in bytes, see `CCM mode`.
+ *
+ * The implementation of `crypto.createDecipher()` derives keys using the OpenSSL
+ * function [`EVP_BytesToKey`](https://www.openssl.org/docs/man1.1.0/crypto/EVP_BytesToKey.html) with the digest algorithm set to MD5, one
+ * iteration, and no salt. The lack of salt allows dictionary attacks as the same
+ * password always creates the same key. The low iteration count and
+ * non-cryptographically secure hash algorithm allow passwords to be tested very
+ * rapidly.
+ *
+ * In line with OpenSSL's recommendation to use a more modern algorithm instead of [`EVP_BytesToKey`](https://www.openssl.org/docs/man1.1.0/crypto/EVP_BytesToKey.html) it is recommended that
+ * developers derive a key and IV on
+ * their own using {@link scrypt} and to use {@link createDecipheriv} to create the `Decipher` object.
+ * @since v0.1.94
+ * @deprecated Since v10.0.0 - Use {@link createDecipheriv} instead.
+ * @param options `stream.transform` options
+ */
function createDecipher(algorithm: CipherCCMTypes, password: BinaryLike, options: CipherCCMOptions): DecipherCCM;
/** @deprecated since v10.0.0 use `createDecipheriv()` */
function createDecipher(algorithm: CipherGCMTypes, password: BinaryLike, options?: CipherGCMOptions): DecipherGCM;
/** @deprecated since v10.0.0 use `createDecipheriv()` */
function createDecipher(algorithm: string, password: BinaryLike, options?: stream.TransformOptions): Decipher;
-
- function createDecipheriv(
- algorithm: CipherCCMTypes,
- key: CipherKey,
- iv: BinaryLike | null,
- options: CipherCCMOptions,
- ): DecipherCCM;
- function createDecipheriv(
- algorithm: CipherGCMTypes,
- key: CipherKey,
- iv: BinaryLike | null,
- options?: CipherGCMOptions,
- ): DecipherGCM;
- function createDecipheriv(
- algorithm: string,
- key: CipherKey,
- iv: BinaryLike | null,
- options?: stream.TransformOptions,
- ): Decipher;
-
+ /**
+ * Creates and returns a `Decipher` object that uses the given `algorithm`, `key`and initialization vector (`iv`).
+ *
+ * The `options` argument controls stream behavior and is optional except when a
+ * cipher in CCM or OCB mode is used (e.g. `'aes-128-ccm'`). In that case, the`authTagLength` option is required and specifies the length of the
+ * authentication tag in bytes, see `CCM mode`. In GCM mode, the `authTagLength`option is not required but can be used to restrict accepted authentication tags
+ * to those with the specified length.
+ *
+ * The `algorithm` is dependent on OpenSSL, examples are `'aes192'`, etc. On
+ * recent OpenSSL releases, `openssl list -cipher-algorithms`(`openssl list-cipher-algorithms` for older versions of OpenSSL) will
+ * display the available cipher algorithms.
+ *
+ * The `key` is the raw key used by the `algorithm` and `iv` is an [initialization vector](https://en.wikipedia.org/wiki/Initialization_vector). Both arguments must be `'utf8'` encoded
+ * strings,`Buffers`, `TypedArray`, or `DataView`s. The `key` may optionally be
+ * a `KeyObject` of type `secret`. If the cipher does not need
+ * an initialization vector, `iv` may be `null`.
+ *
+ * When passing strings for `key` or `iv`, please consider `caveats when using strings as inputs to cryptographic APIs`.
+ *
+ * Initialization vectors should be unpredictable and unique; ideally, they will be
+ * cryptographically random. They do not have to be secret: IVs are typically just
+ * added to ciphertext messages unencrypted. It may sound contradictory that
+ * something has to be unpredictable and unique, but does not have to be secret;
+ * remember that an attacker must not be able to predict ahead of time what a given
+ * IV will be.
+ * @since v0.1.94
+ * @param options `stream.transform` options
+ */
+ function createDecipheriv(algorithm: CipherCCMTypes, key: CipherKey, iv: BinaryLike, options: CipherCCMOptions): DecipherCCM;
+ function createDecipheriv(algorithm: CipherOCBTypes, key: CipherKey, iv: BinaryLike, options: CipherOCBOptions): DecipherOCB;
+ function createDecipheriv(algorithm: CipherGCMTypes, key: CipherKey, iv: BinaryLike, options?: CipherGCMOptions): DecipherGCM;
+ function createDecipheriv(algorithm: string, key: CipherKey, iv: BinaryLike | null, options?: stream.TransformOptions): Decipher;
+ /**
+ * Instances of the `Decipher` class are used to decrypt data. The class can be
+ * used in one of two ways:
+ *
+ * * As a `stream` that is both readable and writable, where plain encrypted
+ * data is written to produce unencrypted data on the readable side, or
+ * * Using the `decipher.update()` and `decipher.final()` methods to
+ * produce the unencrypted data.
+ *
+ * The {@link createDecipher} or {@link createDecipheriv} methods are
+ * used to create `Decipher` instances. `Decipher` objects are not to be created
+ * directly using the `new` keyword.
+ *
+ * Example: Using `Decipher` objects as streams:
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ * const {
+ * scryptSync,
+ * createDecipheriv
+ * } = await import('crypto');
+ *
+ * const algorithm = 'aes-192-cbc';
+ * const password = 'Password used to generate key';
+ * // Key length is dependent on the algorithm. In this case for aes192, it is
+ * // 24 bytes (192 bits).
+ * // Use the async `crypto.scrypt()` instead.
+ * const key = scryptSync(password, 'salt', 24);
+ * // The IV is usually passed along with the ciphertext.
+ * const iv = Buffer.alloc(16, 0); // Initialization vector.
+ *
+ * const decipher = createDecipheriv(algorithm, key, iv);
+ *
+ * let decrypted = '';
+ * decipher.on('readable', () => {
+ * while (null !== (chunk = decipher.read())) {
+ * decrypted += chunk.toString('utf8');
+ * }
+ * });
+ * decipher.on('end', () => {
+ * console.log(decrypted);
+ * // Prints: some clear text data
+ * });
+ *
+ * // Encrypted with same algorithm, key and iv.
+ * const encrypted =
+ * 'e5f79c5915c02171eec6b212d5520d44480993d7d622a7c4c2da32f6efda0ffa';
+ * decipher.write(encrypted, 'hex');
+ * decipher.end();
+ * ```
+ *
+ * Example: Using `Decipher` and piped streams:
+ *
+ * ```js
+ * import {
+ * createReadStream,
+ * createWriteStream,
+ * } from 'fs';
+ * import { Buffer } from 'buffer';
+ * const {
+ * scryptSync,
+ * createDecipheriv
+ * } = await import('crypto');
+ *
+ * const algorithm = 'aes-192-cbc';
+ * const password = 'Password used to generate key';
+ * // Use the async `crypto.scrypt()` instead.
+ * const key = scryptSync(password, 'salt', 24);
+ * // The IV is usually passed along with the ciphertext.
+ * const iv = Buffer.alloc(16, 0); // Initialization vector.
+ *
+ * const decipher = createDecipheriv(algorithm, key, iv);
+ *
+ * const input = createReadStream('test.enc');
+ * const output = createWriteStream('test.js');
+ *
+ * input.pipe(decipher).pipe(output);
+ * ```
+ *
+ * Example: Using the `decipher.update()` and `decipher.final()` methods:
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ * const {
+ * scryptSync,
+ * createDecipheriv
+ * } = await import('crypto');
+ *
+ * const algorithm = 'aes-192-cbc';
+ * const password = 'Password used to generate key';
+ * // Use the async `crypto.scrypt()` instead.
+ * const key = scryptSync(password, 'salt', 24);
+ * // The IV is usually passed along with the ciphertext.
+ * const iv = Buffer.alloc(16, 0); // Initialization vector.
+ *
+ * const decipher = createDecipheriv(algorithm, key, iv);
+ *
+ * // Encrypted using same algorithm, key and iv.
+ * const encrypted =
+ * 'e5f79c5915c02171eec6b212d5520d44480993d7d622a7c4c2da32f6efda0ffa';
+ * let decrypted = decipher.update(encrypted, 'hex', 'utf8');
+ * decrypted += decipher.final('utf8');
+ * console.log(decrypted);
+ * // Prints: some clear text data
+ * ```
+ * @since v0.1.94
+ */
class Decipher extends stream.Transform {
private constructor();
+ /**
+ * Updates the decipher with `data`. If the `inputEncoding` argument is given,
+ * the `data`argument is a string using the specified encoding. If the `inputEncoding`argument is not given, `data` must be a `Buffer`. If `data` is a `Buffer` then `inputEncoding` is
+ * ignored.
+ *
+ * The `outputEncoding` specifies the output format of the enciphered
+ * data. If the `outputEncoding`is specified, a string using the specified encoding is returned. If no`outputEncoding` is provided, a `Buffer` is returned.
+ *
+ * The `decipher.update()` method can be called multiple times with new data until `decipher.final()` is called. Calling `decipher.update()` after `decipher.final()` will result in an error
+ * being thrown.
+ * @since v0.1.94
+ * @param inputEncoding The `encoding` of the `data` string.
+ * @param outputEncoding The `encoding` of the return value.
+ */
update(data: NodeJS.ArrayBufferView): Buffer;
- update(data: string, input_encoding: Encoding): Buffer;
- update(data: NodeJS.ArrayBufferView, input_encoding: undefined, output_encoding: Encoding): string;
- update(data: string, input_encoding: Encoding | undefined, output_encoding: Encoding): string;
+ update(data: string, inputEncoding: Encoding): Buffer;
+ update(data: NodeJS.ArrayBufferView, inputEncoding: undefined, outputEncoding: Encoding): string;
+ update(data: string, inputEncoding: Encoding | undefined, outputEncoding: Encoding): string;
+ /**
+ * Once the `decipher.final()` method has been called, the `Decipher` object can
+ * no longer be used to decrypt data. Attempts to call `decipher.final()` more
+ * than once will result in an error being thrown.
+ * @since v0.1.94
+ * @param outputEncoding The `encoding` of the return value.
+ * @return Any remaining deciphered contents. If `outputEncoding` is specified, a string is returned. If an `outputEncoding` is not provided, a {@link Buffer} is returned.
+ */
final(): Buffer;
- final(output_encoding: BufferEncoding): string;
+ final(outputEncoding: BufferEncoding): string;
+ /**
+ * When data has been encrypted without standard block padding, calling`decipher.setAutoPadding(false)` will disable automatic padding to prevent `decipher.final()` from checking for and
+ * removing padding.
+ *
+ * Turning auto padding off will only work if the input data's length is a
+ * multiple of the ciphers block size.
+ *
+ * The `decipher.setAutoPadding()` method must be called before `decipher.final()`.
+ * @since v0.7.1
+ * @param [autoPadding=true]
+ * @return for method chaining.
+ */
setAutoPadding(auto_padding?: boolean): this;
- // setAuthTag(tag: NodeJS.ArrayBufferView): this;
- // setAAD(buffer: NodeJS.ArrayBufferView): this;
}
interface DecipherCCM extends Decipher {
setAuthTag(buffer: NodeJS.ArrayBufferView): this;
- setAAD(buffer: NodeJS.ArrayBufferView, options: { plaintextLength: number }): this;
+ setAAD(
+ buffer: NodeJS.ArrayBufferView,
+ options: {
+ plaintextLength: number;
+ }
+ ): this;
}
interface DecipherGCM extends Decipher {
setAuthTag(buffer: NodeJS.ArrayBufferView): this;
- setAAD(buffer: NodeJS.ArrayBufferView, options?: { plaintextLength: number }): this;
+ setAAD(
+ buffer: NodeJS.ArrayBufferView,
+ options?: {
+ plaintextLength: number;
+ }
+ ): this;
+ }
+ interface DecipherOCB extends Decipher {
+ setAuthTag(buffer: NodeJS.ArrayBufferView): this;
+ setAAD(
+ buffer: NodeJS.ArrayBufferView,
+ options?: {
+ plaintextLength: number;
+ }
+ ): this;
}
-
interface PrivateKeyInput {
key: string | Buffer;
format?: KeyFormat | undefined;
type?: 'pkcs1' | 'pkcs8' | 'sec1' | undefined;
passphrase?: string | Buffer | undefined;
+ encoding?: string | undefined;
}
-
interface PublicKeyInput {
key: string | Buffer;
format?: KeyFormat | undefined;
type?: 'pkcs1' | 'spki' | undefined;
+ encoding?: string | undefined;
}
-
- function createPrivateKey(key: PrivateKeyInput | string | Buffer): KeyObject;
- function createPublicKey(key: PublicKeyInput | string | Buffer | KeyObject): KeyObject;
+ /**
+ * Asynchronously generates a new random secret key of the given `length`. The`type` will determine which validations will be performed on the `length`.
+ *
+ * ```js
+ * const {
+ * generateKey
+ * } = await import('crypto');
+ *
+ * generateKey('hmac', { length: 64 }, (err, key) => {
+ * if (err) throw err;
+ * console.log(key.export().toString('hex')); // 46e..........620
+ * });
+ * ```
+ * @since v15.0.0
+ * @param type The intended use of the generated secret key. Currently accepted values are `'hmac'` and `'aes'`.
+ */
+ function generateKey(
+ type: 'hmac' | 'aes',
+ options: {
+ length: number;
+ },
+ callback: (err: Error | null, key: KeyObject) => void
+ ): void;
+ /**
+ * Synchronously generates a new random secret key of the given `length`. The`type` will determine which validations will be performed on the `length`.
+ *
+ * ```js
+ * const {
+ * generateKeySync
+ * } = await import('crypto');
+ *
+ * const key = generateKeySync('hmac', { length: 64 });
+ * console.log(key.export().toString('hex')); // e89..........41e
+ * ```
+ * @since v15.0.0
+ * @param type The intended use of the generated secret key. Currently accepted values are `'hmac'` and `'aes'`.
+ */
+ function generateKeySync(
+ type: 'hmac' | 'aes',
+ options: {
+ length: number;
+ }
+ ): KeyObject;
+ interface JsonWebKeyInput {
+ key: JsonWebKey;
+ format: 'jwk';
+ }
+ /**
+ * Creates and returns a new key object containing a private key. If `key` is a
+ * string or `Buffer`, `format` is assumed to be `'pem'`; otherwise, `key`must be an object with the properties described above.
+ *
+ * If the private key is encrypted, a `passphrase` must be specified. The length
+ * of the passphrase is limited to 1024 bytes.
+ * @since v11.6.0
+ */
+ function createPrivateKey(key: PrivateKeyInput | string | Buffer | JsonWebKeyInput): KeyObject;
+ /**
+ * Creates and returns a new key object containing a public key. If `key` is a
+ * string or `Buffer`, `format` is assumed to be `'pem'`; if `key` is a `KeyObject`with type `'private'`, the public key is derived from the given private key;
+ * otherwise, `key` must be an object with the properties described above.
+ *
+ * If the format is `'pem'`, the `'key'` may also be an X.509 certificate.
+ *
+ * Because public keys can be derived from private keys, a private key may be
+ * passed instead of a public key. In that case, this function behaves as if {@link createPrivateKey} had been called, except that the type of the
+ * returned `KeyObject` will be `'public'` and that the private key cannot be
+ * extracted from the returned `KeyObject`. Similarly, if a `KeyObject` with type`'private'` is given, a new `KeyObject` with type `'public'` will be returned
+ * and it will be impossible to extract the private key from the returned object.
+ * @since v11.6.0
+ */
+ function createPublicKey(key: PublicKeyInput | string | Buffer | KeyObject | JsonWebKeyInput): KeyObject;
+ /**
+ * Creates and returns a new key object containing a secret key for symmetric
+ * encryption or `Hmac`.
+ * @since v11.6.0
+ * @param encoding The string encoding when `key` is a string.
+ */
function createSecretKey(key: NodeJS.ArrayBufferView): KeyObject;
-
- function createSign(algorithm: string, options?: stream.WritableOptions): Signer;
-
+ function createSecretKey(key: string, encoding: BufferEncoding): KeyObject;
+ /**
+ * Creates and returns a `Sign` object that uses the given `algorithm`. Use {@link getHashes} to obtain the names of the available digest algorithms.
+ * Optional `options` argument controls the `stream.Writable` behavior.
+ *
+ * In some cases, a `Sign` instance can be created using the name of a signature
+ * algorithm, such as `'RSA-SHA256'`, instead of a digest algorithm. This will use
+ * the corresponding digest algorithm. This does not work for all signature
+ * algorithms, such as `'ecdsa-with-SHA256'`, so it is best to always use digest
+ * algorithm names.
+ * @since v0.1.92
+ * @param options `stream.Writable` options
+ */
+ function createSign(algorithm: string, options?: stream.WritableOptions): Sign;
type DSAEncoding = 'der' | 'ieee-p1363';
-
interface SigningOptions {
/**
* @See crypto.constants.RSA_PKCS1_PADDING
@@ -325,7 +1271,6 @@ declare module 'crypto' {
saltLength?: number | undefined;
dsaEncoding?: DSAEncoding | undefined;
}
-
interface SignPrivateKeyInput extends PrivateKeyInput, SigningOptions {}
interface SignKeyObjectInput extends SigningOptions {
key: KeyObject;
@@ -334,137 +1279,698 @@ declare module 'crypto' {
interface VerifyKeyObjectInput extends SigningOptions {
key: KeyObject;
}
-
+ interface VerifyJsonWebKeyInput extends JsonWebKeyInput, SigningOptions {}
type KeyLike = string | Buffer | KeyObject;
-
- class Signer extends stream.Writable {
+ /**
+ * The `Sign` class is a utility for generating signatures. It can be used in one
+ * of two ways:
+ *
+ * * As a writable `stream`, where data to be signed is written and the `sign.sign()` method is used to generate and return the signature, or
+ * * Using the `sign.update()` and `sign.sign()` methods to produce the
+ * signature.
+ *
+ * The {@link createSign} method is used to create `Sign` instances. The
+ * argument is the string name of the hash function to use. `Sign` objects are not
+ * to be created directly using the `new` keyword.
+ *
+ * Example: Using `Sign` and `Verify` objects as streams:
+ *
+ * ```js
+ * const {
+ * generateKeyPairSync,
+ * createSign,
+ * createVerify
+ * } = await import('crypto');
+ *
+ * const { privateKey, publicKey } = generateKeyPairSync('ec', {
+ * namedCurve: 'sect239k1'
+ * });
+ *
+ * const sign = createSign('SHA256');
+ * sign.write('some data to sign');
+ * sign.end();
+ * const signature = sign.sign(privateKey, 'hex');
+ *
+ * const verify = createVerify('SHA256');
+ * verify.write('some data to sign');
+ * verify.end();
+ * console.log(verify.verify(publicKey, signature, 'hex'));
+ * // Prints: true
+ * ```
+ *
+ * Example: Using the `sign.update()` and `verify.update()` methods:
+ *
+ * ```js
+ * const {
+ * generateKeyPairSync,
+ * createSign,
+ * createVerify
+ * } = await import('crypto');
+ *
+ * const { privateKey, publicKey } = generateKeyPairSync('rsa', {
+ * modulusLength: 2048,
+ * });
+ *
+ * const sign = createSign('SHA256');
+ * sign.update('some data to sign');
+ * sign.end();
+ * const signature = sign.sign(privateKey);
+ *
+ * const verify = createVerify('SHA256');
+ * verify.update('some data to sign');
+ * verify.end();
+ * console.log(verify.verify(publicKey, signature));
+ * // Prints: true
+ * ```
+ * @since v0.1.92
+ */
+ class Sign extends stream.Writable {
private constructor();
-
- update(data: BinaryLike): Signer;
- update(data: string, input_encoding: Encoding): Signer;
- sign(private_key: KeyLike | SignKeyObjectInput | SignPrivateKeyInput): Buffer;
- sign(
- private_key: KeyLike | SignKeyObjectInput | SignPrivateKeyInput,
- output_format: BinaryToTextEncoding,
- ): string;
+ /**
+ * Updates the `Sign` content with the given `data`, the encoding of which
+ * is given in `inputEncoding`.
+ * If `encoding` is not provided, and the `data` is a string, an
+ * encoding of `'utf8'` is enforced. If `data` is a `Buffer`, `TypedArray`, or`DataView`, then `inputEncoding` is ignored.
+ *
+ * This can be called many times with new data as it is streamed.
+ * @since v0.1.92
+ * @param inputEncoding The `encoding` of the `data` string.
+ */
+ update(data: BinaryLike): this;
+ update(data: string, inputEncoding: Encoding): this;
+ /**
+ * Calculates the signature on all the data passed through using either `sign.update()` or `sign.write()`.
+ *
+ * If `privateKey` is not a `KeyObject`, this function behaves as if`privateKey` had been passed to {@link createPrivateKey}. If it is an
+ * object, the following additional properties can be passed:
+ *
+ * If `outputEncoding` is provided a string is returned; otherwise a `Buffer` is returned.
+ *
+ * The `Sign` object can not be again used after `sign.sign()` method has been
+ * called. Multiple calls to `sign.sign()` will result in an error being thrown.
+ * @since v0.1.92
+ */
+ sign(privateKey: KeyLike | SignKeyObjectInput | SignPrivateKeyInput): Buffer;
+ sign(privateKey: KeyLike | SignKeyObjectInput | SignPrivateKeyInput, outputFormat: BinaryToTextEncoding): string;
}
-
+ /**
+ * Creates and returns a `Verify` object that uses the given algorithm.
+ * Use {@link getHashes} to obtain an array of names of the available
+ * signing algorithms. Optional `options` argument controls the`stream.Writable` behavior.
+ *
+ * In some cases, a `Verify` instance can be created using the name of a signature
+ * algorithm, such as `'RSA-SHA256'`, instead of a digest algorithm. This will use
+ * the corresponding digest algorithm. This does not work for all signature
+ * algorithms, such as `'ecdsa-with-SHA256'`, so it is best to always use digest
+ * algorithm names.
+ * @since v0.1.92
+ * @param options `stream.Writable` options
+ */
function createVerify(algorithm: string, options?: stream.WritableOptions): Verify;
+ /**
+ * The `Verify` class is a utility for verifying signatures. It can be used in one
+ * of two ways:
+ *
+ * * As a writable `stream` where written data is used to validate against the
+ * supplied signature, or
+ * * Using the `verify.update()` and `verify.verify()` methods to verify
+ * the signature.
+ *
+ * The {@link createVerify} method is used to create `Verify` instances.`Verify` objects are not to be created directly using the `new` keyword.
+ *
+ * See `Sign` for examples.
+ * @since v0.1.92
+ */
class Verify extends stream.Writable {
private constructor();
-
+ /**
+ * Updates the `Verify` content with the given `data`, the encoding of which
+ * is given in `inputEncoding`.
+ * If `inputEncoding` is not provided, and the `data` is a string, an
+ * encoding of `'utf8'` is enforced. If `data` is a `Buffer`, `TypedArray`, or`DataView`, then `inputEncoding` is ignored.
+ *
+ * This can be called many times with new data as it is streamed.
+ * @since v0.1.92
+ * @param inputEncoding The `encoding` of the `data` string.
+ */
update(data: BinaryLike): Verify;
- update(data: string, input_encoding: Encoding): Verify;
- verify(
- object: KeyLike | VerifyKeyObjectInput | VerifyPublicKeyInput,
- signature: NodeJS.ArrayBufferView,
- ): boolean;
- verify(
- object: KeyLike | VerifyKeyObjectInput | VerifyPublicKeyInput,
- signature: string,
- signature_format?: BinaryToTextEncoding,
- ): boolean;
- // https://nodejs.org/api/crypto.html#crypto_verifier_verify_object_signature_signature_format
- // The signature field accepts a TypedArray type, but it is only available starting ES2017
+ update(data: string, inputEncoding: Encoding): Verify;
+ /**
+ * Verifies the provided data using the given `object` and `signature`.
+ *
+ * If `object` is not a `KeyObject`, this function behaves as if`object` had been passed to {@link createPublicKey}. If it is an
+ * object, the following additional properties can be passed:
+ *
+ * The `signature` argument is the previously calculated signature for the data, in
+ * the `signatureEncoding`.
+ * If a `signatureEncoding` is specified, the `signature` is expected to be a
+ * string; otherwise `signature` is expected to be a `Buffer`,`TypedArray`, or `DataView`.
+ *
+ * The `verify` object can not be used again after `verify.verify()` has been
+ * called. Multiple calls to `verify.verify()` will result in an error being
+ * thrown.
+ *
+ * Because public keys can be derived from private keys, a private key may
+ * be passed instead of a public key.
+ * @since v0.1.92
+ */
+ verify(object: KeyLike | VerifyKeyObjectInput | VerifyPublicKeyInput | VerifyJsonWebKeyInput, signature: NodeJS.ArrayBufferView): boolean;
+ verify(object: KeyLike | VerifyKeyObjectInput | VerifyPublicKeyInput | VerifyJsonWebKeyInput, signature: string, signature_format?: BinaryToTextEncoding): boolean;
}
- function createDiffieHellman(prime_length: number, generator?: number | NodeJS.ArrayBufferView): DiffieHellman;
+ /**
+ * Creates a `DiffieHellman` key exchange object using the supplied `prime` and an
+ * optional specific `generator`.
+ *
+ * The `generator` argument can be a number, string, or `Buffer`. If`generator` is not specified, the value `2` is used.
+ *
+ * If `primeEncoding` is specified, `prime` is expected to be a string; otherwise
+ * a `Buffer`, `TypedArray`, or `DataView` is expected.
+ *
+ * If `generatorEncoding` is specified, `generator` is expected to be a string;
+ * otherwise a number, `Buffer`, `TypedArray`, or `DataView` is expected.
+ * @since v0.11.12
+ * @param primeEncoding The `encoding` of the `prime` string.
+ * @param [generator=2]
+ * @param generatorEncoding The `encoding` of the `generator` string.
+ */
+ function createDiffieHellman(primeLength: number, generator?: number | NodeJS.ArrayBufferView): DiffieHellman;
function createDiffieHellman(prime: NodeJS.ArrayBufferView): DiffieHellman;
- function createDiffieHellman(prime: string, prime_encoding: BinaryToTextEncoding): DiffieHellman;
- function createDiffieHellman(
- prime: string,
- prime_encoding: BinaryToTextEncoding,
- generator: number | NodeJS.ArrayBufferView,
- ): DiffieHellman;
- function createDiffieHellman(
- prime: string,
- prime_encoding: BinaryToTextEncoding,
- generator: string,
- generator_encoding: BinaryToTextEncoding,
- ): DiffieHellman;
+ function createDiffieHellman(prime: string, primeEncoding: BinaryToTextEncoding): DiffieHellman;
+ function createDiffieHellman(prime: string, primeEncoding: BinaryToTextEncoding, generator: number | NodeJS.ArrayBufferView): DiffieHellman;
+ function createDiffieHellman(prime: string, primeEncoding: BinaryToTextEncoding, generator: string, generatorEncoding: BinaryToTextEncoding): DiffieHellman;
+ /**
+ * The `DiffieHellman` class is a utility for creating Diffie-Hellman key
+ * exchanges.
+ *
+ * Instances of the `DiffieHellman` class can be created using the {@link createDiffieHellman} function.
+ *
+ * ```js
+ * import assert from 'assert';
+ *
+ * const {
+ * createDiffieHellman
+ * } = await import('crypto');
+ *
+ * // Generate Alice's keys...
+ * const alice = createDiffieHellman(2048);
+ * const aliceKey = alice.generateKeys();
+ *
+ * // Generate Bob's keys...
+ * const bob = createDiffieHellman(alice.getPrime(), alice.getGenerator());
+ * const bobKey = bob.generateKeys();
+ *
+ * // Exchange and generate the secret...
+ * const aliceSecret = alice.computeSecret(bobKey);
+ * const bobSecret = bob.computeSecret(aliceKey);
+ *
+ * // OK
+ * assert.strictEqual(aliceSecret.toString('hex'), bobSecret.toString('hex'));
+ * ```
+ * @since v0.5.0
+ */
class DiffieHellman {
private constructor();
+ /**
+ * Generates private and public Diffie-Hellman key values, and returns
+ * the public key in the specified `encoding`. This key should be
+ * transferred to the other party.
+ * If `encoding` is provided a string is returned; otherwise a `Buffer` is returned.
+ * @since v0.5.0
+ * @param encoding The `encoding` of the return value.
+ */
generateKeys(): Buffer;
generateKeys(encoding: BinaryToTextEncoding): string;
- computeSecret(other_public_key: NodeJS.ArrayBufferView): Buffer;
- computeSecret(other_public_key: string, input_encoding: BinaryToTextEncoding): Buffer;
- computeSecret(other_public_key: NodeJS.ArrayBufferView, output_encoding: BinaryToTextEncoding): string;
- computeSecret(
- other_public_key: string,
- input_encoding: BinaryToTextEncoding,
- output_encoding: BinaryToTextEncoding,
- ): string;
+ /**
+ * Computes the shared secret using `otherPublicKey` as the other
+ * party's public key and returns the computed shared secret. The supplied
+ * key is interpreted using the specified `inputEncoding`, and secret is
+ * encoded using specified `outputEncoding`.
+ * If the `inputEncoding` is not
+ * provided, `otherPublicKey` is expected to be a `Buffer`,`TypedArray`, or `DataView`.
+ *
+ * If `outputEncoding` is given a string is returned; otherwise, a `Buffer` is returned.
+ * @since v0.5.0
+ * @param inputEncoding The `encoding` of an `otherPublicKey` string.
+ * @param outputEncoding The `encoding` of the return value.
+ */
+ computeSecret(otherPublicKey: NodeJS.ArrayBufferView, inputEncoding?: null, outputEncoding?: null): Buffer;
+ computeSecret(otherPublicKey: string, inputEncoding: BinaryToTextEncoding, outputEncoding?: null): Buffer;
+ computeSecret(otherPublicKey: NodeJS.ArrayBufferView, inputEncoding: null, outputEncoding: BinaryToTextEncoding): string;
+ computeSecret(otherPublicKey: string, inputEncoding: BinaryToTextEncoding, outputEncoding: BinaryToTextEncoding): string;
+ /**
+ * Returns the Diffie-Hellman prime in the specified `encoding`.
+ * If `encoding` is provided a string is
+ * returned; otherwise a `Buffer` is returned.
+ * @since v0.5.0
+ * @param encoding The `encoding` of the return value.
+ */
getPrime(): Buffer;
getPrime(encoding: BinaryToTextEncoding): string;
+ /**
+ * Returns the Diffie-Hellman generator in the specified `encoding`.
+ * If `encoding` is provided a string is
+ * returned; otherwise a `Buffer` is returned.
+ * @since v0.5.0
+ * @param encoding The `encoding` of the return value.
+ */
getGenerator(): Buffer;
getGenerator(encoding: BinaryToTextEncoding): string;
+ /**
+ * Returns the Diffie-Hellman public key in the specified `encoding`.
+ * If `encoding` is provided a
+ * string is returned; otherwise a `Buffer` is returned.
+ * @since v0.5.0
+ * @param encoding The `encoding` of the return value.
+ */
getPublicKey(): Buffer;
getPublicKey(encoding: BinaryToTextEncoding): string;
+ /**
+ * Returns the Diffie-Hellman private key in the specified `encoding`.
+ * If `encoding` is provided a
+ * string is returned; otherwise a `Buffer` is returned.
+ * @since v0.5.0
+ * @param encoding The `encoding` of the return value.
+ */
getPrivateKey(): Buffer;
getPrivateKey(encoding: BinaryToTextEncoding): string;
- setPublicKey(public_key: NodeJS.ArrayBufferView): void;
- setPublicKey(public_key: string, encoding: BufferEncoding): void;
- setPrivateKey(private_key: NodeJS.ArrayBufferView): void;
- setPrivateKey(private_key: string, encoding: BufferEncoding): void;
+ /**
+ * Sets the Diffie-Hellman public key. If the `encoding` argument is provided,`publicKey` is expected
+ * to be a string. If no `encoding` is provided, `publicKey` is expected
+ * to be a `Buffer`, `TypedArray`, or `DataView`.
+ * @since v0.5.0
+ * @param encoding The `encoding` of the `publicKey` string.
+ */
+ setPublicKey(publicKey: NodeJS.ArrayBufferView): void;
+ setPublicKey(publicKey: string, encoding: BufferEncoding): void;
+ /**
+ * Sets the Diffie-Hellman private key. If the `encoding` argument is provided,`privateKey` is expected
+ * to be a string. If no `encoding` is provided, `privateKey` is expected
+ * to be a `Buffer`, `TypedArray`, or `DataView`.
+ * @since v0.5.0
+ * @param encoding The `encoding` of the `privateKey` string.
+ */
+ setPrivateKey(privateKey: NodeJS.ArrayBufferView): void;
+ setPrivateKey(privateKey: string, encoding: BufferEncoding): void;
+ /**
+ * A bit field containing any warnings and/or errors resulting from a check
+ * performed during initialization of the `DiffieHellman` object.
+ *
+ * The following values are valid for this property (as defined in `constants`module):
+ *
+ * * `DH_CHECK_P_NOT_SAFE_PRIME`
+ * * `DH_CHECK_P_NOT_PRIME`
+ * * `DH_UNABLE_TO_CHECK_GENERATOR`
+ * * `DH_NOT_SUITABLE_GENERATOR`
+ * @since v0.11.12
+ */
verifyError: number;
}
- function getDiffieHellman(group_name: string): DiffieHellman;
- function pbkdf2(
- password: BinaryLike,
- salt: BinaryLike,
- iterations: number,
- keylen: number,
- digest: string,
- callback: (err: Error | null, derivedKey: Buffer) => any,
- ): void;
- function pbkdf2Sync(
- password: BinaryLike,
- salt: BinaryLike,
- iterations: number,
- keylen: number,
- digest: string,
- ): Buffer;
-
+ /**
+ * The `DiffieHellmanGroup` class takes a well-known modp group as its argument.
+ * It works the same as `DiffieHellman`, except that it does not allow changing its keys after creation.
+ * In other words, it does not implement `setPublicKey()` or `setPrivateKey()` methods.
+ *
+ * ```js
+ * const { createDiffieHellmanGroup } = await import('node:crypto');
+ * const dh = createDiffieHellmanGroup('modp1');
+ * ```
+ * The name (e.g. `'modp1'`) is taken from [RFC 2412](https://www.rfc-editor.org/rfc/rfc2412.txt) (modp1 and 2) and [RFC 3526](https://www.rfc-editor.org/rfc/rfc3526.txt):
+ * ```bash
+ * $ perl -ne 'print "$1\n" if /"(modp\d+)"/' src/node_crypto_groups.h
+ * modp1 # 768 bits
+ * modp2 # 1024 bits
+ * modp5 # 1536 bits
+ * modp14 # 2048 bits
+ * modp15 # etc.
+ * modp16
+ * modp17
+ * modp18
+ * ```
+ * @since v0.7.5
+ */
+ const DiffieHellmanGroup: DiffieHellmanGroupConstructor;
+ interface DiffieHellmanGroupConstructor {
+ new(name: string): DiffieHellmanGroup;
+ (name: string): DiffieHellmanGroup;
+ readonly prototype: DiffieHellmanGroup;
+ }
+ type DiffieHellmanGroup = Omit;
+ /**
+ * Creates a predefined `DiffieHellmanGroup` key exchange object. The
+ * supported groups are: `'modp1'`, `'modp2'`, `'modp5'` (defined in [RFC 2412](https://www.rfc-editor.org/rfc/rfc2412.txt), but see `Caveats`) and `'modp14'`, `'modp15'`,`'modp16'`, `'modp17'`,
+ * `'modp18'` (defined in [RFC 3526](https://www.rfc-editor.org/rfc/rfc3526.txt)). The
+ * returned object mimics the interface of objects created by {@link createDiffieHellman}, but will not allow changing
+ * the keys (with `diffieHellman.setPublicKey()`, for example). The
+ * advantage of using this method is that the parties do not have to
+ * generate nor exchange a group modulus beforehand, saving both processor
+ * and communication time.
+ *
+ * Example (obtaining a shared secret):
+ *
+ * ```js
+ * const {
+ * getDiffieHellman
+ * } = await import('crypto');
+ * const alice = getDiffieHellman('modp14');
+ * const bob = getDiffieHellman('modp14');
+ *
+ * alice.generateKeys();
+ * bob.generateKeys();
+ *
+ * const aliceSecret = alice.computeSecret(bob.getPublicKey(), null, 'hex');
+ * const bobSecret = bob.computeSecret(alice.getPublicKey(), null, 'hex');
+ *
+ * // aliceSecret and bobSecret should be the same
+ * console.log(aliceSecret === bobSecret);
+ * ```
+ * @since v0.7.5
+ */
+ function getDiffieHellman(groupName: string): DiffieHellmanGroup;
+ /**
+ * An alias for {@link getDiffieHellman}
+ * @since v0.9.3
+ */
+ function createDiffieHellmanGroup(name: string): DiffieHellmanGroup;
+ /**
+ * Provides an asynchronous Password-Based Key Derivation Function 2 (PBKDF2)
+ * implementation. A selected HMAC digest algorithm specified by `digest` is
+ * applied to derive a key of the requested byte length (`keylen`) from the`password`, `salt` and `iterations`.
+ *
+ * The supplied `callback` function is called with two arguments: `err` and`derivedKey`. If an error occurs while deriving the key, `err` will be set;
+ * otherwise `err` will be `null`. By default, the successfully generated`derivedKey` will be passed to the callback as a `Buffer`. An error will be
+ * thrown if any of the input arguments specify invalid values or types.
+ *
+ * If `digest` is `null`, `'sha1'` will be used. This behavior is deprecated,
+ * please specify a `digest` explicitly.
+ *
+ * The `iterations` argument must be a number set as high as possible. The
+ * higher the number of iterations, the more secure the derived key will be,
+ * but will take a longer amount of time to complete.
+ *
+ * The `salt` should be as unique as possible. It is recommended that a salt is
+ * random and at least 16 bytes long. See [NIST SP 800-132](https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-132.pdf) for details.
+ *
+ * When passing strings for `password` or `salt`, please consider `caveats when using strings as inputs to cryptographic APIs`.
+ *
+ * ```js
+ * const {
+ * pbkdf2
+ * } = await import('crypto');
+ *
+ * pbkdf2('secret', 'salt', 100000, 64, 'sha512', (err, derivedKey) => {
+ * if (err) throw err;
+ * console.log(derivedKey.toString('hex')); // '3745e48...08d59ae'
+ * });
+ * ```
+ *
+ * The `crypto.DEFAULT_ENCODING` property can be used to change the way the`derivedKey` is passed to the callback. This property, however, has been
+ * deprecated and use should be avoided.
+ *
+ * ```js
+ * import crypto from 'crypto';
+ * crypto.DEFAULT_ENCODING = 'hex';
+ * crypto.pbkdf2('secret', 'salt', 100000, 512, 'sha512', (err, derivedKey) => {
+ * if (err) throw err;
+ * console.log(derivedKey); // '3745e48...aa39b34'
+ * });
+ * ```
+ *
+ * An array of supported digest functions can be retrieved using {@link getHashes}.
+ *
+ * This API uses libuv's threadpool, which can have surprising and
+ * negative performance implications for some applications; see the `UV_THREADPOOL_SIZE` documentation for more information.
+ * @since v0.5.5
+ */
+ function pbkdf2(password: BinaryLike, salt: BinaryLike, iterations: number, keylen: number, digest: string, callback: (err: Error | null, derivedKey: Buffer) => void): void;
+ /**
+ * Provides a synchronous Password-Based Key Derivation Function 2 (PBKDF2)
+ * implementation. A selected HMAC digest algorithm specified by `digest` is
+ * applied to derive a key of the requested byte length (`keylen`) from the`password`, `salt` and `iterations`.
+ *
+ * If an error occurs an `Error` will be thrown, otherwise the derived key will be
+ * returned as a `Buffer`.
+ *
+ * If `digest` is `null`, `'sha1'` will be used. This behavior is deprecated,
+ * please specify a `digest` explicitly.
+ *
+ * The `iterations` argument must be a number set as high as possible. The
+ * higher the number of iterations, the more secure the derived key will be,
+ * but will take a longer amount of time to complete.
+ *
+ * The `salt` should be as unique as possible. It is recommended that a salt is
+ * random and at least 16 bytes long. See [NIST SP 800-132](https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-132.pdf) for details.
+ *
+ * When passing strings for `password` or `salt`, please consider `caveats when using strings as inputs to cryptographic APIs`.
+ *
+ * ```js
+ * const {
+ * pbkdf2Sync
+ * } = await import('crypto');
+ *
+ * const key = pbkdf2Sync('secret', 'salt', 100000, 64, 'sha512');
+ * console.log(key.toString('hex')); // '3745e48...08d59ae'
+ * ```
+ *
+ * The `crypto.DEFAULT_ENCODING` property may be used to change the way the`derivedKey` is returned. This property, however, is deprecated and use
+ * should be avoided.
+ *
+ * ```js
+ * import crypto from 'crypto';
+ * crypto.DEFAULT_ENCODING = 'hex';
+ * const key = crypto.pbkdf2Sync('secret', 'salt', 100000, 512, 'sha512');
+ * console.log(key); // '3745e48...aa39b34'
+ * ```
+ *
+ * An array of supported digest functions can be retrieved using {@link getHashes}.
+ * @since v0.9.3
+ */
+ function pbkdf2Sync(password: BinaryLike, salt: BinaryLike, iterations: number, keylen: number, digest: string): Buffer;
+ /**
+ * Generates cryptographically strong pseudorandom data. The `size` argument
+ * is a number indicating the number of bytes to generate.
+ *
+ * If a `callback` function is provided, the bytes are generated asynchronously
+ * and the `callback` function is invoked with two arguments: `err` and `buf`.
+ * If an error occurs, `err` will be an `Error` object; otherwise it is `null`. The`buf` argument is a `Buffer` containing the generated bytes.
+ *
+ * ```js
+ * // Asynchronous
+ * const {
+ * randomBytes
+ * } = await import('crypto');
+ *
+ * randomBytes(256, (err, buf) => {
+ * if (err) throw err;
+ * console.log(`${buf.length} bytes of random data: ${buf.toString('hex')}`);
+ * });
+ * ```
+ *
+ * If the `callback` function is not provided, the random bytes are generated
+ * synchronously and returned as a `Buffer`. An error will be thrown if
+ * there is a problem generating the bytes.
+ *
+ * ```js
+ * // Synchronous
+ * const {
+ * randomBytes
+ * } = await import('crypto');
+ *
+ * const buf = randomBytes(256);
+ * console.log(
+ * `${buf.length} bytes of random data: ${buf.toString('hex')}`);
+ * ```
+ *
+ * The `crypto.randomBytes()` method will not complete until there is
+ * sufficient entropy available.
+ * This should normally never take longer than a few milliseconds. The only time
+ * when generating the random bytes may conceivably block for a longer period of
+ * time is right after boot, when the whole system is still low on entropy.
+ *
+ * This API uses libuv's threadpool, which can have surprising and
+ * negative performance implications for some applications; see the `UV_THREADPOOL_SIZE` documentation for more information.
+ *
+ * The asynchronous version of `crypto.randomBytes()` is carried out in a single
+ * threadpool request. To minimize threadpool task length variation, partition
+ * large `randomBytes` requests when doing so as part of fulfilling a client
+ * request.
+ * @since v0.5.8
+ * @param size The number of bytes to generate. The `size` must not be larger than `2**31 - 1`.
+ * @return if the `callback` function is not provided.
+ */
function randomBytes(size: number): Buffer;
function randomBytes(size: number, callback: (err: Error | null, buf: Buffer) => void): void;
function pseudoRandomBytes(size: number): Buffer;
function pseudoRandomBytes(size: number, callback: (err: Error | null, buf: Buffer) => void): void;
-
+ /**
+ * Return a random integer `n` such that `min <= n < max`. This
+ * implementation avoids [modulo bias](https://en.wikipedia.org/wiki/Fisher%E2%80%93Yates_shuffle#Modulo_bias).
+ *
+ * The range (`max - min`) must be less than `2**48`. `min` and `max` must
+ * be [safe integers](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isSafeInteger).
+ *
+ * If the `callback` function is not provided, the random integer is
+ * generated synchronously.
+ *
+ * ```js
+ * // Asynchronous
+ * const {
+ * randomInt
+ * } = await import('crypto');
+ *
+ * randomInt(3, (err, n) => {
+ * if (err) throw err;
+ * console.log(`Random number chosen from (0, 1, 2): ${n}`);
+ * });
+ * ```
+ *
+ * ```js
+ * // Synchronous
+ * const {
+ * randomInt
+ * } = await import('crypto');
+ *
+ * const n = randomInt(3);
+ * console.log(`Random number chosen from (0, 1, 2): ${n}`);
+ * ```
+ *
+ * ```js
+ * // With `min` argument
+ * const {
+ * randomInt
+ * } = await import('crypto');
+ *
+ * const n = randomInt(1, 7);
+ * console.log(`The dice rolled: ${n}`);
+ * ```
+ * @since v14.10.0, v12.19.0
+ * @param [min=0] Start of random range (inclusive).
+ * @param max End of random range (exclusive).
+ * @param callback `function(err, n) {}`.
+ */
function randomInt(max: number): number;
function randomInt(min: number, max: number): number;
function randomInt(max: number, callback: (err: Error | null, value: number) => void): void;
function randomInt(min: number, max: number, callback: (err: Error | null, value: number) => void): void;
-
+ /**
+ * Synchronous version of {@link randomFill}.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ * const { randomFillSync } = await import('crypto');
+ *
+ * const buf = Buffer.alloc(10);
+ * console.log(randomFillSync(buf).toString('hex'));
+ *
+ * randomFillSync(buf, 5);
+ * console.log(buf.toString('hex'));
+ *
+ * // The above is equivalent to the following:
+ * randomFillSync(buf, 5, 5);
+ * console.log(buf.toString('hex'));
+ * ```
+ *
+ * Any `ArrayBuffer`, `TypedArray` or `DataView` instance may be passed as`buffer`.
+ *
+ * ```js
+ * import { Buffer } from 'buffer';
+ * const { randomFillSync } = await import('crypto');
+ *
+ * const a = new Uint32Array(10);
+ * console.log(Buffer.from(randomFillSync(a).buffer,
+ * a.byteOffset, a.byteLength).toString('hex'));
+ *
+ * const b = new DataView(new ArrayBuffer(10));
+ * console.log(Buffer.from(randomFillSync(b).buffer,
+ * b.byteOffset, b.byteLength).toString('hex'));
+ *
+ * const c = new ArrayBuffer(10);
+ * console.log(Buffer.from(randomFillSync(c)).toString('hex'));
+ * ```
+ * @since v7.10.0, v6.13.0
+ * @param buffer Must be supplied. The size of the provided `buffer` must not be larger than `2**31 - 1`.
+ * @param [offset=0]
+ * @param [size=buffer.length - offset]
+ * @return The object passed as `buffer` argument.
+ */
function randomFillSync
${code}`;
+ }
+ else {
+ return `${RED._("markdownEditor.mermaid.summary")}
${code}" +code +"Let's take a moment to discover the new features in this release.
", + "ja": "本リリースの新機能を見つけてみましょう。
", + "fr": "Prenons un moment pour découvrir les nouvelles fonctionnalités de cette version.
" + } + }, + { + title: { + "en-US": "Context Menu", + "ja": "コンテキストメニュー", + "fr": "Menu contextuel" + }, + image: '3.0/images/context-menu.png', + description: { + "en-US": `The editor now has its own context menu when you + right-click in the workspace.
+This makes many of the built-in actions much easier + to access.
`, + "ja": `ワークスペースで右クリックすると、エディタに独自のコンテキストメニューが表示されるようになりました。
+これによって多くの組み込み動作を、より簡単に利用できます。
`, + "fr": `L'éditeur a maintenant son propre menu contextuel lorsque vous + faites un clic droit dans l'espace de travail.
+Cela facilite l'accès à de nombreuses actions intégrées.
` + } + }, + { + title: { + "en-US": "Wire Junctions", + "ja": "分岐点をワイヤーに追加", + "fr": "Jonctions de fils" + }, + image: '3.0/images/junction-slice.gif', + description: { + "en-US": `To make it easier to route wires around your flows, + it is now possible to add junction nodes that give + you more control.
+Junctions can be added to wires by holding both the Alt key and the Shift key + then click and drag the mouse across the wires.
`, + "ja": `フローのワイヤーの経路をより制御しやすくするために、分岐点ノードを追加できるようになりました。
+Altキーとシフトキーを押しながらマウスをクリックし、ワイヤーを横切るようにドラッグすることで、分岐点を追加できます。
`, + "fr": `Pour faciliter le routage des câbles autour de vos flux, il est désormais possible d'ajouter des noeuds + de jonction qui vous donnent plus de contrôle.
+Les jonctions peuvent être ajoutées aux fils en maintenant les touches Alt et Maj enfoncées, puis en cliquant + et en faisant glisser la souris sur les fils.
` + }, + }, + { + title: { + "en-US": "Wire Junctions", + "ja": "分岐点をワイヤーに追加", + "fr": "Jonctions de fils" + }, + image: '3.0/images/junction-quick-add.png', + description: { + "en-US": `Junctions can also be added using the quick-add dialog.
+The dialog is opened by holding the Ctrl (or Cmd) key when + clicking in the workspace.
`, + "ja": `クイック追加ダイアログを用いて、分岐点を追加することもできます。
+本ダイアログを開くには、Ctrl(またはCmd)キーを押しながら、ワークスペース上でクリックします。
`, + "fr": `Les jonctions peuvent également être ajoutées à l'aide de la boîte de dialogue d'ajout rapide.
+La boîte de dialogue s'ouvre en maintenant la touche Ctrl (ou Cmd) enfoncée lors d'un clic dans l'espace de travail.
` + }, + }, + { + title: { + "en-US": "Debug Path Tooltip", + "ja": "デバッグパスのツールチップ", + "fr": "Info-bulle du chemin de débogage" + }, + image: '3.0/images/debug-path-tooltip.png', + description: { + "en-US": `When hovering over a node name in the Debug sidebar, a + new tooltip shows the full location of the node.
+This is useful when working with subflows, making it + much easier to identify exactly which node generated + the message.
+Clicking on any item in the list will reveal it in + the workspace.
`, + "ja": `デバックサイドバー内のノード名の上にマウスカーソルを乗せると、新たにツールチップが表示され、ノードの場所が分かるようになっています。
+これは、サブフローを用いる時に役立つ機能であり、メッセージがどのノードから出力されたかを正確に特定することが遥かに簡単になります。
+本リスト内の要素をクリックすると、ワークスペース内にその要素が表示されます。
`, + "fr": `Lorsque vous passez la souris sur un nom de noeud dans la barre latérale de débogage, une nouvelle info-bulle affiche l'emplacement complet du noeud.
+C'est utile lorsque vous travaillez avec des sous-flux, ce qui facilite l'identification exacte du noeud qui a généré le message.
+Cliquer sur n'importe quel élément de la liste le révélera dans l'espace de travail.
` + }, + }, + { + title: { + "en-US": "Continuous Search", + "ja": "連続した検索", + "fr": "Recherche continue" + }, + image: '3.0/images/continuous-search.png', + description: { + "en-US": `When searching for things in the editor, a new toolbar in + the workspace provides options to quickly jump between + the search results.
`, + "ja": `ワークスペース内の新しいツールバーにあるオプションによって、エディタ内を検索する際に、検索結果の間を素早く移動できます。
`, + "fr": `Lorsque vous recherchez des éléments dans l'éditeur, une nouvelle barre d'outils dans l'espace de travail fournit des options pour passer + rapidement d'un résultat de recherche à l'autre.
` + }, + }, + { + title: { + "en-US": "New wiring actions", + "ja": "新しいワイヤー操作", + "fr": "Nouvelles actions de câblage" + }, + image: "3.0/images/split-wire-with-links.gif", + description: { + "en-US": `A new action has been added that will replace a wire with a pair of connected Link nodes:
+-
+
Split Wire With Link Nodes
+
Actions can be accessed from the Action List in the main menu.
`, + "ja": `ワイヤーを、接続されたLinkノードのペアに置き換える動作が新たに追加されました:
+-
+
ワイヤーをlinkノードで分割
+
本アクションは、メインメニュー内の動作一覧から呼び出せます。
`, + "fr": `Une nouvelle action a été ajoutée pour remplacer un fil par une paire de noeuds de lien connectés :
+-
+
Diviser le fil avec les noeuds de liaison
+
Les actions sont accessibles à partir de la liste d'actions dans le menu principal.
` + }, + }, + { + title: { + "en-US": "Default node names", + "ja": "標準ノードの名前", + "fr": "Noms de noeud par défaut" + }, + // image: "images/", + description: { + "en-US": `Some nodes have been updated to generate a unique name when
+ new instances are added to the workspace. This applies to
+ Debug, Function and Link nodes.
A new action has also been added to generate default names for the selected + nodes:
+-
+
Generate Node Names
+
Actions can be accessed from the Action List in the main menu.
+ `, + "ja": `一部のノードは、ワークスペース上に新インスタンスとして追加した際に、一意の名前を付けるよう変更されました。この変更は、Debug、Function、Linkノードに適用されています。
選択したノードに対して、標準の名前を生成する動作も新たに追加されました:
+-
+
ノード名を生成
+
本アクションは、メインメニュー内の動作一覧から呼び出せます。
+ `, + "fr": `Certains noeuds ont été mis à jour pour générer un nom unique lorsque
+ de nouvelles instances sont ajoutées à l'espace de travail. Ceci s'applique aux
+ noeuds Debug, Function et Link.
Une nouvelle action a également été ajoutée pour générer des noms par défaut pour les noeuds sélectionnés :
+-
+
Générer des noms de noeud
+
Les actions sont accessibles à partir de la liste d'actions dans le menu principal.
` + } + }, + { + title: { + "en-US": "Node Updates", + "ja": "ノードの更新", + "fr": "Mises à jour des noeuds" + }, + // image: "images/", + description: { + "en-US": `-
+
- The Debug node can be configured to count messages it receives +
- The Link Call node can use a message property to dynamically target the link it should call +
- The HTTP Request node can be preconfigured with HTTP headers +
-
+
- Debugノードは、受信したメッセージの数をカウントするよう設定できるようになりました。 +
- Link Callノードは、メッセージのプロパティによって、呼び出し対象のlinkを動的に指定できるようになりました。 +
- HTTP Requestノードは、HTTPヘッダを事前設定できるようになりました。 +
-
+
- Le noeud de débogage peut être configuré pour compter les messages qu'il reçoit +
- Le noeud Link Call peut utiliser une propriété de message pour cibler dynamiquement le lien qu'il doit appeler +
- Le noeud de requête HTTP peut être préconfiguré avec des en-têtes HTTP +
Let's take a moment to discover the new features in this release.
", - "ja": "本リリースの新機能を見つけてみましょう。
" + "en-US": "This is the third beta release for 3.1.0. This is mostly a bug fix release, so you can skip this tour if you've tried the other betas.
If not, stick around to see what's new in Node-RED 3.1.
", + "ja": "これは3.1.0の3回目のベータリリースです。不具合修正のリリースのため、もし他のベータ版を試したことがある場合は、このツアーを読み飛ばしてもかまいません。
そうでない場合は、Node-RED 3.1の新機能を確認してください。
", + "fr": "Il s'agit de la troisième bêta de la version 3.1.0. Cette version apporte principalement la correction de bugs, vous pouvez donc ignorer cette visite guidée si vous avez essayé les autres versions bêta.
Si ce n'est pas le cas, restez dans les parages pour voir les nouveautés de Node-RED 3.1.
" } }, { title: { - "en-US": "Context Menu", - "ja": "コンテキストメニュー" + "en-US": "New ways to work with groups", + "ja": "グループの新たな操作方法", + "fr": "De nouvelles façons de travailler avec les groupes" + }, + description: { + "en-US": `We have changed how you interact with groups in the editor.
+-
+
- They don't get in the way when clicking on a node +
- They can be reordered using the Moving Forwards and Move Backwards actions +
- Multiple nodes can be dragged into a group in one go +
- Holding
Altwhen dragging a node will *remove* it from its group
+
エディタ上のグループの操作が変更されました。
+-
+
- グループ内のノードをクリックする時に、グループが邪魔をすることが無くなりました。 +
- 「前面へ移動」と「背面へ移動」の動作を用いて、複数のグループの表示順序を変えることができます。 +
- グループ内へ一度に複数のノードをドラッグできるようになりました。 +
Altを押したまま、グループ内のノードをドラッグすると、そのグループから *除く* ことができます。
+
Nous avons modifié la façon dont vous interagissez avec les groupes dans l'éditeur.
+-
+
- Ils ne gênent plus lorsque vous cliquez sur un noeud +
- Ils peuvent être réorganisés à l'aide des actions Avancer et Reculer +
- Plusieurs noeuds peuvent être glissés dans un groupe en une seule fois +
- Maintenir
Altlors du déplacement d'un noeud le *supprimera* de son groupe
+
When a tab contains undeployed changes it now shows the + same style of change icon used by nodes.
+This will make it much easier to track down changes when you're + working across multiple flows.
`, + "ja": `タブ内にデプロイされていない変更が存在する時は、ノードと同じスタイルで変更の印が表示されるようになりました。
+これによって複数のフローを編集している時に、変更を見つけるのが簡単になりました。
`, + "fr": `Lorsqu'un onglet contient des modifications non déployées, il affiche désormais le + même style d'icône de changement utilisé par les noeuds.
+Cela facilitera grandement le suivi des modifications lorsque vous + travaillez sur plusieurs flux.
` + } + }, + { + title: { + "en-US": "A bigger canvas to work with", + "ja": "より広くなった作業キャンバス", + "fr": "Un canevas plus grand pour travailler" + }, + description: { + "en-US": `The default canvas size has been increased so you can fit more + into one flow.
+We still recommend using tools such as subflows and Link Nodes to help + keep things organised, but now you have more room to work in.
`, + "ja": `標準のキャンバスが広くなったため、1つのフローに沢山のものを含めることができるようになりました。
+引き続き、サブフローやリンクノードなどの方法を用いて整理することをお勧めしますが、作業できる場所が増えました。
`, + "fr": `La taille par défaut du canevas a été augmentée pour que vous puissiez en mettre plus + sur un seul flux.
+Nous recommandons toujours d'utiliser des outils tels que les sous-flux et les noeuds de lien pour vous aider + à garder les choses organisées, mais vous avez maintenant plus d'espace pour travailler.
` + } + }, + { + title: { + "en-US": "Finding help", + "ja": "ヘルプを見つける", + "fr": "Trouver de l'aide" + }, + image: 'images/node-help.png', + description: { + "en-US": `All node edit dialogs now include a link to that node's help + in the footer.
+Clicking it will open up the Help sidebar showing the help for that node.
`, + "ja": `全てのノードの編集ダイアログの下に、ノードのヘルプへのリンクが追加されました。
+これをクリックすると、ノードのヘルプサイドバーが表示されます。
`, + "fr": `Toutes les boîtes de dialogue d'édition de noeud incluent désormais un lien vers l'aide de ce noeud + dans le pied de page.
+Cliquer dessus ouvrira la barre latérale d'aide affichant l'aide pour ce noeud.
` + } + }, + { + title: { + "en-US": "And lots more...", + "ja": "そしてさらに沢山あります...", + "fr": "Et plus encore..." + }, + description: { + "en-US": `Of course we have everything from 3.1.0-beta.1 as well....
`, + "ja": `もちろん3.1.0 ベータ1の全ての機能があります....
`, + "fr": `Bien sûr, nous avons également tout ce qui concerne la version 3.1.0-beta.1...
` + } + }, + { + title: { + "en-US": "Improved Context Menu", + "ja": "コンテキストメニューの改善", + "fr": "Menu contextuel amélioré" }, image: 'images/context-menu.png', description: { - "en-US": `The editor now has its own context menu when you - right-click in the workspace.
-This makes many of the built-in actions much easier - to access.
`, - "ja": `ワークスペースで右クリックすると、エディタに独自のコンテキストメニューが表示されるようになりました。
-これによって多くの組み込み動作を、より簡単に利用できます。
` + "en-US": `The editor's context menu has been expanded to make lots more of + the built-in actions available.
+Adding nodes, working with groups and plenty + of other useful tools are now just a click away.
+The flow tab bar also has its own context menu to make working + with your flows much easier.
`, + "ja": `より多くの組み込み動作を利用できるように、エディタのコンテキストメニューが拡張されました。
+ノードの追加、グループの操作、その他の便利なツールをクリックするだけで実行できるようになりました。
+フローのタブバーには、フローの操作をより簡単にする独自のコンテキストメニューもあります。
`, + "fr": `Le menu contextuel de l'éditeur a été étendu pour faire beaucoup plus d'actions intégrées disponibles.
+Ajouter des noeuds, travailler avec des groupes et beaucoup d'autres outils utiles sont désormais à portée de clic.
+La barre d'onglets de flux possède également son propre menu contextuel pour faciliter l'utilisation de vos flux.
` } }, { title: { - "en-US": "Wire Junctions", - "ja": "分岐点をワイヤーに追加" + "en-US": "Hiding Flows", + "ja": "フローを非表示", + "fr": "Masquage de flux" }, - image: 'images/junction-slice.gif', + image: 'images/hiding-flows.png', description: { - "en-US": `To make it easier to route wires around your flows, - it is now possible to add junction nodes that give - you more control.
-Junctions can be added to wires by holding both the Alt key and the Shift key - then click and drag the mouse across the wires.
`, - "ja": `フローのワイヤーの経路をより制御しやすくするために、分岐点ノードを追加できるようになりました。
-Altキーとシフトキーを押しながらマウスをクリックし、ワイヤーを横切るようにドラッグすることで、分岐点を追加できます。
` + "en-US": `Hiding flows is now done through the flow context menu.
+The 'hide' button in previous releases has been removed from the tabs + as they were being clicked accidentally too often.
`, + "ja": `フローを非表示にする機能は、フローのコンテキストメニューから実行するようになりました。
+これまでのリリースでタブに存在していた「非表示」ボタンは、よく誤ってクリックされていたため、削除されました。
`, + "fr": `Le masquage des flux s'effectue désormais via le menu contextuel du flux.
+Le bouton "Masquer" des versions précédentes a été supprimé des onglets + car il était cliqué accidentellement trop souvent.
` }, }, { title: { - "en-US": "Wire Junctions", - "ja": "分岐点をワイヤーに追加" + "en-US": "Locking Flows", + "ja": "フローを固定", + "fr": "Verrouillage de flux" }, - image: 'images/junction-quick-add.png', + image: 'images/locking-flows.png', description: { - "en-US": `Junctions can also be added using the quick-add dialog.
-The dialog is opened by holding the Ctrl (or Cmd) key when - clicking in the workspace.
`, - "ja": `クイック追加ダイアログを用いて、分岐点を追加することもできます。
-本ダイアログを開くには、Ctrl(またはCmd)キーを押しながら、ワークスペース上でクリックします。
` + "en-US": `Flows can now be locked to prevent accidental changes being made.
+When locked you cannot modify the nodes in any way.
+The flow context menu provides the options to lock and unlock flows, + as well as in the Info sidebar explorer.
`, + "ja": `誤ってフローに変更が加えられてしまうのを防ぐために、フローを固定できるようになりました。
+固定されている時は、ノードを修正することはできません。
+フローのコンテキストメニューと、情報サイドバーのエクスプローラには、フローの固定や解除をするためのオプションが用意されています。
`, + "fr": `Les flux peuvent désormais être verrouillés pour éviter toute modification accidentelle.
+Lorsqu'il est verrouillé, vous ne pouvez en aucun cas modifier les noeuds.
+Le menu contextuel du flux fournit les options pour verrouiller et déverrouiller les flux, + ainsi que dans l'explorateur de la barre latérale d'informations.
` }, }, { title: { - "en-US": "Debug Path Tooltip", - "ja": "デバッグパスのツールチップ" + "en-US": "Adding Images to node/flow descriptions", + "ja": "ノードやフローの説明へ画像を追加", + "fr": "Ajout d'images aux descriptions de noeud/flux" }, - image: 'images/debug-path-tooltip.png', + // image: 'images/debug-path-tooltip.png', description: { - "en-US": `When hovering over a node name in the Debug sidebar, a - new tooltip shows the full location of the node.
-This is useful when working with subflows, making it - much easier to identify exactly which node generated - the message.
-Clicking on any item in the list will reveal it in - the workspace.
`, - "ja": `デバックサイドバー内のノード名の上にマウスカーソルを乗せると、新たにツールチップが表示され、ノードの場所が分かるようになっています。
-これは、サブフローを用いる時に役立つ機能であり、メッセージがどのノードから出力されたかを正確に特定することが遥かに簡単になります。
-本リスト内の要素をクリックすると、ワークスペース内にその要素が表示されます。
` + "en-US": `You can now add images to a node's or flows's description.
+Simply drag the image into the text editor and it will get added inline.
+When the description is shown in the Info sidebar, the image will be displayed.
`, + "ja": `ノードまたはフローの説明に、画像を追加できるようになりました。
+画像をテキストエディタにドラッグするだけで、行内に埋め込まれます。
+情報サイドバーの説明を開くと、その画像が表示されます。
`, + "fr": `Vous pouvez désormais ajouter des images à la description d'un noeud ou d'un flux.
+Faites simplement glisser l'image dans l'éditeur de texte et elle sera ajoutée en ligne.
+Lorsque la description s'affiche dans la barre latérale d'informations, l'image s'affiche.
` }, }, { title: { - "en-US": "Continuous Search", - "ja": "連続した検索" + "en-US": "Adding Mermaid Diagrams", + "ja": "Mermaid図を追加", + "fr": "Ajout de diagrammes Mermaid" }, - image: 'images/continuous-search.png', + image: 'images/mermaid.png', description: { - "en-US": `When searching for things in the editor, a new toolbar in - the workspace provides options to quickly jump between - the search results.
`, - "ja": `ワークスペース内の新しいツールバーにあるオプションによって、エディタ内を検索する際に、検索結果の間を素早く移動できます。
` + "en-US": `You can also add Mermaid diagrams directly into your node or flow descriptions.
+This gives you much richer options for documenting your flows.
`, + "ja": `ノードやフローの説明に、Mermaid図を直接追加することもできます。
+これによって、フローを説明する文書作成の選択肢がより多くなります。
`, + "fr": `Vous pouvez également ajouter des diagrammes Mermaid directement dans vos descriptions de noeud ou de flux.
+Cela vous offre des options beaucoup plus riches pour documenter vos flux.
` }, }, { title: { - "en-US": "New wiring actions", - "ja": "新しいワイヤー操作" + "en-US": "Managing Global Environment Variables", + "ja": "グローバル環境変数の管理", + "fr": "Gestion des variables d'environnement globales" }, - image: "images/split-wire-with-links.gif", + image: 'images/global-env-vars.png', description: { - "en-US": `A new action has been added that will replace a wire with a pair of connected Link nodes:
--
-
Split Wire With Link Nodes
-
Actions can be accessed from the Action List in the main menu.
`, - "ja": `ワイヤーを、接続されたLinkノードのペアに置き換える動作が新たに追加されました:
--
-
ワイヤーをlinkノードで分割
-
本アクションは、メインメニュー内の動作一覧から呼び出せます。
`, + "en-US": `You can set environment variables that apply to all nodes and flows in the new + 'Global Environment Variables' section of User Settings.
`, + "ja": `ユーザ設定に新しく追加された「大域環境変数」のセクションで、全てのノードとフローに適用される環境変数を登録できます。
`, + "fr": `Vous pouvez définir des variables d'environnement qui s'appliquent à tous les noeuds et flux dans la nouvelle + section "Global Environment Variables" des paramètres utilisateur.
` }, }, - { - title: { - "en-US": "Default node names", - "ja": "標準ノードの名前" - }, - // image: "images/", - description: { - "en-US": `Some nodes have been updated to generate a unique name when
- new instances are added to the workspace. This applies to
- Debug, Function and Link nodes.
A new action has also been added to generate default names for the selected - nodes:
--
-
Generate Node Names
-
Actions can be accessed from the Action List in the main menu.
- `, - "ja": `一部のノードは、ワークスペース上に新インスタンスとして追加した際に、一意の名前を付けるよう変更されました。この変更は、Debug、Function、Linkノードに適用されています。
選択したノードに対して、標準の名前を生成する動作も新たに追加されました:
--
-
ノード名を生成
-
本アクションは、メインメニュー内の動作一覧から呼び出せます。
- ` - } - }, { title: { "en-US": "Node Updates", - "ja": "ノードの更新" + "ja": "ノードの更新", + "fr": "Mises à jour des noeuds" }, // image: "images/", description: { - "en-US": `-
-
- The Debug node can be configured to count messages it receives -
- The Link Call node can use a message property to dynamically target the link it should call -
- The HTTP Request node can be preconfigured with HTTP headers -
-
-
- Debugノードは、受信したメッセージの数をカウントするよう設定できるようになりました。 -
- Link Callノードは、メッセージのプロパティによって、呼び出し対象のlinkを動的に指定できるようになりました。 -
- HTTP Requestノードは、HTTPヘッダを事前設定できるようになりました。 -
The core nodes have received lots of minor fixes, documentation updates and + small enhancements. Check the full changelog in the Help sidebar for a full list.
`, + "ja": `コアノードにマイナーな修正、ドキュメント更新、小規模な拡張が数多く追加されています。全ての一覧は、ヘルプサイドバーの全ての更新履歴を確認してください。
`, + "fr": `Les noeuds principaux ont reçu de nombreux correctifs mineurs, mises à jour de la documentation et + petites améliorations. Consulter le journal des modifications complet dans la barre latérale d'aide.
` } } ] diff --git a/packages/node_modules/@node-red/editor-client/src/types/node-red/func.d.ts b/packages/node_modules/@node-red/editor-client/src/types/node-red/func.d.ts index fd2adcbd8..8544439d9 100644 --- a/packages/node_modules/@node-red/editor-client/src/types/node-red/func.d.ts +++ b/packages/node_modules/@node-red/editor-client/src/types/node-red/func.d.ts @@ -1,6 +1,5 @@ -/* NOTE: Do not edit directly! This file is generated using `npm run update-types` in https://github.com/node-red/nr-monaco-build */ - +/* NOTE: Do not edit directly! This file is generated using `npm run update-types` in https://github.com/Steve-Mcl/monaco-editor-esm-i18n */ interface NodeMessage { topic?: string; @@ -281,5 +280,22 @@ declare class env { * @example * ```const flowName = env.get("NR_FLOW_NAME");``` */ - static get(name:string) :string; + static get(name:string) :any; + /** + * Get an environment variable value (asynchronous). + * + * Predefined node-red variables... + * * `NR_NODE_ID` - the ID of the node + * * `NR_NODE_NAME` - the Name of the node + * * `NR_NODE_PATH` - the Path of the node + * * `NR_GROUP_ID` - the ID of the containing group + * * `NR_GROUP_NAME` - the Name of the containing group + * * `NR_FLOW_ID` - the ID of the flow the node is on + * * `NR_FLOW_NAME` - the Name of the flow the node is on + * @param name Name of the environment variable to get + * @param callback Callback function (`(err,value) => {}`) + * @example + * ```const flowName = env.get("NR_FLOW_NAME");``` + */ + static get(name:string, callback: Function) :void; } diff --git a/packages/node_modules/@node-red/editor-client/src/types/node/assert.d.ts b/packages/node_modules/@node-red/editor-client/src/types/node/assert.d.ts index 6fcb3ce62..4cfbb7321 100644 --- a/packages/node_modules/@node-red/editor-client/src/types/node/assert.d.ts +++ b/packages/node_modules/@node-red/editor-client/src/types/node/assert.d.ts @@ -1,24 +1,36 @@ /* NOTE: Do not edit directly! This file is generated using `npm run update-types` in https://github.com/Steve-Mcl/monaco-editor-esm-i18n */ +/** + * The `assert` module provides a set of assertion functions for verifying + * invariants. + * @see [source](https://github.com/nodejs/node/blob/v16.9.0/lib/assert.js) + */ declare module 'assert' { - /** An alias of `assert.ok()`. */ - function assert(value: any, message?: string | Error): asserts value; + /** + * An alias of {@link ok}. + * @since v0.5.9 + * @param value The input that is checked for being truthy. + */ + function assert(value: unknown, message?: string | Error): asserts value; namespace assert { + /** + * Indicates the failure of an assertion. All errors thrown by the `assert` module + * will be instances of the `AssertionError` class. + */ class AssertionError extends Error { - actual: any; - expected: any; + actual: unknown; + expected: unknown; operator: string; generatedMessage: boolean; code: 'ERR_ASSERTION'; - constructor(options?: { /** If provided, the error message is set to this value. */ message?: string | undefined; /** The `actual` property on the error instance. */ - actual?: any; + actual?: unknown | undefined; /** The `expected` property on the error instance. */ - expected?: any; + expected?: unknown | undefined; /** The `operator` property on the error instance. */ operator?: string | undefined; /** If provided, the generated stack trace omits frames before this function. */ @@ -26,13 +38,146 @@ declare module 'assert' { stackStartFn?: Function | undefined; }); } - + /** + * This feature is currently experimental and behavior might still change. + * @since v14.2.0, v12.19.0 + * @experimental + */ class CallTracker { + /** + * The wrapper function is expected to be called exactly `exact` times. If the + * function has not been called exactly `exact` times when `tracker.verify()` is called, then `tracker.verify()` will throw an + * error. + * + * ```js + * import assert from 'assert'; + * + * // Creates call tracker. + * const tracker = new assert.CallTracker(); + * + * function func() {} + * + * // Returns a function that wraps func() that must be called exact times + * // before tracker.verify(). + * const callsfunc = tracker.calls(func); + * ``` + * @since v14.2.0, v12.19.0 + * @param [fn='A no-op function'] + * @param [exact=1] + * @return that wraps `fn`. + */ calls(exact?: number): () => void; calls