Options
All
  • Public
  • Public/Protected
  • All
Menu

jade-service-runner

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

Addition

Addition: function

Type declaration

AnyOfStringDoaGddGAStringDoaGddGAStringTxhU5DjSStringDoaGddGAStringDoaGddGAStringDoaGddGABooleanVyG3AEThUnorderedSetOfObjectOfStringDoaGddGAStringDoaGddGAUnorderedSetOfObjectOfStringDoaGddGAStringDoaGddGAKieCSt44UIuKSje3U7AKQiesYaFk1VHLUnorderedSetOfObjectOfStringDoaGddGAStringVp8AIgHFStringDoaGddGAUnorderedSetOfObjectOfStringDoaGddGAStringDoaGddGAKieCSt44UIuKSje3YY1BLmC3Zq6QC3T0UnorderedSetOfObjectOfStringDoaGddGAStringDoaGddGACmBlIq6JBb6CmGaXUnorderedSetOfObjectOfStringDoaGddGAStringDoaGddGAStringDoaGddGAStringDoaGddGAStringDoaGddGAStringDoaGddGAObjectOfStringDoaGddGAStringDoaGddGAStringDoaGddGAUnorderedSetOfObjectOfStringDoaGddGAUnorderedSetOfStringDoaGddGADvj0XlFaZX45Ehh9Rf17ZTlRF5R1Qy8GObjectOfUnorderedSetOfStringDoaGddGADvj0XlFaUnorderedSetOfStringDoaGddGADvj0XlFaUnorderedSetOfStringDoaGddGADvj0XlFaMWFrq3Uy6Aw04EI22VmgfxIIObjectOfStringDoaGddGAStringDoaGddGAStringDoaGddGAStringDoaGddGAStringDoaGddGAStringDoaGddGAObjectOfStringDoaGddGAStringDoaGddGAStringDoaGddGAUnorderedSetOfObjectOfStringDoaGddGAUnorderedSetOfStringDoaGddGADvj0XlFaZX45Ehh9Rf17ZTlRF5R1Qy8GObjectOfUnorderedSetOfStringDoaGddGADvj0XlFaUnorderedSetOfStringDoaGddGADvj0XlFaUnorderedSetOfStringDoaGddGADvj0XlFaMWFrq3Uy6Aw04EI2

AnyOfStringDoaGddGAStringDoaGddGAStringTxhU5DjSStringDoaGddGAStringDoaGddGAStringDoaGddGABooleanVyG3AEThUnorderedSetOfObjectOfStringDoaGddGAStringDoaGddGAUnorderedSetOfObjectOfStringDoaGddGAStringDoaGddGAKieCSt44UIuKSje3U7AKQiesYaFk1VHLUnorderedSetOfObjectOfStringDoaGddGAStringVp8AIgHFStringDoaGddGAUnorderedSetOfObjectOfStringDoaGddGAStringDoaGddGAKieCSt44UIuKSje3YY1BLmC3Zq6QC3T0UnorderedSetOfObjectOfStringDoaGddGAStringDoaGddGACmBlIq6JBb6CmGaXUnorderedSetOfObjectOfStringDoaGddGAStringDoaGddGAStringDoaGddGAStringDoaGddGAStringDoaGddGAStringDoaGddGAObjectOfStringDoaGddGAStringDoaGddGAStringDoaGddGAUnorderedSetOfObjectOfStringDoaGddGAUnorderedSetOfStringDoaGddGADvj0XlFaZX45Ehh9Rf17ZTlRF5R1Qy8GObjectOfUnorderedSetOfStringDoaGddGADvj0XlFaUnorderedSetOfStringDoaGddGADvj0XlFaUnorderedSetOfStringDoaGddGADvj0XlFaMWFrq3Uy6Aw04EI22VmgfxIIObjectOfStringDoaGddGAStringDoaGddGAStringDoaGddGAStringDoaGddGAStringDoaGddGAStringDoaGddGAObjectOfStringDoaGddGAStringDoaGddGAStringDoaGddGAUnorderedSetOfObjectOfStringDoaGddGAUnorderedSetOfStringDoaGddGADvj0XlFaZX45Ehh9Rf17ZTlRF5R1Qy8GObjectOfUnorderedSetOfStringDoaGddGADvj0XlFaUnorderedSetOfStringDoaGddGADvj0XlFaUnorderedSetOfStringDoaGddGADvj0XlFaMWFrq3Uy6Aw04EI2: StringDoaGddGA | StringTxhU5DjS | BooleanVyG3AETh | UnorderedSetOfObjectOfStringDoaGddGAStringDoaGddGAUnorderedSetOfObjectOfStringDoaGddGAStringDoaGddGAKieCSt44UIuKSje3U7AKQiesYaFk1VHL | UnorderedSetOfObjectOfStringDoaGddGAStringVp8AIgHFStringDoaGddGAUnorderedSetOfObjectOfStringDoaGddGAStringDoaGddGAKieCSt44UIuKSje3YY1BLmC3Zq6QC3T0 | UnorderedSetOfObjectOfStringDoaGddGAStringDoaGddGACmBlIq6JBb6CmGaX | UnorderedSetOfObjectOfStringDoaGddGAStringDoaGddGAStringDoaGddGAStringDoaGddGAStringDoaGddGAStringDoaGddGAObjectOfStringDoaGddGAStringDoaGddGAStringDoaGddGAUnorderedSetOfObjectOfStringDoaGddGAUnorderedSetOfStringDoaGddGADvj0XlFaZX45Ehh9Rf17ZTlRF5R1Qy8GObjectOfUnorderedSetOfStringDoaGddGADvj0XlFaUnorderedSetOfStringDoaGddGADvj0XlFaUnorderedSetOfStringDoaGddGADvj0XlFaMWFrq3Uy6Aw04EI22VmgfxII | ObjectOfStringDoaGddGAStringDoaGddGAStringDoaGddGAStringDoaGddGAStringDoaGddGAStringDoaGddGAObjectOfStringDoaGddGAStringDoaGddGAStringDoaGddGAUnorderedSetOfObjectOfStringDoaGddGAUnorderedSetOfStringDoaGddGADvj0XlFaZX45Ehh9Rf17ZTlRF5R1Qy8GObjectOfUnorderedSetOfStringDoaGddGADvj0XlFaUnorderedSetOfStringDoaGddGADvj0XlFaUnorderedSetOfStringDoaGddGADvj0XlFaMWFrq3Uy6Aw04EI2

