Module

Test.Spec

Package
purescript-spec
Repository
purescript-spec/purescript-spec

#Name Source

type Name = String

#Only Source

type Only = Boolean

#Result Source

data Result

Constructors

Instances

#Group Source

data Group t

Constructors

Instances

#Spec Source

type Spec t = State (Array (Group (Aff Unit))) t

#describe Source

describe :: String -> Spec Unit -> Spec Unit

Combine a group of specs into a described hierarchy.

#describeOnly Source

describeOnly :: String -> Spec Unit -> Spec Unit

Combine a group of specs into a described hierarchy and mark it as the only group to actually be evaluated. (useful for quickly narrowing down on a set)

#pending Source

pending :: String -> Spec Unit

Create a pending spec.

#pending' Source

pending' :: String -> Aff Unit -> Spec Unit

Create a pending spec with a body that is ignored by the runner. It can be useful for documenting what the spec should test when non-pending.

#it Source

it :: String -> Aff Unit -> Spec Unit

Create a spec with a description.

#itOnly Source

itOnly :: String -> Aff Unit -> Spec Unit

Create a spec with a description and mark it as the only one to be run. (useful for quickly narrowing down on a single test)

#countTests Source

countTests :: Spec Unit -> Int

Count the total number of tests in a spec