Options
All
  • Public
  • Public/Protected
  • All
Menu

@mavenomics/mql

Index

Modules

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

Antlr4Error

Antlr4Error: object

Type declaration

CompiledJsFunc

CompiledJsFunc: function

Type declaration

    • (globals: any, userContext: any, values: any[]): any

    • Parameters

      • globals: any
      • userContext: any
      • values: any[]

      Returns any

MqlCallback

MqlCallback<T>: function

Type parameters

  • T

Type declaration

    • (this: void, err?: Error, result?: T): void

    • Parameters

      • this: void
      • Optional err: Error
      • Optional result: T

      Returns void

QueryFunctionEval

QueryFunctionEval: function

Type declaration

    • (funcName: string, args: any): any

    • Parameters

      • funcName: string
      • args: any

      Returns any

ResultSelector

ResultSelector: function

Type declaration

    • Parameters

      Returns any | Promise<any>

Variables

Const fexpr

fexpr: MqlExprFunction = MqlExprFunction

Const mql

mql: (Anonymous function) = RunMqlTemplate({})

Functions

CreateJsFunc

  • CreateJsFunc(codeText: string, names: string[]): (Anonymous function)

  • Parameters

    • codeText: string
    • names: string[]

    Returns (Anonymous function)

FindFunctionInfo

FunctionFactory

  • FunctionFactory(name: string): Promise<IFunction>

GetAllFunctions

  • GetAllFunctions(): Promise<object>

GetBuiltinFunctionInfo

GetFunctionList

  • GetFunctionList(): Promise<string[]>

MqlWrapper

  • MqlWrapper(evalFn: IMqlEvalFunction, __namedParameters: object, args?: object[], docs?: object): IFunction

  • This is a helper method to let you expose a simple function to MQL.

    This will automatically take care of decorators and factory registration.

    export

    Parameters

    • evalFn: IMqlEvalFunction

      The lambda to execute

    • __namedParameters: object
    • Default value args: object[] = []
    • Default value docs: object = {}

    Returns IFunction

    An IFunction constructor. Usually you don't need to do anything with it.

PositionalToKeyValue

RegisterFunction

  • RegisterFunction(name: string, func: any): void

RunMql

VerifyPositionalArgumentTypes

  • VerifyPositionalArgumentTypes(args: Type[], func: FunctionInfo): Type[]

declareFunction

  • declareFunction(name?: string, repeatingArgs?: number, returnType?: Type, returnDescription?: string): (Anonymous function)

  • Parameters

    • Default value name: string = void 0
    • Default value repeatingArgs: number = 0
    • Default value returnType: Type = Types.Any
    • Optional returnDescription: string

    Returns (Anonymous function)

documentFunction

  • documentFunction(__namedParameters: object): (Anonymous function)

evaluateRowOptionsFast

  • evaluateRowOptionsFast(_dont_care: unknown, options: any, mapFunc?: function): any
  • deprecated

    Remove this function

    Parameters

    • _dont_care: unknown
    • options: any
    • Optional mapFunc: function
        • (o: any): any

        • Parameters

          • o: any

          Returns any

    Returns any

functionArg

  • functionArg(name?: string, type?: Type, defValue?: any, description?: string): (Anonymous function)

  • Parameters

    • Default value name: string = null
    • Default value type: Type = Types.Any
    • Default value defValue: any = void 0
    • Optional description: string

    Returns (Anonymous function)

parseDefinitions

  • parseDefinitions(text: string): any

parseQuery

  • parseQuery(text: string): Query

Generated using TypeDoc