Backend

Backend: SocketBackend | HttpBackend

BooleanVyG3AETh

BooleanVyG3AETh: boolean

Connection

Connection: WSConnection | HttpConnection

ConnectionBus

ConnectionBus: StrictEventEmitter<EventEmitter, ConnectionEvents>

ConnectionSpec

ConnectionSpec: HttpConnectionSpec | WsConnectionSpec

DataResponse

DataResponse: HttpDataResponse | WSDataResponse

ExternalServiceNotifications

ExternalServiceNotifications: StrictEventEmitter<EventEmitter, ExternalServiceNotificationEvents>

Frontend

Frontend: function

Type declaration

HttpBackend

HttpBackend: function

Type declaration

InstallService

InstallService: function

Type declaration

IntegerTfIB8Svh

IntegerTfIB8Svh: number

ListAvailableServices

ListAvailableServices: function

Type declaration

ListInstalledServices

ListInstalledServices: function

Type declaration

ListRunningServices

ListRunningServices: function

Type declaration

ListServices

ListServices: function

Type declaration

Protocol

Protocol: "udp" | "tcp" | "ws" | "http" | "https" | "wss"

RequestSpec

RequestSpec: WSRequestSpec | HttpRequestSpec

ResponseBus

ResponseBus<T>: StrictEventEmitter<EventEmitter, ResponseEvents<T>>

Type parameters

ServiceEvent

ServiceEvent: LaunchServiceEvent | PendingServiceEvent | ConsoleServiceEvent | HealthServiceEvent | ErrorServiceEvent | ExitServiceEvent | TerminateServiceEvent | StopServiceEvent

ServiceState

ServiceState: "running" | "stopped" | "pending"

ServiceStatus

ServiceStatus: "spec" | ServiceState

SocketBackend

SocketBackend: function

Type declaration

StartService

StartService: function

Type declaration

StopServiceReason

StopServiceReason: "health" | "unknown"

StringDoaGddGA

StringDoaGddGA: string

StringTxhU5DjS

StringTxhU5DjS: "all" | "running" | "available" | "installed"

StringVp8AIgHF

StringVp8AIgHF: "active" | "available" | "installed"

Subtraction

Subtraction: function

Type declaration

Teardown

Teardown: function

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

TestProtocol

TestProtocol: "ws" | "http"

UnorderedSetOfObjectOfStringDoaGddGAStringDoaGddGACmBlIq6JBb6CmGaX

UnorderedSetOfObjectOfStringDoaGddGAStringDoaGddGACmBlIq6JBb6CmGaX: ObjectOfStringDoaGddGAStringDoaGddGACmBlIq6J[]

UnorderedSetOfObjectOfStringDoaGddGAStringDoaGddGAKieCSt44UIuKSje3

UnorderedSetOfObjectOfStringDoaGddGAStringDoaGddGAKieCSt44UIuKSje3: ObjectOfStringDoaGddGAStringDoaGddGAKieCSt44[]

