Hitchy Core Manual

Appearance

api.service.ValueParser ​

This service implements a class of helper methods and regular expressions suitable for detecting a given value's type. It is tightly integrated with Hitchy's support for typed parameters.

Static properties ​

PtnInteger ​

This regular expression matches a string containing a negative or positive integer.

javascript
const isInteger = api.service.PtnInteger.test( "-1234567890" );

Limitations ​

  • 16 digits are supported at most.
  • No thousands separator is supported.

PtnKeyword ​

This regular expression matches a string assumed to contain a valid keyword, which is a sequence of characters of Unicode's ID class.

javascript
const isKeyword = api.service.PtnKeyword.test( "MyCustomIdentifier" );

Limitations ​

  • Keywords have to start with a character matching Unicode property ID_Start.
  • Follow-up characters have to match Unicode property ID_Continue.
  • Keywords must not be longer than 64 characters.

PtnNumber ​

This regular expression matches a string containing a negative or positive decimal number.

javascript
const isNumber = api.service.PtnNumber.test( "+1234567890.1234567890" );

Limitations ​

  • Up to 16 digits before the decimal separator are supported.
  • Up to 16 digits after the decimal separator are supported.
  • No locale-specific number format is supported.
  • No thousands separator is supported.
  • The period . is the only supported decimal separator.

PtnUuid ​

This regular expression matches a string containing a UUID.

javascript
const isUuid = api.service.PtnUuid.test( "12345678-1234-1234-1234-123456789abc" );

Static methods ​

isInteger() ​

This method tests a given value for matching PtnInteger.

For convenience, provided value may be an array of values causing this method to test either item, instead, so that the method indicates whether all items of that array are integers or not.

The return value is true if provided value(s) is/are integer(s). Otherwise, false is returned.

This method is used for checking values of typed parameters.

isKeyword() ​

This method tests a given value for matching PtnKeyword.

For convenience, provided value may be an array of values causing this method to test either item, instead, so that the method indicates whether all items of that array are keywords or not.

The return value is true if provided value(s) is/are keyword(s). Otherwise, false is returned.

This method is used for checking values of typed parameters.

isNumber() ​

This method tests a given value for matching PtnNumber.

For convenience, provided value may be an array of values causing this method to test either item, instead, so that the method indicates whether all items of that array are numbers or not.

The return value is true if provided value(s) is/are number(s). Otherwise, false is returned.

This method is used for checking values of typed parameters.

isUuid() ​

This method tests a given value for matching PtnUuid.

For convenience, provided value may be an array of values causing this method to test either item, instead, so that the method indicates whether all items of that array are UUIDs or not.

The return value is true if provided value(s) is/are UUID(s). Otherwise, false is returned.

This method is used for checking values of typed parameters.