Workstation API - v0.6.2
    Preparing search index...

    Variable filesConst

    files: {
        dotenv: (
            target: string,
            values: Readonly<Record<string, string>>,
            options?: GeneratedFileOptions,
        ) => GeneratedFileResource;
        inject: (
            target: string,
            content: string,
            markers: { end: string; start: string },
            options?: { mode?: number },
        ) => GeneratedFileResource;
        json: (
            target: string,
            value: ConfigValue,
            options?: GeneratedFileOptions,
        ) => GeneratedFileResource;
        jsonc: (
            target: string,
            value: ConfigValue | JsoncDocument,
            options?: GeneratedFileOptions,
        ) => GeneratedFileResource;
        mise: (
            target: string,
            versions: Readonly<Record<string, string>>,
            settings?: Readonly<Record<string, ConfigValue>>,
        ) => GeneratedFileResource;
        toml: (
            target: string,
            value: ConfigValue,
            options?: GeneratedFileOptions,
        ) => GeneratedFileResource;
        yaml: (
            target: string,
            value: ConfigValue,
            options?: GeneratedFileOptions,
        ) => GeneratedFileResource;
    } = ...

    Generate structured files from ordinary TypeScript values. Targets resolve relative to home.

    Type Declaration

    • dotenv: (
          target: string,
          values: Readonly<Record<string, string>>,
          options?: GeneratedFileOptions,
      ) => GeneratedFileResource

      Merge literal single-line environment values, preserving unrelated keys. Defaults to private permissions.

    • inject: (
          target: string,
          content: string,
          markers: { end: string; start: string },
          options?: { mode?: number },
      ) => GeneratedFileResource

      Replace text between two unique markers in an existing file, preserving the markers and surrounding content.

    • json: (
          target: string,
          value: ConfigValue,
          options?: GeneratedFileOptions,
      ) => GeneratedFileResource

      Generate formatted JSON.

      files.json("~/.config/app/config.json", { enabled: true })
      
    • jsonc: (
          target: string,
          value: ConfigValue | JsoncDocument,
          options?: GeneratedFileOptions,
      ) => GeneratedFileResource

      Generate JSONC from plain data or jsonc.concat/object commands with comments.

    • mise: (
          target: string,
          versions: Readonly<Record<string, string>>,
          settings?: Readonly<Record<string, ConfigValue>>,
      ) => GeneratedFileResource

      Generate mise activation from the same exact pins used for installation.

    • toml: (
          target: string,
          value: ConfigValue,
          options?: GeneratedFileOptions,
      ) => GeneratedFileResource

      Generate TOML. Values must be representable in TOML (for example, no null).

      files.toml("~/.config/app/config.toml", { server: { port: 3000 } })
      
    • yaml: (
          target: string,
          value: ConfigValue,
          options?: GeneratedFileOptions,
      ) => GeneratedFileResource

      Generate YAML with the standard overwrite/restore policy.