Skip to content

Commit

Permalink
fix types typos
Browse files Browse the repository at this point in the history
  • Loading branch information
mathe42 committed Apr 23, 2020
1 parent 76b9f01 commit 004d605
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions src/types.ts
Expand Up @@ -44,19 +44,19 @@ type RunJSFunc = (o: {

export type UserOptions = {
/**
* template as a NodeJS Buffer or Buffer like Object
* template as a NodeJS Buffer or Buffer-like object in Browsers
*/
template: Buffer;
/**
* Object of Data to be injected or a (async) Function that resolves to the Data. The function gets as a Argument the contens of the QUERY Command
* Object of data to be injected or a (async) function that resolves to the data. The function gets as a argument the contens of the QUERY command as a string.
*/
data?: ReportData | QueryResolver;
/**
* TODO: dont know what this option is for
*/
queryVars?: any;
/**
* Define a custom Command delimeter this can be a String e.g. '+++' or a Array of Strings with length 2: ['{', '}'] with first element as the start delimeter and the scond as the end delimeter
* Define a custom command delimeter this can be a String e.g. '+++' or a Array of Strings with length 2: ['{', '}'] with first element as the start delimeter and the second as the end delimeter
*/
cmdDelimiter?: string | [string, string];
/**
Expand All @@ -68,15 +68,16 @@ export type UserOptions = {
*/
processLineBreaks?: boolean; // true by default
/**
* Template and data is SAVE and TRUSTED. Set this option to true to disable running all Commands in a new JS vm.
* Template and data is SAVE and TRUSTED. Set this option to true to disable running all commands in a new JS-VM.
*/
noSandbox?: boolean;
/**
* Custom Sandbox Options see Documentation for mor details
* Custom sandbox see documentation for mor details
*/
runJs?: RunJSFunc;
/**
* Add Function or other static Data to this option to have access to it in your commands
* Add functions or other static data to this option to have access to it in your commands
*
* ```js
* additionalJsContext: {
* qrCode: url => {
Expand Down

0 comments on commit 004d605

Please sign in to comment.