Class Stub

Class representing a vRPC stub.

Index

Constructors

Accessors

Methods

callFunction initialize createAndInitialize isValidServiceFullName

Constructors

constructor

new Stub(serviceFullName: string, options?: null | StubOptions): Stub
Creates an instance of VrpcStub.
Parameters
- serviceFullName: string
  The full name of the service.
- Optionaloptions: null | StubOptions
  The options for the vRPC stub.
Returns Stub
Throws
Error if the service full name is invalid.

Accessors

serviceStatus

get serviceStatus(): ServiceStatus
The status of the service.

Returns ServiceStatus

Methods

callFunction

callFunction(
    methodName: string,
    request: Vrpc.Variant,
    callContext?: null | Vrpc.ClientContext,
): Promise<ResponseData>
Calls a function asynchronously on the vRPC service.
Parameters
- methodName: string
  The name of the method to call.
- request: Vrpc.Variant
  The vRPC payload request.
- OptionalcallContext: null | Vrpc.ClientContext
  The client call context (optional).
Returns Promise<ResponseData>
A promise that resolves to the vRPC response data.

Throws
MsaError if the status code is not OK.

initialize

initialize(): Promise<void>
Initializes the vRPC stub.

Returns Promise<void>
A promise that resolves when initialization finished.

Remarks
Is explicitly already performed with the createAndInitialize factory method. Is implicitly performed in the first call to the service. If connection to the service fails, the promise will be rejected.

`Static`createAndInitialize

createAndInitialize(
serviceFullName: string,
options?: null | StubOptions,
): Promise<Stub>
Factory method to create and initialize an instance of VrpcStub.
Parameters
- serviceFullName: string
  The full name of the service.
- Optionaloptions: null | StubOptions
  The options for the vRPC stub.
Returns Promise<Stub>
A promise that resolves to an instance of VrpcStub.

Remarks
If connection to the service fails, the promise will be rejected.

`Static`isValidServiceFullName

isValidServiceFullName(serviceFullName: string): boolean
Checks if a service full name is valid.
Parameters
- serviceFullName: string
  The full name of the service.
Returns boolean
True if the service full name is valid, false otherwise.

Remarks
Allowed characters are letters, digits, and the following special characters: _ -