Module rpc-descriptor-types

The descriptors are used to describe what properties/functions to expose on an object and what are the function return behaviors.

Type aliases

AnyConstructor

AnyConstructor: new (...args: any[]) => any

Type declaration

- new (...args: any[]): any
- Parameters
  - Rest ...args: any[]
  Returns any

AnyFunction

AnyFunction: (...args: any[]) => any

Type declaration

- (...args: any[]): any
- Parameters
  - Rest ...args: any[]
  Returns any

ClassDescriptors

ClassDescriptors: {}

Type declaration

[key: string]: ClassDescriptor

Descriptor

Descriptor: ObjectDescriptor | FunctionDescriptor | PropertyDescriptor | ClassDescriptor

FunctionDescriptors

FunctionDescriptors: {}

Type declaration

[key: string]: FunctionDescriptor

FunctionReturnBehavior

FunctionReturnBehavior: "sync" | "async" | "void"

Function return behaviors are the following:

sync - the proxy function will return the result synchronously (works only if the channel supports synchronous communication)
async - the proxy function will return a Promise (works only if the channel supports asynchronous communication)
void - the return value is ignored and no result message is sent

see: RPCChannel

ObjectDescriptors

ObjectDescriptors: {}

Type declaration

[key: string]: ObjectDescriptorWithProps

Functions

getArgumentDescriptor

getArgumentDescriptor(descriptor: FunctionDescriptor<FunctionReturnBehavior>, idx?: number): undefined | ArgumentDescriptor

- Defined in rpc-descriptor-types.ts:150
Parameters
- descriptor: FunctionDescriptor<FunctionReturnBehavior>
- Optional idx: number
Returns undefined | ArgumentDescriptor

getEventDescriptor

getEventDescriptor(descriptor?: ObjectDescriptor, eventName?: string): FunctionDescriptor<FunctionReturnBehavior>

- Defined in rpc-descriptor-types.ts:162
Parameters
- Optional descriptor: ObjectDescriptor
- Optional eventName: string
Returns FunctionDescriptor<FunctionReturnBehavior>

getFunctionDescriptor

getFunctionDescriptor(descriptor: ObjectDescriptor, funcName: string): FunctionDescriptor<FunctionReturnBehavior>

- Defined in rpc-descriptor-types.ts:154
Parameters
- descriptor: ObjectDescriptor
- funcName: string
Returns FunctionDescriptor<FunctionReturnBehavior>

getPropName

getPropName(descriptor: string | { name?: string }): string

- Defined in rpc-descriptor-types.ts:146
Parameters
- descriptor: string | { name?: string }
Returns string

getPropertyDescriptor

getPropertyDescriptor(descriptor?: ObjectDescriptor, propName?: string): PropertyDescriptor

- Defined in rpc-descriptor-types.ts:158
Parameters
- Optional descriptor: ObjectDescriptor
- Optional propName: string
Returns PropertyDescriptor

isFunctionDescriptor

isFunctionDescriptor(descriptor?: Descriptor): descriptor is FunctionDescriptor<FunctionReturnBehavior>

- Defined in rpc-descriptor-types.ts:166
Parameters
- Optional descriptor: Descriptor
Returns descriptor is FunctionDescriptor<FunctionReturnBehavior>

processFunctionDescriptor

processFunctionDescriptor(descriptor: string | FunctionDescriptor<FunctionReturnBehavior>, func: AnyFunction): FunctionDescriptor<FunctionReturnBehavior>

- Defined in rpc-descriptor-types.ts:173
Parameters
- descriptor: string | FunctionDescriptor<FunctionReturnBehavior>
- func: AnyFunction
Returns FunctionDescriptor<FunctionReturnBehavior>

processObjectDescriptor

processObjectDescriptor(descriptor: ObjectDescriptor, obj: any): ObjectDescriptor

- Defined in rpc-descriptor-types.ts:180
Parameters
- descriptor: ObjectDescriptor
- obj: any
Returns ObjectDescriptor

Generated using TypeDoc