diff --git a/classes/AlreadyInstalledError.html b/classes/AlreadyInstalledError.html index 04c508f..94ba1fc 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

Hierarchy

  • Error
    • AlreadyInstalledError

Constructors

Properties

message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/classes/ConfigHandler.html b/classes/ConfigHandler.html index 3ea1aad..b335210 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

Properties

captureRejectionSymbol: typeof captureRejectionSymbol

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

+

Constructors

Properties

captureRejectionSymbol: typeof captureRejectionSymbol

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

See how to write a custom rejection handler.

v13.4.0, v12.16.0

captureRejections: boolean

Value: boolean

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

Type Parameters

Parameters

Returns boolean

v0.1.26

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

  • 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[]

    v0.1.26

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

  • 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

    v0.1.101

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

  • 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

    v0.3.0

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

  • 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 7f50b07..c0b8783 100644 --- a/classes/ConnectionHandler.html +++ b/classes/ConnectionHandler.html @@ -1,2 +1,2 @@ -ConnectionHandler | cloudflared

    Class ConnectionHandler

    Constructors

    Constructors

    +ConnectionHandler | cloudflared

    Class ConnectionHandler

    Constructors

    Constructors

    diff --git a/classes/NotInstalledError.html b/classes/NotInstalledError.html index a9ddcc2..7d7b729 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

    Hierarchy

    • Error
      • NotInstalledError

    Constructors

    Properties

    message: string
    name: string
    stack?: string
    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    +

    Constructors

    Properties

    message: string
    name: string
    stack?: string
    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

    Optional override for formatting stack traces

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

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

    Class TryCloudflareHandler

    Constructors

    Constructors

    +TryCloudflareHandler | cloudflared

    Class TryCloudflareHandler

    Constructors

    Constructors

    diff --git a/classes/Tunnel.html b/classes/Tunnel.html index b1bcb74..ba09ff5 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

    Properties

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

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

    +

    Constructors

    Properties

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

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

    See how to write a custom rejection handler.

    v13.4.0, v12.16.0

    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.

    v13.6.0, v12.17.0

    -

    Accessors

    Methods

    • Type Parameters

      • K

      Parameters

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

      Returns void

    • Add a custom output handler

      +

    Accessors

    Methods

    • Type Parameters

      • K

      Parameters

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

      Returns void

    • Add a custom output handler

      Parameters

      Returns void

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

      +

    Returns void

  • 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

    v0.1.26

  • 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

    v0.1.26

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

  • 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[]

    v0.1.26

  • Alias for emitter.removeListener().

    Type Parameters

    Parameters

    Returns this

    v10.0.0

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

  • 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

    v0.1.101

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

  • 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

    v0.3.0

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

  • 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

    v0.1.26

  • Remove a previously added output handler

    Parameters

    Returns void

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

    +

Returns void

Returns Tunnel

+

Returns Tunnel

diff --git a/functions/build_args.html b/functions/build_args.html index c37a345..e00696f 100644 --- a/functions/build_args.html +++ b/functions/build_args.html @@ -1,4 +1,4 @@ build_args | cloudflared

Function build_args

  • Build the arguments for the cloudflared command.

    Parameters

    Returns string[]

    The arguments for the cloudflared command.

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

Function build_options

+build_options | cloudflared

Function build_options

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

Parameters

Returns Promise<string>

The path to the binary that was installed.

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

Function install_linux

  • Parameters

    • to: string
    • version: string = CLOUDFLARED_VERSION

    Returns Promise<string>

+install_linux | cloudflared

Function install_linux

  • Parameters

    • to: string
    • version: string = CLOUDFLARED_VERSION

    Returns Promise<string>

diff --git a/functions/install_macos.html b/functions/install_macos.html index 0a0cf11..8b37feb 100644 --- a/functions/install_macos.html +++ b/functions/install_macos.html @@ -1 +1 @@ -install_macos | cloudflared

Function install_macos

  • Parameters

    • to: string
    • version: string = CLOUDFLARED_VERSION

    Returns Promise<string>

+install_macos | cloudflared

Function install_macos

  • Parameters

    • to: string
    • version: string = CLOUDFLARED_VERSION

    Returns Promise<string>

diff --git a/functions/install_windows.html b/functions/install_windows.html index f3abab6..c477f18 100644 --- a/functions/install_windows.html +++ b/functions/install_windows.html @@ -1 +1 @@ -install_windows | cloudflared

