Skip to content

it.effect.fails doesn't exist (but docs say it does) #5934

@tyler-dot-earth

Description

@tyler-dot-earth

What is the type of issue?

Documentation is incorrect

What is the issue?

The README for @effect/vitest states that it.effect.fails is a thing:

// Temporarily assert that the test for dividing by zero fails.
it.effect.fails("dividing by zero special cases", ({ expect }) =>

... but it isn't a real thing as far as i can tell:

Locally I'm seeing:

Diagnostics:
1. tsserver: Property 'fails' does not exist on type 'Tester<TestServices>'. [2339]

I noticed after reading it on @kitlangton's effect.solutions site:

Should it be a real thing? Is it a hallucination? Should it be using a different it.* method?

Where did you find it?

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions