# cs558-submission-handler

> Handles student submitted tar.gz assignments.

Latest version **1.0.0** (published 2013-09-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install cs558-submission-handler
pnpm add cs558-submission-handler
yarn add cs558-submission-handler
bun add cs558-submission-handler
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2013-09-02 |
| First published | 2013-09-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Alexander Durgin |
| Maintainers | amdurgin |

## Links

- npm: https://www.npmjs.com/package/cs558-submission-handler
- Repository: https://github.com/amdurgin/cs558-submission-handler
- Issues: https://github.com/amdurgin/cs558-submission-handler/issues
- npm.io page: https://npm.io/package/cs558-submission-handler

## Dependencies (1)

- [tar.gz](https://npm.io/package/tar.gz.md) *

## Recent versions

- 1.0.0 (latest) — 2013-09-02

## README

cs558-submission-handler
=======================

Handles unpacking submissions properly and in the right place.

Usage:
```javascript
//The module exposes a single function, a constructor for a ClassSrcHandler object.
//Which takes one argument, path to the top of the submission src directory.
var createSrcHandler = require("cs558-submission-handler");

var srcHandler = createSrcHandler(pathToSubmissions);

//This object in turn only exposes one function, extract(), which takes 
//as arguments, in order, the student's name, the assignment number, the 
//attempt number, the raw tar.gz buffer, and a callback which if there is
//an error will receive an error string as its first argument, otherwise it 
//is null, and the second argument is the path to the source unpacked...
srcHandler.extract(studentName, assignmentNumber, attemptNumber, targzBuff, function(err, val){
  if(err){
    //error extracting
  }else{
    //successfully unpacked submission, val = pathToUnpackedSubmission
  }
});
```

---
_Source: https://npm.io/package/cs558-submission-handler · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
