From e664febf3434716309b3e567fc776402985ee4ef Mon Sep 17 00:00:00 2001 From: JacobLinCool Date: Wed, 12 Feb 2025 11:36:19 +0000 Subject: [PATCH] deploy: f1dfb1b926ad129ff9fffab9b8d07f42a4f6633c --- classes/AlreadyInstalledError.html | 4 ++-- classes/ConfigHandler.html | 12 ++++++------ classes/ConnectionHandler.html | 4 ++-- classes/NotInstalledError.html | 4 ++-- classes/TryCloudflareHandler.html | 4 ++-- classes/Tunnel.html | 22 +++++++++++----------- functions/build_args.html | 2 +- functions/build_options.html | 2 +- functions/install.html | 2 +- functions/install_linux.html | 2 +- functions/install_macos.html | 2 +- functions/install_windows.html | 2 +- functions/tunnel-1.html | 2 +- functions/use.html | 2 +- interfaces/ConfigHandlerEvents.html | 4 ++-- interfaces/Connection.html | 4 ++-- interfaces/TunnelConfig.html | 4 ++-- interfaces/TunnelEvents.html | 4 ++-- types/OutputHandler.html | 2 +- types/TunnelOptions.html | 2 +- variables/CLOUDFLARED_VERSION.html | 2 +- variables/DEFAULT_CLOUDFLARED_BIN.html | 2 +- variables/MACOS_SERVICE_PATH.html | 2 +- variables/RELEASE_BASE.html | 2 +- variables/bin.html | 2 +- variables/identifier.html | 2 +- variables/service.html | 2 +- 27 files changed, 50 insertions(+), 50 deletions(-) diff --git a/classes/AlreadyInstalledError.html b/classes/AlreadyInstalledError.html index 94ba1fc..ddf3a90 100644 --- a/classes/AlreadyInstalledError.html +++ b/classes/AlreadyInstalledError.html @@ -1,12 +1,12 @@ AlreadyInstalledError | cloudflared

Class AlreadyInstalledError

Throw when service is already installed.

-

Hierarchy

  • Error
    • AlreadyInstalledError

Constructors

constructor +

Hierarchy

  • Error
    • AlreadyInstalledError

Constructors

constructor

Properties

message name stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

message

message: string

name

name: string

Optionalstack

stack?: string

Static OptionalprepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

message

message: string

name

name: string

Optionalstack

stack?: string

Static OptionalprepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

StaticstackTraceLimit

stackTraceLimit: number

Methods

StaticcaptureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/classes/ConfigHandler.html b/classes/ConfigHandler.html index b335210..cad43e7 100644 --- a/classes/ConfigHandler.html +++ b/classes/ConfigHandler.html @@ -1,4 +1,4 @@ -ConfigHandler | cloudflared

Class ConfigHandler<T>

Type Parameters

Hierarchy

  • EventEmitter
    • ConfigHandler

Constructors

constructor +ConfigHandler | cloudflared

Class ConfigHandler<T>

Type Parameters

Hierarchy

  • EventEmitter
    • ConfigHandler

Constructors

constructor

Properties

captureRejectionSymbol captureRejections defaultMaxListeners @@ -26,7 +26,7 @@ on once setMaxListeners -

Constructors

constructor

Properties

Static ReadonlycaptureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Value: Symbol.for('nodejs.rejection')

+

Constructors

constructor

Properties

Static ReadonlycaptureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Value: Symbol.for('nodejs.rejection')

See how to write a custom rejection handler.

Since

v13.4.0, v12.16.0

StaticcaptureRejections

captureRejections: boolean

Value: boolean

@@ -70,7 +70,7 @@

Type Parameters

Parameters

Returns boolean

Since

v0.1.26

-

eventNames

  • eventNames(): (string | symbol)[]

  • Returns an array listing the events for which the emitter has registered +

