Variable serviceConst

service: {
    clean: (() => void);
    current: (() => {
        config: {
            ingress?: {
                hostname?: string;
                service: string;
            }[];
            [key: string]: unknown;
        };
        connections: Connection[];
        connectorID: string;
        metrics: string;
        tunnelID: string;
    });
    err: (() => string);
    exists: (() => boolean);
    install: ((token?: string) => void);
    journal: ((n?: number) => string);
    log: (() => string);
    uninstall: (() => void);
} = ...

Cloudflared Service API.

Type declaration

  • clean: (() => void)
      • (): void

      • Clean up service log files.

        Returns void

        Platform

        macOS

  • current: (() => {
        config: {
            ingress?: {
                hostname?: string;
                service: string;
            }[];
            [key: string]: unknown;
        };
        connections: Connection[];
        connectorID: string;
        metrics: string;
        tunnelID: string;
    })
      • (): {
            config: {
                ingress?: {
                    hostname?: string;
                    service: string;
                }[];
                [key: string]: unknown;
            };
            connections: Connection[];
            connectorID: string;
            metrics: string;
            tunnelID: string;
        }

      • Get informations of current running cloudflared service.

        Returns {
            config: {
                ingress?: {
                    hostname?: string;
                    service: string;
                }[];
                [key: string]: unknown;
            };
            connections: Connection[];
            connectorID: string;
            metrics: string;
            tunnelID: string;
        }

        informations of current running cloudflared service.

        • config: {
              ingress?: {
                  hostname?: string;
                  service: string;
              }[];
              [key: string]: unknown;
          }

          Tunnel Configuration

          • [key: string]: unknown
          • Optionalingress?: {
                hostname?: string;
                service: string;
            }[]
        • connections: Connection[]

          The connections of the tunnel

        • connectorID: string

          Connector ID

        • metrics: string

          Metrics Server Location

        • tunnelID: string

          Tunnel ID

        Platform

        macOS, linux

  • err: (() => string)
      • (): string

      • Get stderr log of cloudflared service. (cloudflared print all things here)

        Returns string

        stderr log of cloudflared service.

        Platform

        macOS, linux (sysv)

  • exists: (() => boolean)
      • (): boolean

      • Check if cloudflared service is installed.

        Returns boolean

        true if service is installed, false otherwise.

        Platform

        macOS, linux

  • install: ((token?: string) => void)
      • (token?): void

      • Install Cloudflared service.

        Parameters

        • Optionaltoken: string

          Tunnel service token.

        Returns void

        Platform

        macOS, linux

  • journal: ((n?: number) => string)
      • (n?): string

      • Get cloudflared service journal from journalctl.

        Parameters

        • n: number = 300

          The number of entries to return.

        Returns string

        cloudflared service journal.

        Platform

        linux (systemd)

  • log: (() => string)
      • (): string

      • Get stdout log of cloudflared service. (Usually empty)

        Returns string

        stdout log of cloudflared service.

        Platform

        macOS, linux (sysv)

  • uninstall: (() => void)
      • (): void

      • Uninstall Cloudflared service.

        Returns void

        Platform

        macOS, linux

Settings

Member Visibility
""