Class EvaluateParameters_NamedIgnorableParamaters

constructor

• new EvaluateParameters_NamedIgnorableParamaters(
      parameters: evaluateParametersParameter[],
  ): Globals.modules.cmds.EvaluateParameters_NamedIgnorableParamaters

  Creates a new instance of the EvaluateParameters_NamedIgnorableParamaters class.

  Parameters

  • parameters: evaluateParametersParameter[]

    The parameters to extract named ignorable parameters from.

  Returns Globals.modules.cmds.EvaluateParameters_NamedIgnorableParamaters

parameters

applyDetectedValuesToArgsObject

• applyDetectedValuesToArgsObject<
      T extends [evaluateParametersParameter]
      | evaluateParametersParameter[],
      UOAT extends boolean = false,
  >(
      args: UOAT extends true
          ? EvaluateParemtersResultArgs_basic<T>
          : EvaluateParemtersResultArgs_v2_KeyedOnly<
              T,
              IncludeFromTuple<T, objectEvaluateParametersParameter & { key: string }> extends (
                  objectEvaluateParametersParameter & { key: string }
              )[]
                  ? IncludeFromTuple<
                      T,
                      objectEvaluateParametersParameter & { key: string },
                  >
                  : (objectEvaluateParametersParameter & { key: string })[],
          > & EvaluateParemtersResultArgs_v2_TupleOnly<
              T,
              ExcludeFromTuple<T, objectEvaluateParametersParameter & { key: string }>,
          >,
  ): void

  Applies the detected values to the args object.

  This function mutates the object passed in to the args parameter.

  Type Parameters

  • T extends [evaluateParametersParameter] | evaluateParametersParameter[]

    The paramter types.
  • UOAT extends boolean = false

    If the old args return type should be used. Default is false.

  Parameters

  • args: UOAT extends true
        ? EvaluateParemtersResultArgs_basic<T>
        : EvaluateParemtersResultArgs_v2_KeyedOnly<
            T,
            IncludeFromTuple<T, objectEvaluateParametersParameter & { key: string }> extends (
                objectEvaluateParametersParameter & { key: string }
            )[]
                ? IncludeFromTuple<
                    T,
                    objectEvaluateParametersParameter & { key: string },
                >
                : (objectEvaluateParametersParameter & { key: string })[],
        > & EvaluateParemtersResultArgs_v2_TupleOnly<
            T,
            ExcludeFromTuple<T, objectEvaluateParametersParameter & { key: string }>,
        >

    The args array to apply the detected values to.

  Returns void

getValidNamedParametersForIndex

• getValidNamedParametersForIndex(
      index: number,
  ): Globals.modules.cmds.EvaluateParameters_NamedIgnorableParamater[]

  Gets the sibling named ignorable parameters for an index.

  Parameters

  • index: number

    The index to get the named ignorable parameters for.

  Returns Globals.modules.cmds.EvaluateParameters_NamedIgnorableParamater[]

  The named ignorable parameters for the index.

  Throws

  If the index is less than 0 or greater than or equal to the number of parameters.

  Description

  It splits up the list of ignorable parameters into chunks, separated by indexes of parameters that are not ignorable parameters.

  It then returns the chunk that the index is in.