he-sdk-nodejs

node.js SDK for HackerEarth API

Usage no npm install needed!

<script type="module">
  import heSdkNodejs from 'https://cdn.skypack.dev/he-sdk-nodejs';
</script>

README

he-sdk-nodejs

Node.js SDK for HackerEarth API.

This SDK helps you to compile your code with the HackerEarth API v2

You can implement an online code compiling site in Node.js ( like Code Table ) with the help of this SDK.

Precheck

Refer to the official HackerEarth API v2 Guide for the details on using the API effectively.

Install

npm install he-sdk-nodejs

Require

var he = require('he-sdk-nodejs');

Configure

Fetch your client secret from the HackerEarth API Dashboard

var settings = {
    'client_secret': 'type your client secret' ,
    'async': 0 ,
    'lang': 'CSHARP' ,
    'time_limit': 5,
    'memory_limit': 262144
};

API

Input your source program as a string like this

var source = "using System;class MyClass{static void Main(string[] args) {System.Console.WriteLine(\"Hello World!\\n\");}}";

or input the program from a source file by mentioning the file path like this

var filepath = "E:\\E\\temporary files\\MyClass.cs";

compile(settings , source , callback)

he.compile(settings , source , function(err , result){
    console.log(result);
});

run(settings , source , callback)

he.run(settings , source , function(err , result){
    console.log(result);
});

compileFile(settings , filepath , callback)

he.compileFile(settings , filepath , function(err,result){
    console.log(result);
});

runFile(settings , filepath , callback)

he.runFile(settings , filepath , function(err,result){
    console.log(result);
});

Help

This package lets you compile code belonging to various programming languages via the HackerEarth API. However, If you want to implement your own code compiling server , you may take a look at compilex

Samples

Here are few samples built with this SDK. If you have got one , feel free to add it here and send a pull request or contact me.

Contributing

Contributions are more than welcomed ! You can

  • Report a Bug
  • Write Tests
  • Help write the command line package using this SDK
  • Write an Example app and spread the word.

Disclaimer

The HackerEarth API v2 is a copyright of HackerEarth Inc. and this is an unofficial SDK that acts as wrapper for accessing the service provided by HackerEarth Inc.

License

This repository is licensed under the MIT License .