API Reference

Assertionclass

Static assertion helper for runtime validation. Use its static methods directly; do not instantiate this class.

Quick facts
Kind
class
Module
exceptions
Members
4
Package
@rs-x/core
Source
exceptions/assertion.ts

Import

import { Assertion } from '@rs-x/core';

Example

import { Assertion } from '@rs-x/core';

Assertion.assert(() => user.id > 0, 'user.id must be > 0');
Assertion.assertNotNullOrUndefined(user.name, 'user.name');
Assertion.assertIsFunction(handler, 'handler');

Members

4 members in this class.

assert
methodpublic
public static assert(
  predicate: () => boolean,
  messsage: string
): void

Parameters

Name
Type
Required
predicate
()
required

Returns

void

assertIsFunction
methodpublic
public static assertIsFunction(
  value: unknown,
  name: string | number
): asserts value is AnyFunction

Parameters

Name
Type
Required
value
unknown
required
name
string | number
required

Returns

asserts value is AnyFunction

assertNotNullOrEmpty
methodpublic
public static assertNotNullOrEmpty(
  value: unknown,
  argumentName: string
): void

Parameters

Name
Type
Required
value
unknown
required
argumentName
string
required

Returns

void

assertNotNullOrUndefined
methodpublic
public static assertNotNullOrUndefined(
  value: unknown,
  argumentName: string
): void

Parameters

Name
Type
Required
value
unknown
required
argumentName
string
required

Returns

void