Throw

Throws a developer-specified exception, which can be caught with a catch block.

Method Signature

Throw(message=[any], type=[String], detail=[String], errorcode=[String], extendedinfo=[any], object=[Throwable])

Arguments

Argument

Type

Required

Description

Default

message

any

false

Message that describes exception event

type

String

false

The type of the exception

detail

String

false

Description of the event

errorcode

String

false

A custom error code that you supply

extendedinfo

any

false

Additional custom error data that you supply

object

Throwable

false

An instance of an exception object. If there is no message provided, this object will be thrown directly. If there is a message, a CustomException will be thrown and this object will be used as the cause.

Examples

Throw a custom exception

Use the throw function to throw a custom application exception.

<bx:script>
	throw( type="MyCustomError", message="A custom error has been thrown!" );
</bx:script>

Throw a custom http response exception

Use the throw function to throw a custom exception when the http response is invalid.

if( !isJSON( httpResponse.FILECONTENT ) ) {
	throw( type="InvalidHTTPResponse", message="The http response was not valid JSON" );
}

Additional Examples

// thrown as a statement example
try {
	throw "thrown";
} catch ( e) {
	dump( var=bxcatch, label="single argument keyword" );
}

try {
	throw message = "thrown";
	detail = "deets";
	errorCode = "403";
	type = "Test";
} catch ( e) {
	dump( var=bxcatch, label="additional arguments are ignored" );
}
// use this syntax instead
try {
	throw( message="thrown", detail="deets", errorCode="403", type="Test" );
} catch ( e) {
	dump( var=bxcatch, label="script throw with arguments" );
}

PreviousSystemOutput NextTrace

Last updated 21 days ago

Was this helpful?

Method Signature

Arguments

Examples

Throw a custom exception

Throw a custom http response exception

Additional Examples

Related