Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
terrorparser
Advanced tools
Readme
/**/// Public: function_name
/**///
/**/// Args
/**/// arg1 - the_arg_value
/**/// arg2 - the_arg_value
/**///
/**/// Returns
/**/// return - the_return_value
/**///
/**/// Notes
/**/// note - note_about_the_function
/**/// notes_can_be_multiline
npm install terrorparser
var TerrorParser = require('terrorparser')
// assume its being used in an express site
/*
* POST home page.
*/
app.post('/', function(req, res) {
var postData = ''
req.addListener("data", function(postDataChunk) {
postData += postDataChunk
})
req.addListener("end", function() {
console.log('[ POST EVENT RECEIVED ]')
var data = TerrorParser(postData)
// Now you have a array of parsed objects stored in the data var
// If there were no TerrorDoc headers data will = null
})
})
[ { privPub: 'Private',
name: 'startsWith',
argList:
[ 'str - string to test against',
'pattern - string pattern to check at beginning of str' ],
ret: 'return - boolean value of pattern match result',
notes: '' },
{ privPub: 'Private',
name: 'buildParsed',
argList:
[ 'lines - array of all lines',
'pos - array of positions that lines contains the pattern' ],
ret: '',
notes: 'note - fills docList array by building section objects based on parsing rules' },
{ privPub: 'Private',
name: 'parser',
argList: [ 'str - string value of the entire file contents' ],
ret: '',
notes: 'Note - parses each line for TerrorDoc pattern and sends matching lines to buildParsed' },
{ privPub: 'Public',
name: 'TerrorParser',
argList: [ 'fileContents - string of the read file' ],
ret: 'return - docList containing section objects',
notes: '' }
]
npm install
npm test
Q: Why not just use JsDoc?
A: I didn't know it existed before I started using my style...... I'm new....
Q: Do I need this?
A: No. Not unless you happen to think my /**/// is pretty sweet looking like I do....
##License
HAHAHAHAHA
MIT
FAQs
Document Generator For My Style Of Doc
The npm package terrorparser receives a total of 6 weekly downloads. As such, terrorparser popularity was classified as not popular.
We found that terrorparser demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.