Interface Conn<S, CP, CS, V, I, DB>

[CONN_CONNECTED_SYMBOL]

Optional[CONN_DRIVER_SYMBOL]

subscriptions

[CONN_ACTOR_SYMBOL]

• get "[CONN_ACTOR_SYMBOL]"(): ActorInstance<S, CP, CS, V, I, DB>

  Returns ActorInstance<S, CP, CS, V, I, DB>

[CONN_PERSIST_RAW_SYMBOL]

• get "[CONN_PERSIST_RAW_SYMBOL]"(): PersistedConn<CP, CS>

  Gets the raw persist data for serialization

  Returns PersistedConn<CP, CS>

[CONN_PERSIST_SYMBOL]

• get "[CONN_PERSIST_SYMBOL]"(): PersistedConn<CP, CS>

  Returns PersistedConn<CP, CS>

[CONN_STATE_ENABLED_SYMBOL]

• get "[CONN_STATE_ENABLED_SYMBOL]"(): boolean

  Returns boolean

id

• get id(): string

  Unique identifier for the connection.

  Returns string

isHibernatable

• get isHibernatable(): boolean
  Experimental

  If the underlying connection can hibernate.

  Returns boolean

lastSeen

• get lastSeen(): number

  Timestamp of the last time the connection was seen, i.e. the last time the connection was active and checked for liveness.

  Returns number

params

• get params(): CP

  Returns CP

state

• get state(): CS

  Gets the current state of the connection.

  Throws an error if the state is not enabled.

  Returns CS

• set state(value: CS): void

  Sets the state of the connection.

  Throws an error if the state is not enabled.

  Parameters

  • value: CS

  Returns void

[CONN_HAS_CHANGES_SYMBOL]

• "[CONN_HAS_CHANGES_SYMBOL]"(): boolean

  Returns whether this connection has unsaved changes

  Returns boolean

[CONN_MARK_SAVED_SYMBOL]

• "[CONN_MARK_SAVED_SYMBOL]"(): void

  Marks changes as saved

  Returns void

[CONN_SEND_MESSAGE_SYMBOL]

• "[CONN_SEND_MESSAGE_SYMBOL]"(message: CachedSerializer<any, any, any>): void

  Parameters

  • message: CachedSerializer<any, any, any>

  Returns void

[CONN_SPEAKS_RIVETKIT_SYMBOL]

• "[CONN_SPEAKS_RIVETKIT_SYMBOL]"(): boolean

  Returns boolean

disconnect

• disconnect(reason?: string): Promise<void>

  Disconnects the client with an optional reason.

  Parameters

  • Optionalreason: string

    The reason for disconnection.

  Returns Promise<void>

send

• send(eventName: string, ...args: unknown[]): void

  Sends an event with arguments to the client.

  Parameters

  • eventName: string

    The name of the event.

  • ...args: unknown[]

    The arguments for the event.

  Returns void

  See

  Documentation