UnorderedSetOfObjectOfStringDoaGddGAStringDoaGddGAStringDoaGddGAStringDoaGddGAStringDoaGddGAStringDoaGddGAObjectOfStringDoaGddGAStringDoaGddGAStringDoaGddGAUnorderedSetOfObjectOfStringDoaGddGAUnorderedSetOfStringDoaGddGADvj0XlFaZX45Ehh9Rf17ZTlRF5R1Qy8GObjectOfUnorderedSetOfStringDoaGddGADvj0XlFaUnorderedSetOfStringDoaGddGADvj0XlFaUnorderedSetOfStringDoaGddGADvj0XlFaMWFrq3Uy6Aw04EI22VmgfxII

UnorderedSetOfObjectOfStringDoaGddGAStringDoaGddGAStringDoaGddGAStringDoaGddGAStringDoaGddGAStringDoaGddGAObjectOfStringDoaGddGAStringDoaGddGAStringDoaGddGAUnorderedSetOfObjectOfStringDoaGddGAUnorderedSetOfStringDoaGddGADvj0XlFaZX45Ehh9Rf17ZTlRF5R1Qy8GObjectOfUnorderedSetOfStringDoaGddGADvj0XlFaUnorderedSetOfStringDoaGddGADvj0XlFaUnorderedSetOfStringDoaGddGADvj0XlFaMWFrq3Uy6Aw04EI22VmgfxII: ObjectOfStringDoaGddGAStringDoaGddGAStringDoaGddGAStringDoaGddGAStringDoaGddGAStringDoaGddGAObjectOfStringDoaGddGAStringDoaGddGAStringDoaGddGAUnorderedSetOfObjectOfStringDoaGddGAUnorderedSetOfStringDoaGddGADvj0XlFaZX45Ehh9Rf17ZTlRF5R1Qy8GObjectOfUnorderedSetOfStringDoaGddGADvj0XlFaUnorderedSetOfStringDoaGddGADvj0XlFaUnorderedSetOfStringDoaGddGADvj0XlFaMWFrq3Uy6Aw04EI2[]

UnorderedSetOfObjectOfStringDoaGddGAStringDoaGddGAUnorderedSetOfObjectOfStringDoaGddGAStringDoaGddGAKieCSt44UIuKSje3U7AKQiesYaFk1VHL

UnorderedSetOfObjectOfStringDoaGddGAStringDoaGddGAUnorderedSetOfObjectOfStringDoaGddGAStringDoaGddGAKieCSt44UIuKSje3U7AKQiesYaFk1VHL: ObjectOfStringDoaGddGAStringDoaGddGAUnorderedSetOfObjectOfStringDoaGddGAStringDoaGddGAKieCSt44UIuKSje3U7AKQies[]

UnorderedSetOfObjectOfStringDoaGddGAStringVp8AIgHFStringDoaGddGAUnorderedSetOfObjectOfStringDoaGddGAStringDoaGddGAKieCSt44UIuKSje3YY1BLmC3Zq6QC3T0

UnorderedSetOfObjectOfStringDoaGddGAStringVp8AIgHFStringDoaGddGAUnorderedSetOfObjectOfStringDoaGddGAStringDoaGddGAKieCSt44UIuKSje3YY1BLmC3Zq6QC3T0: ObjectOfStringDoaGddGAStringVp8AIgHFStringDoaGddGAUnorderedSetOfObjectOfStringDoaGddGAStringDoaGddGAKieCSt44UIuKSje3YY1BLmC3[]

UnorderedSetOfObjectOfStringDoaGddGAUnorderedSetOfStringDoaGddGADvj0XlFaZX45Ehh9Rf17ZTlR

UnorderedSetOfObjectOfStringDoaGddGAUnorderedSetOfStringDoaGddGADvj0XlFaZX45Ehh9Rf17ZTlR: ObjectOfStringDoaGddGAUnorderedSetOfStringDoaGddGADvj0XlFaZX45Ehh9[]

UnorderedSetOfStringDoaGddGADvj0XlFa

UnorderedSetOfStringDoaGddGADvj0XlFa: StringDoaGddGA[]

Variables

Const GATEWAY_ERROR

GATEWAY_ERROR: "Gateway Failure" = "Gateway Failure"

Const GATEWAY_ERROR_CODE

GATEWAY_ERROR_CODE: -32098 = -32098

Const INTERNAL_SERVER

INTERNAL_SERVER: "Internal Server Error" = "Internal Server Error"

Const INTERNAL_SERVER_CODE

INTERNAL_SERVER_CODE: -32603 = -32603

Const INVALID_PARAMS

INVALID_PARAMS: "Invalid Params" = "Invalid Params"

Const INVALID_PARAMS_CODE

INVALID_PARAMS_CODE: -32602 = -32602

Const INVALID_REQUEST

INVALID_REQUEST: "Invalid Request" = "Invalid Request"

Const INVALID_REQUEST_CODE

INVALID_REQUEST_CODE: -32600 = -32600

Const METHOD_NOT_FOUND

