Skip to main content
Version Pentaho
Hitachi Vantara Lumada and Pentaho Documentation

ArgumentRangeError

  1. Last updated
  2. Save as PDF

pentaho.lang.ArgumentRangeError

The ArgumentRangeError class is the class of errors for a function's argument that was specified with a value of one of the expected types, albeit not within the expected range.

The name of the argument can be that of a nested property. For example: "keyArgs.description".

AMD Module 

require(["pentaho/lang/ArgumentRangeError"], function(ArgumentRangeError) { /* code goes here */ });

Extends

Constructor

Name Description
new ArgumentRangeError(name)

Creates an out of range argument error object.

Members

Name Description
name : string

The name of the type of error.

Constructor Details

new ArgumentRangeError(name)

Creates an out of range argument error object.

Source: javascript/web/pentaho/lang/ArgumentRangeError.js, line 24

Parameters:
Name Default Value Summary
name : string

The name of the argument.

Example

define(["pentaho/lang/ArgumentRangeError"], function(ArgumentRangeError) {

 function insertAt(element, index) {

 if(index < 0 || index > this.length) {
 throw new ArgumentRangeError("index");
 }

 // Safe to insert at index
 this._elements.splice(index, 0, element);
 }

 // ...
});

Members Details

name: string

The name of the type of error.

Source: javascript/web/pentaho/lang/ArgumentRangeError.js, line 70

Default Value: "ArgumentRangeError"

Overrides: pentaho.lang.ArgumentError#name