@sora-soft/framework

---

@sora-soft/framework / Route

Class: Route

Defined in: packages/framework/src/lib/rpc/Route.ts:52

Extended by

• NodeHandler

Constructors

Constructor

new Route(): Route;

Defined in: packages/framework/src/lib/rpc/Route.ts:202

Returns

Route

Methods

buildCallParams()

protected buildCallParams(
   method, 
   paramTypes, 
   request, 
   response, 
connector): Promise<unknown[]>;

Defined in: packages/framework/src/lib/rpc/Route.ts:204

Parameters

Parameter	Type
method	string
paramTypes	any[]
request	Notify<unknown> | Request<unknown>
response	Response<unknown> | null
connector	Connector

Returns

Promise<unknown[]>

---

callMethod()

protected callMethod(
   method, 
   request, 
   response, 
connector): Promise<void>;

Defined in: packages/framework/src/lib/rpc/Route.ts:243

Parameters

Parameter	Type
method	string
request	Request
response	Response
connector	Connector

Returns

Promise<void>

---

callNotify()

protected callNotify(
   method, 
   request, 
connector): Promise<void>;

Defined in: packages/framework/src/lib/rpc/Route.ts:275

Parameters

Parameter	Type
method	string
request	Notify
connector	Connector

Returns

Promise<void>

---

hasMethod()

protected hasMethod(method): boolean | undefined;

Defined in: packages/framework/src/lib/rpc/Route.ts:302

Parameters

Parameter	Type
method	string

Returns

boolean | undefined

---

hasNotify()

protected hasNotify(method): boolean | undefined;

Defined in: packages/framework/src/lib/rpc/Route.ts:308

Parameters

Parameter	Type
method	string

Returns

boolean | undefined

---

callback()

static callback(route): ListenerCallback;

Defined in: packages/framework/src/lib/rpc/Route.ts:125

Parameters

Parameter	Type
route	Route

Returns

ListenerCallback

---

compose()

static compose(routes): ListenerCallback;

Defined in: packages/framework/src/lib/rpc/Route.ts:177

Parameters

Parameter	Type
routes	Route[]

Returns

ListenerCallback

---

makeErrorRPCResponse()

protected static makeErrorRPCResponse(
   request, 
   response, 
err): IRawResPacket<unknown>;

Defined in: packages/framework/src/lib/rpc/Route.ts:111

Parameters

Parameter	Type
request	Request
response	Response
err	ExError

Returns

IRawResPacket<unknown>

---

method()

protected static method(target, key): void;

Defined in: packages/framework/src/lib/rpc/Route.ts:53

Parameters

Parameter	Type
target	Route
key	string

Returns

void

---

notify()

protected static notify(target, key): void;

Defined in: packages/framework/src/lib/rpc/Route.ts:58

Parameters

Parameter	Type
target	Route
key	string

Returns

void

---

registerMethod()

protected static registerMethod(
   target, 
   method, 
   callback, 
   types): void;

Defined in: packages/framework/src/lib/rpc/Route.ts:64

Parameters

Parameter	Type
target	Route
method	string
callback	RPCHandler
types	any[]

Returns

void

---

registerMiddleware()

protected static registerMiddleware<T>(
   target, 
   method, 
   middleware): void;

Defined in: packages/framework/src/lib/rpc/Route.ts:101

Type Parameters

Type Parameter	Default type
T extends Route	Route

Parameters

Parameter	Type
target	T
method	string
middleware	RPCMiddleware<T>

Returns

void

---

registerNotify()

protected static registerNotify(
   target, 
   method, 
   callback, 
   types): void;

Defined in: packages/framework/src/lib/rpc/Route.ts:76

Parameters

Parameter	Type
target	Route
method	string
callback	NotifyHandler
types	any[]

Returns

void

---

registerProvider()

protected static registerProvider<T, R>(
   target, 
   method, 
   type, 
   provider): void;

Defined in: packages/framework/src/lib/rpc/Route.ts:88

Type Parameters

Type Parameter	Default type
T	unknown
R extends Route	Route

Parameters

Parameter	Type
target	R
method	string
type	unknown
provider	MethodPramBuilder<T, R>

Returns

void