eventNames

  • eventNames(): (string | symbol)[]

  • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

    import { EventEmitter } from 'node:events';

    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]
    @@ -92,7 +92,7 @@

    Type Parameters

    • K

    Parameters

    • eventName: string | symbol

    Returns Function[]

    Since

    v0.1.26

off

on

  • on<E>(event, listener): this

  • Adds the listener function to the end of the listeners array for the event +

on

  • on<E>(event, listener): this

  • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

    @@ -107,7 +107,7 @@

    Type Parameters

    Parameters

    Returns this

    Since

    v0.1.101

    -

once

  • once<E>(event, listener): this

  • Adds a one-time listener function for the event named eventName. The +

once

  • once<E>(event, listener): this

  • Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

    server.once('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
    @@ -120,7 +120,7 @@

    Type Parameters

    Parameters

    Returns this

    Since

    v0.3.0

    -

prependListener

  • prependListener<K>(eventName, listener): this

  • Adds the listener function to the beginning of the listeners array for the +

prependListener

  • prependListener<K>(eventName, listener): this

  • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

    diff --git a/classes/ConnectionHandler.html b/classes/ConnectionHandler.html index c0b8783..a637842 100644 --- a/classes/ConnectionHandler.html +++ b/classes/ConnectionHandler.html @@ -1,2 +1,2 @@ -ConnectionHandler | cloudflared

    Class ConnectionHandler

    Constructors

    constructor -

    Constructors

    constructor

    Settings

    Member Visibility

    On This Page

    Constructors
    +ConnectionHandler | cloudflared

    Class ConnectionHandler

    Constructors

    constructor +

    Constructors

    constructor

    Settings

    Member Visibility

    On This Page

    Constructors
    diff --git a/classes/NotInstalledError.html b/classes/NotInstalledError.html index 7d7b729..245a76d 100644 --- a/classes/NotInstalledError.html +++ b/classes/NotInstalledError.html @@ -1,12 +1,12 @@ NotInstalledError | cloudflared

    Class NotInstalledError

    Throw when service is not installed.

    -

    Hierarchy

    • Error
      • NotInstalledError

    Constructors

    constructor +

    Hierarchy

    • Error
      • NotInstalledError

    Constructors

    constructor

    Properties

    message name stack? prepareStackTrace? stackTraceLimit

    Methods

    captureStackTrace -

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    +

    Constructors

    constructor

    Properties

    message

    message: string

    name

    name: string

    Optionalstack

    stack?: string

    Static OptionalprepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    StaticstackTraceLimit

    stackTraceLimit: number

    Methods

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/TryCloudflareHandler.html b/classes/TryCloudflareHandler.html index ce2215a..b73bef5 100644 --- a/classes/TryCloudflareHandler.html +++ b/classes/TryCloudflareHandler.html @@ -1,2 +1,2 @@ -TryCloudflareHandler | cloudflared

    Class TryCloudflareHandler

    Constructors

    constructor -

    Constructors

    constructor

    Settings

    Member Visibility

    On This Page

    Constructors
    +TryCloudflareHandler | cloudflared

    Class TryCloudflareHandler

    Constructors

    constructor +

    Constructors

    constructor

    Settings

    Member Visibility

    On This Page

    Constructors
    diff --git a/classes/Tunnel.html b/classes/Tunnel.html index ba09ff5..9fff5e1 100644 --- a/classes/Tunnel.html +++ b/classes/Tunnel.html @@ -1,4 +1,4 @@ -Tunnel | cloudflared

    Class Tunnel

    Hierarchy

    • EventEmitter
      • Tunnel

    Constructors

    constructor +Tunnel | cloudflared

    Class Tunnel

    Hierarchy

    • EventEmitter
      • Tunnel

    Constructors

    constructor

    Properties

    stop captureRejectionSymbol captureRejections @@ -32,7 +32,7 @@ quick setMaxListeners withToken -

    Constructors

    constructor

    Properties

    stop

    stop: (() => boolean) = ...

    Static ReadonlycaptureRejectionSymbol

    captureRejectionSymbol: typeof captureRejectionSymbol

    Value: Symbol.for('nodejs.rejection')

    +

    Constructors

    constructor

    Properties

    stop

    stop: (() => boolean) = ...

    Static ReadonlycaptureRejectionSymbol

    captureRejectionSymbol: typeof captureRejectionSymbol

    Value: Symbol.for('nodejs.rejection')

    See how to write a custom rejection handler.

    Since

    v13.4.0, v12.16.0

    StaticcaptureRejections

    captureRejections: boolean

    Value: boolean

    @@ -67,9 +67,9 @@

    Installing a listener using this symbol does not change the behavior once an 'error' event is emitted. Therefore, the process will still crash if no regular 'error' listener is installed.

    Since

    v13.6.0, v12.17.0

    -

    Accessors

    process

    Methods

    Optional[captureRejectionSymbol]

    • [captureRejectionSymbol]<K>(error, event, ...args): void

    • Type Parameters

      • K

      Parameters

      • error: Error
      • event: string | symbol
      • Rest...args: AnyRest

      Returns void

    addHandler

    • addHandler(handler): void

    • Add a custom output handler

      +

    Accessors

    process

    Methods

    Optional[captureRejectionSymbol]

    • [captureRejectionSymbol]<K>(error, event, ...args): void

    • Type Parameters

      • K

      Parameters

      • error: Error
      • event: string | symbol
      • Rest...args: AnyRest

      Returns void

    addHandler

    • addHandler(handler): void

    • Add a custom output handler

      Parameters

      Returns void

    addListener

    • addListener<K>(eventName, listener): this

    • Alias for emitter.on(eventName, listener).

      +

    Returns void

addListener

  • addListener<K>(eventName, listener): this

  • Alias for emitter.on(eventName, listener).

    Type Parameters

    • K

    Parameters

    • eventName: string | symbol
    • listener: ((...args: any[]) => void)
        • (...args): void

        • Parameters

          • Rest...args: any[]

          Returns void

    Returns this

    Since

    v0.1.26

emit

  • emit<E>(event, ...args): boolean

  • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

    @@ -78,7 +78,7 @@

    Type Parameters

    Parameters

    Returns boolean

    Since

    v0.1.26

    -

eventNames

  • eventNames(): (string | symbol)[]

  • Returns an array listing the events for which the emitter has registered +

eventNames

  • eventNames(): (string | symbol)[]

  • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

    import { EventEmitter } from 'node:events';

    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]
    @@ -100,7 +100,7 @@

    Type Parameters

    • K

    Parameters

    • eventName: string | symbol

    Returns Function[]

    Since

    v0.1.26

