From 17eef58b5c66c066939b5e5d600e5ec451a6f39d Mon Sep 17 00:00:00 2001 From: Julian Pollinger Date: Thu, 24 Aug 2023 11:32:55 +0200 Subject: [PATCH] docs: update documentation --- .../docs/types/DatabaseConfig.html | 65 ++++++++++++ .../implementation/functions/evaluateAll.html | 91 +++++++++++++++++ .../functions/mapArgumentsToJSONReady.html | 93 ++++++++++++++++++ .../implementation/functions/parseDate.html | 90 +++++++++++++++++ .../implementation/functions/setLogger.html | 84 ++++++++++++++++ .../types/EvaluationDetails.html | 88 +++++++++++++++++ .../types/EvaluationResult.html | 98 +++++++++++++++++++ .../implementation/types/FormulaResults.html | 75 ++++++++++++++ .../implementation/types/PluginClass.html | 93 ++++++++++++++++++ .../implementation/variables/logger-1.html | 75 ++++++++++++++ .../implementation/variables/version.html | 75 ++++++++++++++ .../docs/types/DatabaseConfig.html | 65 ++++++++++++ 12 files changed, 992 insertions(+) create mode 100644 docs/persistent-rita/docs/types/DatabaseConfig.html create mode 100644 docs/rita-core/docs/implementation/functions/evaluateAll.html create mode 100644 docs/rita-core/docs/implementation/functions/mapArgumentsToJSONReady.html create mode 100644 docs/rita-core/docs/implementation/functions/parseDate.html create mode 100644 docs/rita-core/docs/implementation/functions/setLogger.html create mode 100644 docs/rita-core/docs/implementation/types/EvaluationDetails.html create mode 100644 docs/rita-core/docs/implementation/types/EvaluationResult.html create mode 100644 docs/rita-core/docs/implementation/types/FormulaResults.html create mode 100644 docs/rita-core/docs/implementation/types/PluginClass.html create mode 100644 docs/rita-core/docs/implementation/variables/logger-1.html create mode 100644 docs/rita-core/docs/implementation/variables/version.html create mode 100644 persistent-rita/docs/types/DatabaseConfig.html diff --git a/docs/persistent-rita/docs/types/DatabaseConfig.html b/docs/persistent-rita/docs/types/DatabaseConfig.html new file mode 100644 index 0000000..f01bcb7 --- /dev/null +++ b/docs/persistent-rita/docs/types/DatabaseConfig.html @@ -0,0 +1,65 @@ +DatabaseConfig | Persistent Rita - v5.0.0
+
+ +
+
+
+
+ +

Type alias DatabaseConfig

+
DatabaseConfig: {
    database: string;
    host: string;
    password?: string;
    port?: number;
    username?: string;
}
+
+

Type declaration

+
    +
  • +
    database: string
    • +
  • +
    host: string
    • +
  • +
    Optional password?: string
    • +
  • +
    Optional port?: number
    • +
  • +
    Optional username?: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/rita-core/docs/implementation/functions/evaluateAll.html b/docs/rita-core/docs/implementation/functions/evaluateAll.html new file mode 100644 index 0000000..b77e1d8 --- /dev/null +++ b/docs/rita-core/docs/implementation/functions/evaluateAll.html @@ -0,0 +1,91 @@ +evaluateAll | @educorvi/rita
+
+ +
+
+
+
+ +

Function evaluateAll

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/rita-core/docs/implementation/functions/mapArgumentsToJSONReady.html b/docs/rita-core/docs/implementation/functions/mapArgumentsToJSONReady.html new file mode 100644 index 0000000..0ad7eec --- /dev/null +++ b/docs/rita-core/docs/implementation/functions/mapArgumentsToJSONReady.html @@ -0,0 +1,93 @@ +mapArgumentsToJSONReady | @educorvi/rita
+
+ +
+
+
+
+ +

Function mapArgumentsToJSONReady

+
+
    + +
  • +

    A function that is supposed to be used as argument for the Array.map() function, to map arguments to their rita-json ready counterparts.

    +
    +
    +

    Parameters

    +
      +
    • +
      item: string | number | Date | Formula
      +

      The item to be mapped

      +
      +
    +

    Returns string | number | Record<string, any>

    +
    +

    Example

         const jsonArguments = someCalculation.arguments.map(mapParameterToJSONReady);
+
    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/rita-core/docs/implementation/functions/parseDate.html b/docs/rita-core/docs/implementation/functions/parseDate.html new file mode 100644 index 0000000..f8a59cb --- /dev/null +++ b/docs/rita-core/docs/implementation/functions/parseDate.html @@ -0,0 +1,90 @@ +parseDate | @educorvi/rita
+
+ +
+
+
+
+ +

Function parseDate