Function install_windows

  • Parameters

    • to: string
    • version: string = CLOUDFLARED_VERSION

    Returns Promise<string>

+install_windows | cloudflared

Function install_windows

  • Parameters

    • to: string
    • version: string = CLOUDFLARED_VERSION

    Returns Promise<string>

diff --git a/functions/tunnel-1.html b/functions/tunnel-1.html index 6c09bd0..4f1ff3d 100644 --- a/functions/tunnel-1.html +++ b/functions/tunnel-1.html @@ -1,4 +1,4 @@ tunnel | cloudflared

Function tunnel

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

Function use

  • Override the path to the cloudflared binary.

    Parameters

    • executable: string

      The path to the cloudflared executable.

      -

    Returns void

+

Returns void

diff --git a/interfaces/ConfigHandlerEvents.html b/interfaces/ConfigHandlerEvents.html index 124b81e..35d4057 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

Properties

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

Properties

config: ((config: {
    config: T;
    version: number;
}) => void)
error: ((error: Error) => void)
diff --git a/interfaces/Connection.html b/interfaces/Connection.html index b82dab9..68ea3ef 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

Properties

id: string
ip: string
location: string
+

Properties

id: string
ip: string
location: string
diff --git a/interfaces/TunnelConfig.html b/interfaces/TunnelConfig.html index 33ec3f1..5459d93 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

Properties

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

Properties

ingress: Record<string, string>[]
warp_routing: {
    enabled: boolean;
}
diff --git a/interfaces/TunnelEvents.html b/interfaces/TunnelEvents.html index 94771b6..0dc81ec 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: ((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: ((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)
diff --git a/types/OutputHandler.html b/types/OutputHandler.html index 394e831..f12c776 100644 --- a/types/OutputHandler.html +++ b/types/OutputHandler.html @@ -1 +1 @@ -OutputHandler | cloudflared

Type Alias OutputHandler

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

Type Alias OutputHandler

OutputHandler: ((output: string, tunnel: Tunnel) => void)
diff --git a/types/TunnelOptions.html b/types/TunnelOptions.html index eeca505..90d9347 100644 --- a/types/TunnelOptions.html +++ b/types/TunnelOptions.html @@ -1 +1 @@ -TunnelOptions | cloudflared

Type Alias TunnelOptions

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

Type Alias TunnelOptions

TunnelOptions: Record<string, string | number | boolean>
diff --git a/variables/CLOUDFLARED_VERSION.html b/variables/CLOUDFLARED_VERSION.html index bcbf208..e0955d7 100644 --- a/variables/CLOUDFLARED_VERSION.html +++ b/variables/CLOUDFLARED_VERSION.html @@ -1 +1 @@ -CLOUDFLARED_VERSION | cloudflared

Variable CLOUDFLARED_VERSIONConst

CLOUDFLARED_VERSION: string = ...
+CLOUDFLARED_VERSION | cloudflared

Variable CLOUDFLARED_VERSIONConst

CLOUDFLARED_VERSION: string = ...
diff --git a/variables/DEFAULT_CLOUDFLARED_BIN.html b/variables/DEFAULT_CLOUDFLARED_BIN.html index 309c340..6b116bf 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 = ...
+DEFAULT_CLOUDFLARED_BIN | cloudflared

Variable DEFAULT_CLOUDFLARED_BINConst

DEFAULT_CLOUDFLARED_BIN: string = ...
diff --git a/variables/MACOS_SERVICE_PATH.html b/variables/MACOS_SERVICE_PATH.html index 552f903..874ff90 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.

macOS

-
+
diff --git a/variables/RELEASE_BASE.html b/variables/RELEASE_BASE.html index 203ec55..8c85bda 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/"
+RELEASE_BASE | cloudflared

Variable RELEASE_BASEConst

RELEASE_BASE: "https://github.com/cloudflare/cloudflared/releases/" = "https://github.com/cloudflare/cloudflared/releases/"
diff --git a/variables/bin.html b/variables/bin.html index 6c9479a..3cd2ba3 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.

-
+
diff --git a/variables/identifier.html b/variables/identifier.html index 4aaeb24..ff58078 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.

macOS

-
+
diff --git a/variables/service.html b/variables/service.html index a9dda0c..6c86fbe 100644 --- a/variables/service.html +++ b/variables/service.html @@ -27,4 +27,4 @@

macOS, linux (sysv)

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