Function assert

  • assert<Ts>(property: IAsyncProperty<Ts>, params?: Parameters<Ts>): Promise<void>

  • Run the property, throw in case of failure

    It can be called directly from describe/it blocks of Mocha. No meaningful results are produced in case of success.

    WARNING: Has to be awaited

    Type Parameters

    • Ts

    Parameters

    • property: IAsyncProperty<Ts>

      Asynchronous property to be checked

    • Optionalparams: Parameters<Ts>

      Optional parameters to customize the execution

    Returns Promise<void>

    Remarks

    Since 0.0.7

  • assert<Ts>(property: IProperty<Ts>, params?: Parameters<Ts>): void

  • Run the property, throw in case of failure

    It can be called directly from describe/it blocks of Mocha. No meaningful results are produced in case of success.

    Type Parameters

    • Ts

    Parameters

    • property: IProperty<Ts>

      Synchronous property to be checked

    • Optionalparams: Parameters<Ts>

      Optional parameters to customize the execution

    Returns void

    Remarks

    Since 0.0.1

  • assert<Ts>(
        property: IRawProperty<Ts, boolean>,
        params?: Parameters<Ts>,
    ): Promise<void> | void

  • Run the property, throw in case of failure

    It can be called directly from describe/it blocks of Mocha. No meaningful results are produced in case of success.

    WARNING: Returns a promise to be awaited if the property is asynchronous

    Type Parameters

    • Ts

    Parameters

    • property: IRawProperty<Ts, boolean>

      Synchronous or asynchronous property to be checked

    • Optionalparams: Parameters<Ts>

      Optional parameters to customize the execution

    Returns Promise<void> | void

    Remarks

    Since 0.0.7

Settings

Member Visibility