Class Connection

The generic representation of a connection for all server types is an Actionhero.Connection. You will never be creating these yourself via an action or task, but you will find them in your Actions and Action Middleware.

Constructors

constructor

Properties

canChat connectedAt destroyed error? extension? fingerprint id matchedRoute? messageId messages? params pendingActions pipe? rawConnection remoteIP remotePort response? rooms session? setHeader? setStatusCode? totalActions type

Methods

destroy generateID sendFile sendMessage set setup verbs callConnectionCreateMethods createAsync

Constructors

constructor

  • new Connection(data, callCreateMethods?): Connection

  • Parameters

    • data: ConnectionData

      The specifics of this connection

    • callCreateMethods: boolean = true

      The specifics of this connection will calls create methods in the constructor. This property will exist for backward compatibility. If you want to construct connection and call create methods within async, you can use await Actionhero.Connection.createAsync(details) for construction.

    Returns Connection

Properties

canChat

canChat: boolean

Can this connection use the chat system?

connectedAt

connectedAt: number

The timestamp of when this connection was created

destroyed

destroyed: boolean

Optional error

error?: ErrnoException

If there's a local error

Optional extension

extension?: string

If there's a local extension to the request

fingerprint

fingerprint: string

A unique string identifer for this connection, but common among subsequent requests. For example, all web requests from the same client have the same fingerprint, but not the same id

id

id: string

A unique string identifer for this connection.

Optional matchedRoute

matchedRoute?: RouteType

messageId

messageId: string

The Id of the latest message this connection has sent to the server.

Optional messages

messages?: {
    message: string;
    [key: string]: any;
}[]

for specHelper

Type declaration

  • [key: string]: any
  • message: string

params

params: ConnectionParams

Any params this connection has saved for use in subsequent Actions.

pendingActions

pendingActions: number

How many actions are currently running for this connection? Most server types have a limit

Optional pipe

pipe?: Function

rawConnection

rawConnection: any

Any connection-specific properties. For, example, the HTTP res and req objects for web connections are here

remoteIP

remoteIP: string

The remote connection's IP address (as best as we can tell). May be either IPv4 or IPv6.

remotePort

remotePort: string | number

The remote connection's port. Related to connection.remoteIP

Optional response

response?: Record<string, unknown>

storage for a response payload

rooms

rooms: string[]

Any rooms this connection is a member of, it it can chat

Optional session

session?: Record<string, any>

storage for session data

Optional setHeader

setHeader?: ((key, value) => {})

Type declaration

    • (key, value): {}

    • Parameters

      • key: string
      • value: string

      Returns {}

    Optional setStatusCode

    setStatusCode?: ((code) => {})

    Type declaration

      • (code): {}

      • Parameters

        • code: number

        Returns {}

      totalActions

      totalActions: number

      How many actions has this connection run since it connected.

      type

      type: string

      The type of this connection (web, websocket, etc) as defined by the name of the server which created it

      Methods

      destroy

      • destroy(): Promise<void>

      • Destroys the connection. If the type/sever of the connection has a goodbye message, it will be sent. The connection will be removed from all rooms. The connection's socket will be closed when possible.

        Returns Promise<void>

      Private generateID

      • generateID(): string

      • Returns string

      sendFile

      • sendFile(path): Promise<void>

      • Send a file to a connection (usually in the context of an Action). Be sure to set data.toRender = false in the action! Uses Server#processFile and will set connection.params.file = path

        Parameters

        • path: string

        Returns Promise<void>

      sendMessage

      • sendMessage(message, verb?): Promise<void>

      • Send a message to a connection. Uses Server#sendMessage.

        Parameters

        • message: string | object | any[]
        • Optional verb: string

        Returns Promise<void>

      Private set

      • set(key, value): void

      • Parameters

        Returns void

      Private setup

      • setup(data): void

      • Parameters

        • data: ConnectionData

        Returns void

      verbs

      • verbs(verb, words): Promise<any>

      • Try to run a verb command for a connection

        Parameters

        • verb: string
        • words: string | string[]

        Returns Promise<any>

      Static Private callConnectionCreateMethods

      • callConnectionCreateMethods(connection): Promise<void>

      • Parameters

        Returns Promise<void>

      Static createAsync

      • createAsync(data): Promise<Connection>

      • Parameters

        • data: ConnectionData

          The specifics of this connection

        Returns Promise<Connection>

      Settings

      Member Visibility

      Theme

      On This Page

      constructorcanChatconnectedAtdestroyederrorextensionfingerprintidmatchedRoutemessageIdmessagesparamspendingActionspiperawConnectionremoteIPremotePortresponseroomssessionsetHeadersetStatusCodetotalActionstypedestroygenerateIDsendFilesendMessagesetsetupverbscallConnectionCreateMethodscreateAsync