- fs
Quizam. A no-fuss yaml CLI quiz runner.
- init()
Initialise a quiz. Asks for name and author then writes ./quizam.yaml.
- cleanse(str)
Helper function to clean strings for comparisons.
- select(quiz) ⇒
Object Select handles a question with option set and one answer.
- multi(quiz) ⇒
Object Handles a multiselect question.
- input(quiz) ⇒
Object Handle question requiring input.
- run()
The main run function. It will pass for all .js files in the recursive function and not in the folders specified and generate documentation if it can.
Quizam. A no-fuss yaml CLI quiz runner.
Kind: global variable
Author: Dennis O'Keeffe
Initialise a quiz. Asks for name and author then writes ./quizam.yaml.
Helper function to clean strings for comparisons.
Kind: global function
| Param | Type |
|---|---|
| str | * |
Select handles a question with option set and one answer.
Kind: global function
Returns: Object - Prompts function
| Param | Type | Description |
|---|---|---|
| quiz | * |
Select question object |
Handles a multiselect question.
Kind: global function
Returns: Object - Prompts function
| Param | Type | Description |
|---|---|---|
| quiz | * |
Multiselect question object |
Handle question requiring input.
Kind: global function
Returns: Object - Prompts object
| Param | Type | Description |
|---|---|---|
| quiz | * |
Input question object |
The main run function. It will pass for all .js files in the recursive function and not in the folders specified and generate documentation if it can.
Kind: global function