Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default

Hierarchy

  • default

Index

Constructors

Properties

Methods

Constructors

constructor

  • new default(params: boolean | { compatMode?: boolean; dynamic?: boolean }): default

Properties

Private _compatMode

_compatMode: boolean

dynamic

dynamic: boolean

hooks

hooks: Record<string, (params: unknown) => Promise<unknown>> = {}

methods

methods: RpcMethod[] = []

notifications

notifications: Record<string, Notification> = {}

onInit

onInit: (params: unknown) => unknown = ...

Type declaration

    • (params: unknown): unknown

    • Parameters

      • params: unknown

      Returns unknown

options

options: Record<string, { default: unknown; description: string; type: string; value: unknown }> = {}

rpc

rpc: null | SocketApiClient = null

Methods

Private _getmanifest

  • _getmanifest(params?: unknown): { dynamic: boolean; hooks: string[]; options: { default: unknown; description: string; name: string; type: string }[]; rpcmethods: { description: string; long_description: string; name: string; usage: string }[]; subscriptions: string[] }

  • Parameters

    • Optional params: unknown

    Returns { dynamic: boolean; hooks: string[]; options: { default: unknown; description: string; name: string; type: string }[]; rpcmethods: { description: string; long_description: string; name: string; usage: string }[]; subscriptions: string[] }

    • dynamic: boolean
    • hooks: string[]
    • options: { default: unknown; description: string; name: string; type: string }[]
    • rpcmethods: { description: string; long_description: string; name: string; usage: string }[]
    • subscriptions: string[]

Private _init

Protected _mainLoop

  • _mainLoop(): Promise<void>

Private _write

  • _write(content: string): Promise<void>

Private _writeJsonrpcNotification

  • _writeJsonrpcNotification(method: string, params: unknown): Promise<void>

Private _writeJsonrpcResponse

  • _writeJsonrpcResponse(result: unknown, id: string | number, isError?: boolean): Promise<void>

addHook

  • addHook(name: string, callback: () => Promise<unknown>): void

addMethod

  • addMethod(name: string, callback: (params: unknown) => unknown, usage: string, description: string, longDescription: string): void

  • Parameters

    • name: string
    • callback: (params: unknown) => unknown
        • (params: unknown): unknown

        • Parameters

          • params: unknown

          Returns unknown

    • usage: string
    • description: string
    • longDescription: string

    Returns void

addOption

  • addOption(name: string, defaultValue: unknown, description: string, type: string): void

log

  • log(message: string, level?: string): void

start

  • start(): void

subscribe

  • subscribe(name: string): void

Generated using TypeDoc