requireScalar
function requireScalar(
value: unknown,
message: string = "Expected a scalar value."
): string | number | boolean | symbol | bigint;
A primitive that carries a single value: string, number, boolean, symbol or bigint. null and undefined are primitives too, but they carry no value and do not qualify.
isX and nonX answer a question and never interrupt control flow; requireX and requireNonX hand the value back or throw. The scheme is explained in Validation conventions.
Parameters
Parameter | Type | Description |
|---|---|---|
|
| The value to validate. |
|
| The message of the exception. A default is used when omitted. |
Returns
string | number | boolean | symbol | bigint — the same value, typed as a scalar.
Throws
Exception | Condition |
|---|---|
| the value is not a scalar. |
Examples
What passes and what does not
requireScalar("abc"); // => "abc"
requireScalar(1); // => 1
requireScalar({}); // throws IllegalArgumentException
requireScalar([]); // throws IllegalArgumentException
See also
Source
23 September 2026
This documentation was generated with AI (Claude) from the library's source code.