Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ISockzConnectable

Hierarchy

Implemented by

Index

Properties

Accessors

Methods

Properties

client

client: ISockzConnectable

Optional clientAuthorized

clientAuthorized?: boolean

commands

commands: string[]

convert

convert: Convert

ctl

ctl: SockzController

Optional disconnecting

disconnecting?: boolean

forwards

forwards: string[]

id

id: string

log

log: ISockzLogger

methods

methods: string[]

Optional prompt

prompt?: string

Optional relay

relay?: ISockzConnectable

Optional requireAuthorized

requireAuthorized?: boolean

Optional signature

signature?: string

socket

socket: TLSSocket | WebSocket

Optional systemInfo

systemInfo?: ISockzSystemInfo

Accessors

cert

  • get cert(): undefined | PeerCertificate

isAuthorized

  • get isAuthorized(): boolean

Methods

authorized

  • authorized(): void

close

  • close(hasError: boolean): void

data

  • data(data: any): void

disconnect

  • disconnect(): void

error

  • error(err: Error): void

exit

  • exit(msg?: string): void

help

  • help(): void

info

  • info(prop: string): void

init

  • init(commands?: string[], forwards?: string[]): void

  • Parameters

    • Optional commands: string[]
    • Optional forwards: string[]

    Returns void

load

  • load(): void

ping

  • ping(): void

ready

  • ready(): void

reg

  • reg(sig: string): void

reset

  • reset(): void

send

  • send(msg: string, keep?: boolean): void

showPrompt

  • showPrompt(): void

unauthorized

  • unauthorized(): void

updatePrompt

write

  • write(msg: string, cb?: (err?: Error) => void): void

  • Parameters

    • msg: string
    • Optional cb: (err?: Error) => void
        • (err?: Error): void

        • Parameters

          • Optional err: Error

          Returns void

    Returns void

Generated using TypeDoc