off

  • off<E>(event, listener): this

  • Alias for emitter.removeListener().

    Type Parameters

    Parameters

    Returns this

    Since

    v10.0.0

    -

on

  • on<E>(event, listener): this

  • Adds the listener function to the end of the listeners array for the event +

on

  • on<E>(event, listener): this

  • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

    @@ -115,7 +115,7 @@

    Type Parameters

    Parameters

    Returns this

    Since

    v0.1.101

    -

once

  • once<E>(event, listener): this

  • Adds a one-time listener function for the event named eventName. The +

once

  • once<E>(event, listener): this

  • Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

    server.once('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
    @@ -128,7 +128,7 @@

    Type Parameters

    Parameters

    Returns this

    Since

    v0.3.0

    -

prependListener

  • prependListener<K>(eventName, listener): this

  • Adds the listener function to the beginning of the listeners array for the +

prependListener

  • prependListener<K>(eventName, listener): this

  • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

    @@ -162,7 +162,7 @@

    Parameters

    • OptionaleventName: string | symbol

    Returns this

    Since

    v0.1.26

removeHandler

  • removeHandler(handler): void

  • Remove a previously added output handler

    Parameters

    Returns void

removeListener

  • removeListener<K>(eventName, listener): this

  • Removes the specified listener from the listener array for the event named eventName.

    +

Returns void

removeListener

  • removeListener<K>(eventName, listener): this

  • Removes the specified listener from the listener array for the event named eventName.

    const callback = (stream) => {
      console.log('someone connected!');
    };
    server.on('connection', callback);
    // ...
    server.removeListener('connection', callback);
    @@ -277,7 +277,7 @@

    Deprecated

  • once(emitter, eventName, options?): Promise<any[]>

  • Parameters

    • emitter: EventTarget
    • eventName: string
    • Optionaloptions: StaticEventEmitterOptions

    Returns Promise<any[]>

Staticquick

  • quick(url?, options?): Tunnel

  • Create a quick tunnel without a Cloudflare account.

    Parameters

    • Optionalurl: string

      The local service URL to connect to. If not provided, the hello world mode will be used.

    • options: TunnelOptions = {}

      The options to pass to cloudflared.

      -

    Returns Tunnel

StaticsetMaxListeners

  • setMaxListeners(n?, ...eventTargets): void
  • import { setMaxListeners, EventEmitter } from 'node:events';

    const target = new EventTarget();
    const emitter = new EventEmitter();

    setMaxListeners(5, target, emitter);
+

Returns Tunnel

StaticsetMaxListeners

  • setMaxListeners(n?, ...eventTargets): void
  • import { setMaxListeners, EventEmitter } from 'node:events';

    const target = new EventTarget();
    const emitter = new EventEmitter();

    setMaxListeners(5, target, emitter);

    Parameters

    • Optionaln: number

      A non-negative number. The maximum number of listeners per EventTarget event.

      @@ -285,4 +285,4 @@

      Deprecated

StaticwithToken

  • withToken(token, options?): Tunnel

  • Create a tunnel with a Cloudflare account.

    Parameters

    • token: string

      The Cloudflare Tunnel token.

    • options: TunnelOptions = {}

      The options to pass to cloudflared.

      -

    Returns Tunnel

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Returns Tunnel

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/functions/build_args.html b/functions/build_args.html index e00696f..63591ea 100644 --- a/functions/build_args.html +++ b/functions/build_args.html @@ -1,4 +1,4 @@ build_args | cloudflared

Function build_args

  • build_args(options): string[]

  • Build the arguments for the cloudflared command.

    Parameters

    Returns string[]

    The arguments for the cloudflared command.

    -

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/build_options.html b/functions/build_options.html index 955e8e6..ba4527e 100644 --- a/functions/build_options.html +++ b/functions/build_options.html @@ -1 +1 @@ -build_options | cloudflared

Function build_options

Settings

Member Visibility
+build_options | cloudflared

Function build_options

Settings

Member Visibility
diff --git a/functions/install.html b/functions/install.html index 9130879..feaaeeb 100644 --- a/functions/install.html +++ b/functions/install.html @@ -2,4 +2,4 @@

Parameters

  • to: string

    The path to the binary to install.

  • version: string = CLOUDFLARED_VERSION

    The version of cloudflared to install.

Returns Promise<string>

The path to the binary that was installed.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/install_linux.html b/functions/install_linux.html index e29d46e..a736e1f 100644 --- a/functions/install_linux.html +++ b/functions/install_linux.html @@ -1 +1 @@ -install_linux | cloudflared

Function install_linux

  • install_linux(to, version?): Promise<string>

  • Parameters

    • to: string
    • version: string = CLOUDFLARED_VERSION

    Returns Promise<string>

Settings

Member Visibility
+install_linux | cloudflared

Function install_linux

  • install_linux(to, version?): Promise<string>

  • Parameters

    • to: string
    • version: string = CLOUDFLARED_VERSION

    Returns Promise<string>

Settings

Member Visibility
diff --git a/functions/install_macos.html b/functions/install_macos.html index 8b37feb..5cf230f 100644 --- a/functions/install_macos.html +++ b/functions/install_macos.html @@ -1 +1 @@ -install_macos | cloudflared

Function install_macos

  • install_macos(to, version?): Promise<string>

  • Parameters

    • to: string
    • version: string = CLOUDFLARED_VERSION

    Returns Promise<string>

Settings

Member Visibility
+install_macos | cloudflared

Function install_macos

  • install_macos(to, version?): Promise<string>

  • Parameters

    • to: string
    • version: string = CLOUDFLARED_VERSION

    Returns Promise<string>

Settings

Member Visibility
diff --git a/functions/install_windows.html b/functions/install_windows.html index c477f18..19acf24 100644 --- a/functions/install_windows.html +++ b/functions/install_windows.html @@ -1 +1 @@ -install_windows | cloudflared

Function install_windows

  • install_windows(to, version?): Promise<string>

  • Parameters

    • to: string
    • version: string = CLOUDFLARED_VERSION

    Returns Promise<string>

Settings

Member Visibility
+install_windows | cloudflared

Function install_windows

  • install_windows(to, version?): Promise<string>

  • Parameters

    • to: string
    • version: string = CLOUDFLARED_VERSION

    Returns Promise<string>

Settings

Member Visibility
diff --git a/functions/tunnel-1.html b/functions/tunnel-1.html index 4f1ff3d..45c3c28 100644 --- a/functions/tunnel-1.html +++ b/functions/tunnel-1.html @@ -1,4 +1,4 @@ tunnel | cloudflared

Function tunnel

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/use.html b/functions/use.html index f27b5fa..b90d925 100644 --- a/functions/use.html +++ b/functions/use.html @@ -1,3 +1,3 @@ use | cloudflared

Function use

  • use(executable): void

  • Override the path to the cloudflared binary.

    Parameters

    • executable: string

      The path to the cloudflared executable.

      -

    Returns void

Settings

Member Visibility
+

Returns void

Settings

Member Visibility
diff --git a/interfaces/ConfigHandlerEvents.html b/interfaces/ConfigHandlerEvents.html index 35d4057..edc724f 100644 --- a/interfaces/ConfigHandlerEvents.html +++ b/interfaces/ConfigHandlerEvents.html @@ -1,3 +1,3 @@ -ConfigHandlerEvents | cloudflared

Interface ConfigHandlerEvents<T>

interface ConfigHandlerEvents<T> {
    config: ((config: {
        config: T;
        version: number;
    }) => void);
    error: ((error: Error) => void);
}

Type Parameters

  • T

Properties

config +ConfigHandlerEvents | cloudflared

Interface ConfigHandlerEvents<T>

interface ConfigHandlerEvents<T> {
    config: ((config: {
        config: T;
        version: number;
    }) => void);
    error: ((error: Error) => void);
}

Type Parameters

  • T

Properties

config error -

Properties

config

config: ((config: {
    config: T;
    version: number;
}) => void)

error

error: ((error: Error) => void)

Settings

Member Visibility

On This Page

Properties
+

Properties

config

config: ((config: {
    config: T;
    version: number;
}) => void)

error

error: ((error: Error) => void)

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/Connection.html b/interfaces/Connection.html index 68ea3ef..17060ac 100644 --- a/interfaces/Connection.html +++ b/interfaces/Connection.html @@ -1,4 +1,4 @@ -Connection | cloudflared

Interface Connection

interface Connection {
    id: string;
    ip: string;
    location: string;
}

Properties

id +Connection | cloudflared

Interface Connection

interface Connection {
    id: string;
    ip: string;
    location: string;
}

Properties

id ip location -

Properties

id

id: string

ip

ip: string

location

location: string

Settings

Member Visibility

On This Page

Properties
+

Properties

id

id: string

ip

ip: string

location

location: string

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/TunnelConfig.html b/interfaces/TunnelConfig.html index 5459d93..336d723 100644 --- a/interfaces/TunnelConfig.html +++ b/interfaces/TunnelConfig.html @@ -1,3 +1,3 @@ -TunnelConfig | cloudflared

Interface TunnelConfig

interface TunnelConfig {
    ingress: Record<string, string>[];
    warp_routing: {
        enabled: boolean;
    };
}

Properties

ingress +TunnelConfig | cloudflared

Interface TunnelConfig

interface TunnelConfig {
    ingress: Record<string, string>[];
    warp_routing: {
        enabled: boolean;
    };
}

Properties

ingress warp_routing -

Properties

ingress

ingress: Record<string, string>[]

warp_routing

warp_routing: {
    enabled: boolean;
}

Settings

Member Visibility

On This Page

Properties
+

Properties

ingress

ingress: Record<string, string>[]

warp_routing

warp_routing: {
    enabled: boolean;
}

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/TunnelEvents.html b/interfaces/TunnelEvents.html index 0dc81ec..fd24f83 100644 --- a/interfaces/TunnelEvents.html +++ b/interfaces/TunnelEvents.html @@ -1,8 +1,8 @@ -TunnelEvents | cloudflared

Interface TunnelEvents

interface TunnelEvents {
    connected: ((connection: Connection) => void);
    disconnected: ((connection: Connection) => void);
    error: ((error: Error) => void);
    exit: ((code: null | number, signal: null | Signals) => void);
    stderr: ((data: string) => void);
    stdout: ((data: string) => void);
    url: ((url: string) => void);
}

Properties

connected +TunnelEvents | cloudflared

Interface TunnelEvents

interface TunnelEvents {
    connected: ((connection: Connection) => void);
    disconnected: ((connection: Connection) => void);
    error: ((error: Error) => void);
    exit: ((code: null | number, signal: null | Signals) => void);
    stderr: ((data: string) => void);
    stdout: ((data: string) => void);
    url: ((url: string) => void);
}

Properties

connected disconnected error exit stderr stdout url -

Properties

connected

connected: ((connection: Connection) => void)

disconnected

disconnected: ((connection: Connection) => void)

error

error: ((error: Error) => void)

exit

exit: ((code: null | number, signal: null | Signals) => void)

stderr

stderr: ((data: string) => void)

stdout

stdout: ((data: string) => void)

url

url: ((url: string) => void)

Settings

Member Visibility

On This Page

Properties
+

Properties

connected

connected: ((connection: Connection) => void)

disconnected

disconnected: ((connection: Connection) => void)

error

error: ((error: Error) => void)

exit

exit: ((code: null | number, signal: null | Signals) => void)

stderr

stderr: ((data: string) => void)

stdout

stdout: ((data: string) => void)

url

url: ((url: string) => void)

Settings

Member Visibility

On This Page

Properties
diff --git a/types/OutputHandler.html b/types/OutputHandler.html index f12c776..24dfbf8 100644 --- a/types/OutputHandler.html +++ b/types/OutputHandler.html @@ -1 +1 @@ -OutputHandler | cloudflared

Type Alias OutputHandler

OutputHandler: ((output: string, tunnel: Tunnel) => void)

Settings

Member Visibility
+OutputHandler | cloudflared

Type Alias OutputHandler

OutputHandler: ((output: string, tunnel: Tunnel) => void)

Settings

Member Visibility
diff --git a/types/TunnelOptions.html b/types/TunnelOptions.html index 90d9347..772f786 100644 --- a/types/TunnelOptions.html +++ b/types/TunnelOptions.html @@ -1 +1 @@ -TunnelOptions | cloudflared

Type Alias TunnelOptions

TunnelOptions: Record<string, string | number | boolean>

Settings

Member Visibility
+TunnelOptions | cloudflared

Type Alias TunnelOptions

TunnelOptions: Record<string, string | number | boolean>

Settings

Member Visibility
diff --git a/variables/CLOUDFLARED_VERSION.html b/variables/CLOUDFLARED_VERSION.html index e0955d7..7b956ac 100644 --- a/variables/CLOUDFLARED_VERSION.html +++ b/variables/CLOUDFLARED_VERSION.html @@ -1 +1 @@ -CLOUDFLARED_VERSION | cloudflared

Variable CLOUDFLARED_VERSIONConst

CLOUDFLARED_VERSION: string = ...

Settings

Member Visibility
+CLOUDFLARED_VERSION | cloudflared

Variable CLOUDFLARED_VERSIONConst

CLOUDFLARED_VERSION: string = ...

Settings

Member Visibility
diff --git a/variables/DEFAULT_CLOUDFLARED_BIN.html b/variables/DEFAULT_CLOUDFLARED_BIN.html index 6b116bf..8cec251 100644 --- a/variables/DEFAULT_CLOUDFLARED_BIN.html +++ b/variables/DEFAULT_CLOUDFLARED_BIN.html @@ -1 +1 @@ -DEFAULT_CLOUDFLARED_BIN | cloudflared

Variable DEFAULT_CLOUDFLARED_BINConst

DEFAULT_CLOUDFLARED_BIN: string = ...

Settings

Member Visibility
+DEFAULT_CLOUDFLARED_BIN | cloudflared

Variable DEFAULT_CLOUDFLARED_BINConst

DEFAULT_CLOUDFLARED_BIN: string = ...

Settings

Member Visibility
diff --git a/variables/MACOS_SERVICE_PATH.html b/variables/MACOS_SERVICE_PATH.html index 874ff90..d1eb277 100644 --- a/variables/MACOS_SERVICE_PATH.html +++ b/variables/MACOS_SERVICE_PATH.html @@ -1,3 +1,3 @@ MACOS_SERVICE_PATH | cloudflared

Variable MACOS_SERVICE_PATHConst

MACOS_SERVICE_PATH: {
    ERR: string;
    OUT: string;
    PLIST: string;
} = ...

Path of service related files.

Platform

macOS

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/variables/RELEASE_BASE.html b/variables/RELEASE_BASE.html index 8c85bda..db1738d 100644 --- a/variables/RELEASE_BASE.html +++ b/variables/RELEASE_BASE.html @@ -1 +1 @@ -RELEASE_BASE | cloudflared

Variable RELEASE_BASEConst

RELEASE_BASE: "https://github.com/cloudflare/cloudflared/releases/" = "https://github.com/cloudflare/cloudflared/releases/"

Settings

Member Visibility
+RELEASE_BASE | cloudflared

Variable RELEASE_BASEConst

RELEASE_BASE: "https://github.com/cloudflare/cloudflared/releases/" = "https://github.com/cloudflare/cloudflared/releases/"

Settings

Member Visibility
diff --git a/variables/bin.html b/variables/bin.html index 3cd2ba3..76d92e2 100644 --- a/variables/bin.html +++ b/variables/bin.html @@ -1,4 +1,4 @@ bin | cloudflared

Variable bin

bin: string = ...

The path to the cloudflared binary. If the CLOUDFLARED_BIN environment variable is set, it will be used; otherwise, DEFAULT_CLOUDFLARED_BIN will be used. Can be overridden with use.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/variables/identifier.html b/variables/identifier.html index ff58078..3914145 100644 --- a/variables/identifier.html +++ b/variables/identifier.html @@ -1,3 +1,3 @@ identifier | cloudflared

Variable identifierConst

identifier: "com.cloudflare.cloudflared" = "com.cloudflare.cloudflared"

Cloudflared launchd identifier.

Platform

macOS

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/variables/service.html b/variables/service.html index 6c86fbe..818a245 100644 --- a/variables/service.html +++ b/variables/service.html @@ -27,4 +27,4 @@

Platform

macOS, linux (sysv)

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

      • Uninstall Cloudflared service.

        Returns void

        Platform

        macOS, linux

        -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility