Aller au contenu
English

HostConfiguration

import type { HostConfiguration } from "@elie-laloum/outpost";
  • sourceRequis
    HostCredentialPath
    Fichier de l’hôte à lire, avec une variable d’environnement facultative qui déplace son dossier.
  • pathRequis
    string
    Destination relative au home de l’agent, sans segment . ou ..
  • sectionOptionnel
    string | undefined
    Clé de premier niveau qui reçoit les entrées sélectionnées dans la destination ; sans elle, elles sont fusionnées à la racine.
  • optionalOptionnel
    boolean | undefined
    Ignorer le fichier s’il n’existe pas sur l’hôte au lieu d’échouer.
  • loginRequis
    string
    Commande de l’hôte citée dans l’erreur lorsqu’un fichier requis manque.
  • selectRequis
    (content: string) => Readonly<Record<string, unknown>>
    Renvoie les entrées à fusionner à partir du contenu du fichier ; lève une erreur si la connexion attendue est absente.
export interface HostConfiguration {
  readonly source: HostCredentialPath;
  readonly path: string;
  readonly section?: string;
  readonly optional?: boolean;
  readonly login: string;
  select(content: string): Readonly<Record<string, unknown>>;
}