Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CoffeeNode

Hierarchy

Index

Constructors

constructor

Properties

calls

calls: number = 0

Sums of http request calls since created

connected

connected: boolean = false

Whether the node already connected via websocket

Readonly http

http: Pool

The http clients pool for http calls

Readonly lava

options

options: NodeOptions

The node options

Readonly plugins

plugins: Plugins = ...

The list of plugins the node has

resumed

resumed: boolean = false

Whether the node is resumed from previous session

Readonly routePlanner

routePlanner: CoffeeRoutePlanner = ...

THe routePlanner instance to manage route planners

Optional socket

socket?: WebSocket

The node websocket if connected

stats

stats: NodeStats

The node stats

Accessors

isSecure

  • get isSecure(): boolean

name

  • get name(): string

url

  • get url(): string

Methods

configResume

  • configResume(): void

connect

  • connect(): void

destroy

  • destroy(): void

fetchPlugins

post

  • post(endpoint: string, body?: unknown, raw?: boolean): Promise<unknown>
  • Do http(s) post request to the node

    Parameters

    • endpoint: string
    • Optional body: unknown
    • raw: boolean = false

    Returns Promise<unknown>

request

  • request<T>(endpoint: string): Promise<T>

send

Generated using TypeDoc