scratchfoundation/scratch-parser
1
0
Fork 0
mirror of https://github.com/scratchfoundation/scratch-parser.git synced 2025-08-28 22:18:45 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs($index): Documentation for new zip returning functionality of main api function.

Browse source
This commit is contained in:
Karishma Chadha 2018-03-15 18:30:54 -04:00
parent 7f8672dfbc
commit b7c1cfd347
1 changed files with 2 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

3
index.js
View file

@ -7,7 +7,8 @@ var analyze = require('./lib/analyze');
/**
* Unpacks, parses, validates, and analyzes Scratch projects. If successful,
* will return a valid Scratch project object with appended metadata.
* will return a valid Scratch project object with appended metadata, as well
* as the unpacked zip object if originally provided.
*
* @param {Buffer | string} Input buffer or string representing scratch project
*