docs-v2/content/flux/v0/stdlib/internal/testing/shoulderrorwithcode.md

title	description	menu	weight	flux/v0/tags	introduced
testing.shouldErrorWithCode() function	`testing.shouldErrorWithCode()` calls a function that catches any error and checks that the error matches the expected value.	flux_v0_ref name parent identifier testing.shouldErrorWithCode internal/testing internal/testing/shouldErrorWithCode	201	tests	0.182.0

testing.shouldErrorWithCode() calls a function that catches any error and checks that the error matches the expected value.

Function type signature

(code: uint, fn: () => A, want: regexp) => stream[{match: bool, code: uint, _diff: string}]

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

fn

({{< req >}}) Function to call.

want

({{< req >}}) Regular expression to match the expected error.

code

({{< req >}}) Which flux error code to expect

Examples

Test die function errors

import "testing"

testing.shouldErrorWithCode(fn: () => die(msg: "error message"), want: /error message/, code: 3)