Options
All
  • Public
  • Public/Protected
  • All
Menu

Mendix Model SDK

Index

Modules

Type aliases

Evaluatable

Evaluatable: expressions.MxExpression | expressions.MxFeatureCall

Union/sum type to be able to recurse over types other than MxExpression. This should match with ExpressionsTypesHelper#evaluatableTypes in the Model SDK generator.

IAbstractUnitConstructor

IAbstractUnitConstructor: ModelUnit | AbstractUnit

IChecksResolver

IChecksResolver: function

Type declaration

    • (qualifiedStructureName: string): ICheck[]

    • Parameters

      • qualifiedStructureName: string

      Returns ICheck[]

IEditorData

IEditorData: object

Type declaration

  • [mmVersion: string]: object
    • pageTemplates: string

IElementConstructor

IElementConstructor: Element

IQueryMap

IQueryMap: object

Type declaration

  • [qualifiedTypeName: string]: object

IQueryResolver

IQueryResolver: function

Type declaration

    • (queryName: string, qualifiedStructureName: string): IQuery

    • Parameters

      • queryName: string
      • qualifiedStructureName: string

      Returns IQuery

ISuperTypeMap

ISuperTypeMap: object

Type declaration

  • [qualifiedTypeName: string]: string

IteratorLambda

IteratorLambda: function

Algebraic data type (!) of (ostensibly: iterator-)functions/lambdas taking a value and its previous value of a list, with previousValue === null for the head list item.

Type declaration

    • (value: T, index: number, array: Array<T>): R

    • Parameters

      • value: T
      • index: number
      • array: Array<T>

      Returns R

ModelSdkClient

ModelSdkClient: ModelSdkClientImpl<IModel, Model>

Variables

SDK_VERSION

SDK_VERSION: string

Current SDK version: 2.8.1

loadChecks

loadChecks: function

Type declaration

loadQueries

loadQueries: function

Type declaration

    • (): object

    • Returns object

      • [qualifiedTypeName: string]: object

loadSuperTypes

loadSuperTypes: function

Type declaration

    • (): object

    • Returns object

      • [qualifiedTypeName: string]: string

standardIterators

standardIterators: object

Type declaration

  • [name: string]: function

standardLibraryMethods

standardLibraryMethods: object

Type declaration

  • [name: string]: function
      • (source: any | void, args: any[] | void): any

      • Parameters

        • source: any | void
        • args: any[] | void

        Returns any

Functions

calculateMessage

createInVersionCheck

  • createInVersionCheck(model: IAbstractModel, typeName: string, allowedVersions: string[]): void

  • Parameters

    Returns void

evaluateCheck

evaluateCheckBody

evaluateExpression

isNotBefore

  • Parameters

    Returns boolean

isNothing

  • isNothing(arg: any): boolean

  • Checks whether the argument is "nothing", i.e. either undefined or null.

    Parameters

    • arg: any

    Returns boolean

lookupByVersion

  • lookupByVersion<T>(versionedThings: T[], mmVersion: Version): T

  • Type parameters

    Parameters

    • versionedThings: T[]
    • mmVersion: Version

    Returns T

makeChecksResolver

makeQueryResolver

parseAsNormalizedVersion

  • parseAsNormalizedVersion(versionString: string): Version

  • Parses the given string as a sem-Version, ignoring non-numeric and "extra" data, and padding with ".0" where necessary.

    Parameters

    • versionString: string

    Returns Version

runChecksOn

validateSyntax

  • validateSyntax(name: string): string | void

  • Validates the name syntactically without looking at the context (so no uniqueness check).

    Parameters

    • name: string

    Returns string | void

    with error message or null in which case name is valid.

Generated using TypeDoc