Using Node Services in ASP.NET Core

June 04, 2017 by Anuraj

ASP.NET Core NodeServices Node JS

This post is about running Javascript code in Server. Because a huge number of useful, high-quality Web-related open source packages are in the form of Node Package Manager (NPM) modules. NPM is the largest repository of open-source software packages in the world, and the Microsoft.AspNetCore.NodeServices package means that you can use any of them in your ASP.NET Core application.

To use Node Services, first you need to include the reference of Microsoft.AspNetCore.NodeServices package in your project file. You can do this using dotnet add package Microsoft.AspNetCore.NodeServices command.

    <PackageReference Include="Microsoft.AspNetCore.All" Version="2.0.0-preview1-final" />
    <PackageReference Include="Microsoft.AspNetCore.NodeServices" Version="1.1.1" />

Then you need to add the Node Services middleware to the request pipeline. You can do it in your ConfigureServices() method.

public void ConfigureServices(IServiceCollection services)

Now you’re able to get instance of INodeServices in your application. INodeServices is the API through which .NET code can make calls into JavaScript that runs in a Node environment. You can use FromServices attribute to get the instance of `INodeServices’ in your action method. Here is Add method implementation in MVC.

public async Task<IActionResult> Add([FromServices] INodeServices nodeServices)
    var num1 = 10;
    var num2 = 20;
    var result = await nodeServices.InvokeAsync<int>("AddModule.js", num1, num2);
    ViewData["ResultFromNode"] = $"Result of {num1} + {num2} is {result}";
    return View();

And here is the code of AddModule.js file.

module.exports = function(callback, num1, num2) { 
  var result = num1 + num2;
  callback(null, result); 

You need to use the type of the result in your InvokeAsync method, in this example I am using int.

Here is the result of when I am browsing /Home/Add method.

Add two numbers using Node services

Here is the more useful example, where I am generating the screenshot of web page using url-to-image node module. To use this, first you need to install this package using npm install command - npm install --save url-to-image.

Here is the action method, which takes url value from Form values and invokes node module to generate png image.

public async Task<IActionResult> GenerateUrlPreview([FromServices] INodeServices nodeServices)
    var url = Request.Form["Url"].ToString();
    var fileName = System.IO.Path.ChangeExtension(DateTime.UtcNow.Ticks.ToString(), "png");
    var file = await nodeServices.InvokeAsync<string>("UrlPreviewModule.js", url, 
        IO.Path.Combine("PreviewImages", fileName));

    return Content($"<a class=\"btn btn-default\" target=\"_blank\" href=\"/Home/Download?img={fileName}\">Download image</a>");

And here is the UrlPreviewModule.js file.

var urlToImage = require('url-to-image');
module.exports = function (callback, url, imageName) {
    urlToImage(url, imageName).then(function () {
        callback(null, imageName);
    }).catch(function (err) {
        callback(err, imageName);

NodeServices allows ASP.NET Core developers to make use of the entire NPM ecosystem, which gives rise to a huge range of possibilities. You can find the full source code on GitHub.

Happy Programming :)

Copyright © 2024 Anuraj. Blog content licensed under the Creative Commons CC BY 2.5 | Unless otherwise stated or granted, code samples licensed under the MIT license. This is a personal blog. The opinions expressed here represent my own and not those of my employer. Powered by Jekyll. Hosted with ❤ by GitHub