+
+
    + +
  • +

    Parses the date in the argument string. Throws an exception if date can not be parsed

    +
    +
    +

    Parameters

    +
      +
    • +
      val: string
      +

      the string to be parsed

      +
      +
    +

    Returns Date

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/rita-core/docs/implementation/functions/setLogger.html b/docs/rita-core/docs/implementation/functions/setLogger.html new file mode 100644 index 0000000..d84070a --- /dev/null +++ b/docs/rita-core/docs/implementation/functions/setLogger.html @@ -0,0 +1,84 @@ +setLogger | @educorvi/rita
+
+ +
+
+
+
+ +

Function setLogger

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/rita-core/docs/implementation/types/EvaluationDetails.html b/docs/rita-core/docs/implementation/types/EvaluationDetails.html new file mode 100644 index 0000000..505a95c --- /dev/null +++ b/docs/rita-core/docs/implementation/types/EvaluationDetails.html @@ -0,0 +1,88 @@ +EvaluationDetails | @educorvi/rita
+
+ +
+
+
+
+ +

Type alias EvaluationDetails

+
EvaluationDetails: {
    id: string;
    result: boolean;
}
+
+

Type declaration

+
    +
  • +
    id: string
    +

    The ID of the rule

    +
    +
    • +
  • +
    result: boolean
    +

    The result of the rule

    +
    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/rita-core/docs/implementation/types/EvaluationResult.html b/docs/rita-core/docs/implementation/types/EvaluationResult.html new file mode 100644 index 0000000..8e8330f --- /dev/null +++ b/docs/rita-core/docs/implementation/types/EvaluationResult.html @@ -0,0 +1,98 @@ +EvaluationResult | @educorvi/rita
+
+ +
+
+
+
+ +

Type alias EvaluationResult

+
EvaluationResult: {
    counts: {
        false: number;
        true: number;
    };
    details: EvaluationDetails[];
    result: boolean;
}
+
+

Type declaration

+
    +
  • +
    counts: {
        false: number;
        true: number;
    }
    +

    Amount of rules that were evaluated to true or false respectively.

    +
    +
    +
      +
    • +
      false: number
      • +
    • +
      true: number
    • +
  • +
    details: EvaluationDetails[]
    +

    The results for every rule

    +
    +
    • +
  • +
    result: boolean
    +

    The result of all rules combined (combined by logical "and")

    +
    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/rita-core/docs/implementation/types/FormulaResults.html b/docs/rita-core/docs/implementation/types/FormulaResults.html new file mode 100644 index 0000000..613af5d --- /dev/null +++ b/docs/rita-core/docs/implementation/types/FormulaResults.html @@ -0,0 +1,75 @@ +FormulaResults | @educorvi/rita
+
+ +
+
+
+
+ +

Type alias FormulaResults

+
FormulaResults: boolean | Date | number | string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/rita-core/docs/implementation/types/PluginClass.html b/docs/rita-core/docs/implementation/types/PluginClass.html new file mode 100644 index 0000000..37d92b7 --- /dev/null +++ b/docs/rita-core/docs/implementation/types/PluginClass.html @@ -0,0 +1,93 @@ +PluginClass | @educorvi/rita
+
+ +
+
+
+
+ +

Type alias PluginClass

+
PluginClass: (new (options, childFormula) => Plugin)
+
+

Type declaration

+
    +
  • +
      +
    • new (options, childFormula): Plugin
      • +
    • +

      Type of class that extends Plugin

      +
      +
      +

      Parameters

      +
        +
      • +
        options: Record<any, any>
        • +
      • +
        childFormula: undefined | Formula
      +

      Returns Plugin

      +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/rita-core/docs/implementation/variables/logger-1.html b/docs/rita-core/docs/implementation/variables/logger-1.html new file mode 100644 index 0000000..c815b48 --- /dev/null +++ b/docs/rita-core/docs/implementation/variables/logger-1.html @@ -0,0 +1,75 @@ +logger | @educorvi/rita
+
+ +
+
+
+
+ +

Variable logger

+
logger: Logger = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/rita-core/docs/implementation/variables/version.html b/docs/rita-core/docs/implementation/variables/version.html new file mode 100644 index 0000000..14a774f --- /dev/null +++ b/docs/rita-core/docs/implementation/variables/version.html @@ -0,0 +1,75 @@ +version | @educorvi/rita
+
+ +
+
+
+
+ +

Variable versionConst

+
version: undefined | string = process.env.VERSION
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/persistent-rita/docs/types/DatabaseConfig.html b/persistent-rita/docs/types/DatabaseConfig.html new file mode 100644 index 0000000..f01bcb7 --- /dev/null +++ b/persistent-rita/docs/types/DatabaseConfig.html @@ -0,0 +1,65 @@ +DatabaseConfig | Persistent Rita - v5.0.0
+
+ +
+
+
+
+ +

Type alias DatabaseConfig

+
DatabaseConfig: {
    database: string;
    host: string;
    password?: string;
    port?: number;
    username?: string;
}
+
+

Type declaration

+
    +
  • +
    database: string
    • +
  • +
    host: string
    • +
  • +
    Optional password?: string
    • +
  • +
    Optional port?: number
    • +
  • +
    Optional username?: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file