TypedRpc is a Json-Rpc implementation in OWIN. It automatically generates TypeScript files to be used by the client.
To install from NuGet, run the following command in the Package Manager Console:
Install-Package TypedRpc
Create a new class MyHandler.
// To make a class expose its methods for client requests,
// add the 'TypedRpcHandler' attribute to it.
[TypedRpc.TypedRpcHandler]
public class MyHandler
{
// All its public methods will be available in TypeScript.
public String HelloWorld()
{
return "Hello World!";
}
// You may use default values for parameters.
// They will be optional at the client side.
public String Greet(String name = "Guest")
{
return "Hello, " + name + "!";
}
// If you need the IOwinContext in your method,
// add it as a parameter and it will be injected in runtime.
// The generated TypeScript class will ignore it.
public String GreetMe(Microsoft.Owin.IOwinContext context)
{
return "Hello, " + context.Authentication.User.Identity.Name + "!";
}
// Asynchronous methods are supported.
public async Task<String> GreetAsync()
{
await Task.Delay(5000);
return "Hello async!";
}
}Create an index.ts file to your project and add a reference to the Scripts/TypedRpc/TypedRpc.ts file to have access to the server handlers and their methods.
/// <reference path="Scripts/TypedRpc/TypedRpc.ts" />
// Create a new instance of the desired handler class.
let rpc: TypedRpc.MyHandler = new TypedRpc.MyHandler();
var callback = function(data, jsonResponse) {
console.log(data);
};
// Call the available handler methods.
rpc.HelloWorld().done(callback).fail(callback);
rpc.Greet("New User").done(callback).fail(callback);
rpc.GreetMe().done(callback).fail(callback);
rpc.GreetAsync().done(callback).fail(callback);If your TypeScript files are not finding the handlers or their methods, update the Scripts/TypedRpc/TypedRpc.ts file. Click on it with the right mouse button and click on 'Run Custom Tool'.
Create an index.html file to your project and import the TypedRpc.js and index.js files to it.
<!DOCTYPE html>
<html>
<head>
<title>TypedRpc Example</title>
<meta charset="utf-8" />
<script src="Scripts/TypedRpc/TypedRpc.js"></script>
<script src="index.js"></script>
</head>
<body>
</body>
</html>The contents of this repository are covered under the Mit License.