Class TYPE

infringementSettings

warningSettings

StaticInfringement

StaticparamValueRequests

reportFieldInfringement

• reportFieldInfringement(
      message: string,
      target: object,
      path: string,
      key: string,
      value: unknown,
  ): undefined

  Reports a field-infringement via reportInfringement also generating a proper string-wrapper for the given message & name.

  Parameters

  • message: string

    A string describing the infringement and it's provenience.
  • target: object
  • path: string

    The dotted-path string that leads to the value not fulfilling the contract starting from the tagged one.
  • key: string

    The property key.
  • value: unknown

    The value not fulfilling a contract.

  Returns undefined

reportParameterInfringement

• reportParameterInfringement(
      message: string,
      target: object,
      path: string,
      method: string,
      index: number,
      value: unknown,
  ): undefined

  Reports a parameter-infringement via reportInfringement also generating a proper string-wrapper for the given "message","method", parameter-"index" & value.

  Parameters

  • message: string

    The string describing the infringement and it's provenience.
  • target: object
  • path: string
  • method: string

    The string describing or naming the violator.
  • index: number

    The index of the parameter within the argument listing.
  • value: unknown

    The parameter's value.

  Returns undefined

reportReturnvalueInfringement

• reportReturnvalueInfringement(
      message: string,
      target: object,
      path: string,
      method: string,
      value: any,
  ): void

  Reports a returnvalue-infringement according via reportInfringement also generating a proper string-wrapper for the given "message","method" & value.

  Parameters

  • message: string

    The string describing the infringement and it's provenience.
  • target: object
  • path: string
  • method: string

    The string describing or naming the violator.
  • value: any

    The parameter's value.

  Returns void

StaticdecInvariant

• decInvariant(
      contracts: { check: (toCheck: unknown) => string | boolean }[],
      path?: string,
      dbc?: string,
  ): (target: unknown, propertyKey: string | symbol) => void

  A property-decorator factory serving as a Design By Contract Invariant. Since the value must be initialized or set according to the specified contracts the value will only be checked when assigning it.

  Parameters

  • contracts: { check: (toCheck: unknown) => string | boolean }[]

    The DBC-Contracts the value shall uphold.
  • path: string = undefined
  • dbc: string = "WaXCode.DBC"

  Returns (target: unknown, propertyKey: string | symbol) => void

  Throws

  A DBC.Infringement whenever the property is tried to be set to a value that does not comply to the specified contracts, by the returned method.

StaticdecPostcondition

• decPostcondition(
      check: (toCheck: any, object: any, string: any) => string | boolean,
      dbc: string,
      path?: string,
  ): (
      target: object,
      propertyKey: string,
      descriptor: PropertyDescriptor,
  ) => PropertyDescriptor

  A method decorator factory checking the result of a method whenever it is invoked thus also usable on getters.

  Parameters

  • check: (toCheck: any, object: any, string: any) => string | boolean

    The (toCheck: any, object, string) => boolean | string to use for checking.
  • dbc: string

    See DBC.resolveDBCPath.
  • path: string = undefined

    The dotted path referring to the actual value to check, starting form the specified one.

  Returns (
      target: object,
      propertyKey: string,
      descriptor: PropertyDescriptor,
  ) => PropertyDescriptor

  The ( target : object, propertyKey : string, descriptor : PropertyDescriptor ) : PropertyDescriptor invoked by Typescript.

StaticParamvalueProvider

• ParamvalueProvider(
      target: object,
      propertyKey: string,
      descriptor: PropertyDescriptor,
  ): PropertyDescriptor

  A method-decorator factory checking the paramValueRequests for value-requests of the method's parameter thus also usable on setters. When found it will invoke the "receptor" registered there, inter alia by requestParamValue, with the parameter's value.

  Parameters

  • target: object

    The object hosting the tagged method as provided by the runtime.
  • propertyKey: string

    The tagged method's name as provided by the runtime.
  • descriptor: PropertyDescriptor

    The PropertyDescriptor as provided by the runtime.

  Returns PropertyDescriptor

  The PropertyDescriptor that was passed by the runtime.

Staticresolve

• resolve(toResolveFrom: unknown, path: string): unknown

  Resolves the desired object out a given one toResolveFrom using the specified path.

  Parameters

  • toResolveFrom: unknown

    The object starting to resolve from.
  • path: string

    The dotted path-string. This string uses ., [...], and () to represent accessing nested properties, array elements/object keys, and calling methods, respectively, mimicking JavaScript syntax to navigate an object's structure. Code, e.g. something like a.b( 1 as number ).c, will not be executed and thus make the retrieval fail.

  Returns unknown

  The requested object, NULL or UNDEFINED.

StaticresolveDBCPath

• resolveDBCPath(obj: any, path: any): DBC

  Resolves the specified dotted string-path to a DBC.

  Parameters

  • obj: any

    The object to start resolving from.
  • path: any

    The dotted string-path leading to the DBC.

  Returns DBC

  The requested DBC.