Comments/Documentation

This commit is contained in:
n1073645 2020-01-06 09:35:38 +00:00
parent 72a76e098b
commit ac2b9d1d33
2 changed files with 10 additions and 2 deletions

View file

@ -4,7 +4,7 @@ import Recipe from "../Recipe.mjs";
import Dish from "../Dish.mjs";
import {detectFileType} from "./FileType.mjs";
import chiSquared from "chi-squared";
import potentialOps from "./Test.mjs";
import potentialOps from "./MagicObject.mjs";
import { isType } from "./FileType.mjs";
/**

View file

@ -1,11 +1,12 @@
import OperationConfig from "../config/OperationConfig.json";
/**
*
* An object used by magic to store the input/output criteria for valid operation results.
*/
class potentialOps {
/**
* PotentialOps constructor.
*
* @param prevOp
*/
@ -24,6 +25,7 @@ class potentialOps {
}
/**
* Sets the output regexes for the operation.
*
* @param outputRegexes
*/
@ -33,6 +35,7 @@ class potentialOps {
}
/**
* Sets the input regexes for the operation.
*
* @param inputRegexes
*/
@ -42,14 +45,19 @@ class potentialOps {
}
/**
* Returns the operations input regexes.
*
* @returns {Object[]}
*/
getInputRegexes () {
console.log(typeof this.inputRegexes);
return this.inputRegexes;
}
/**
* Returns the operations output regexes.
*
* @returns {Object[]}
*/
getOutputRegexes () {
return this.outputRegexes;