piston-js v0.0.6

A JavaScript client for Piston-Batch, A fork from Piston, a high performance general purpose code execution engine that supports batch submissions and code evaluation.

Contains Full TypeScript Typings

Installation

$ npm install piston-js

Basic Usage

import Piston from 'piston-js';

(async () => {
  const piston = new Piston('https://pistonserver.com');
  try {
    const result: SubmissionResult = await piston.run({
      language: {
        name: 'python',
        version: '3.9.1',
      },
      fileName: 'main.py',
      sourceCode: 'print(int(input())*3)',
      input: ['2'],
      expectedOutput: ['4'],
    });
    console.log(result);
    /*{
     run: [ { stdout: '6', stderr: '', code: 0, signal: null, stdin: '2' } ],
     verdict: { status: 'WA', stdout: '6', stdin: '2', expected_output: '4' }
    } */
  } catch (err) {
    console.log(err.response.data);
  }
})();

API

Piston(config: PistonConfig) : Piston

Returns an instance of Piston

PistonConfig

An object type representing the config for the Piston instance

properties

Piston.run(submission: Submission) : Promise< SubmissionResult>

Runs a submission and returns the result

Submission

An object representing a submission

properties

Language

Type of Language required in Submission

properties

SubmissionResult

An object representing the result of a Submission

properties

ProcessOutput

Type of an execution process output

properties

BatchResult

Type of an execution process output

properties

• A submission is considered a failed submission in the batch if its Verdict is not accepted (AC)
• If a submission batch is accepted, stdout and stdin will have the results of the first submission in the batch

Verdict

An enum representing the verdict of a submission as strings