METHOD_NOT_FOUND: "Method not found" = "Method not found"

Const METHOD_NOT_FOUND_CODE

METHOD_NOT_FOUND_CODE: -32601 = -32601

Const PARSE_ERROR

PARSE_ERROR: "Parse Error" = "Parse Error"

Const PARSE_ERROR_CODE

PARSE_ERROR_CODE: -32700 = -32700

Const REPO_MANIFEST

REPO_MANIFEST: "jade-service-runner-manifest.json" = "jade-service-runner-manifest.json"

Const SERVICE_NOT_FOUND

SERVICE_NOT_FOUND: "Service not found" = "Service not found"

Const SERVICE_NOT_FOUND_CODE

SERVICE_NOT_FOUND_CODE: -32099 = -32099

Const frontendRegistry

frontendRegistry: Map<"tcp" | "http" | "ws" | "udp" | "https" | "wss", function> = new Map<Protocol, Frontend>([["ws", wsFrontend],["http", httpFrontend],])

Functions

Const connectionError

  • connectionError(message: string, id: number, reason: string, error: Error, logger: Logger): JSONRpcError

Const downloadAsset

  • downloadAsset(assetURI: string, dir: string, timeout?: number): Promise<string>

  • Parameters

    • assetURI: string
    • dir: string
    • Default value timeout: number = 120000

    Returns Promise<string>

    The config of a service scoped by OS and service name

Const error

  • error(message: string, id: number, data: any): JSONRpcError

Const extractAsset

  • extractAsset(srcPath: string, srcDest: string): Promise<boolean>

  • Parameters

    • srcPath: string
    • srcDest: string

    Returns Promise<boolean>

    The success or failure of the extraction

Const getAvailableTCPPort

  • getAvailableTCPPort(testPort?: number): Promise<number>

  • Parameters

    • Default value testPort: number = 0

    Returns Promise<number>

    a free TCP Port

Const getAvailableUDPPort

  • getAvailableUDPPort(testPort?: number): Promise<unknown>

  • Parameters

    • Default value testPort: number = 0

    Returns Promise<unknown>

    a free TCP Port

getFreePorts

  • getFreePorts(): Promise<IDynamicPorts>

  • Returns Promise<IDynamicPorts>

    a set of free TCP and UDP Ports

Const getLogStream

Const getOS

Const httpBackend

Const httpFrontend

isUp

  • isUp(port: number, protocol: Protocol): Promise<boolean>

  • Parameters

    Returns Promise<boolean>

    true if the port is able to be connected to, false otherwise

Const makeLogger

  • makeLogger(service: string, context: string, path?: string): Logger

  • Parameters

    • service: string
    • context: string
    • Default value path: string = "/"

    Returns Logger

Const methods

Const mockServer

  • mockServer(file: string): Promise<Server>

Const mockUDPServer

  • mockUDPServer(): Promise<Socket>

Const mockWSServer

renderService

Const simpleMathConfig

  • simpleMathConfig(assetLocation: string): object

Const startServiceRunner

Const startServiceRunnerFromCLI

  • startServiceRunnerFromCLI(program: any): Promise<void>

Const statusCode

  • statusCode(code: number): number

Const testServer

  • testServer(port: number, protocol: TestProtocol, openrpcDocument: OpenRPC, opts: any): Server

Const wsBackend

Const wsFrontend

Object literals

Const backendRegistry

backendRegistry: object

http

http: httpBackend = httpBackend

ws

ws: wsBackend = wsBackend

Const mockConfig

mockConfig: object

services

services: (object | object)[] = [{version: "1.0.0",name: "testService",rpcPort: "${DYNAMIC_TCP_PORT_1}",environments: [{name: "test",args: {start: ["--datadir", "${SERVICE_DIR}/datadir"],stop: [],teardown: [],},health: {interval: 500,retries: 2,port: "${DYNAMIC_TCP_PORT_1}",protocol: "tcp",},}],os: {osx: {commands: {setup: [{cmd: "chmod",args: ["+x", "./${SERVICE_DIR}/testService/testService1-osx"],}],start: "./${SERVICE_DIR}/testService/testService1-osx",stop: [],teardown: [],},},linux: {commands: {setup: [{cmd: "chmod",args: ["+x", "./${SERVICE_DIR}/testService/testService1-osx"],}],start: "./${SERVICE_DIR}/testService/testService1-osx",stop: [],teardown: [],},},windows: {commands: {setup: [],start: "powershell ./${SERVICE_DIR}/testService/testService1-win.ps1",stop: [],teardown: [],},},},},{version: "1.0.0",name: "testService2",environments: [{name: "dev",args: {start: ["--datadir", "core-geth"],stop: [],teardown: [],},}],os: {osx: {commands: {setup: [],start: "./testService",stop: "",teardown: "",},},},}]