.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Test2::Event::Ok 3perl"
.TH Test2::Event::Ok 3perl 2024-05-30 "perl v5.38.2" "Perl Programmers Reference Guide"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Test2::Event::Ok \- Ok event type
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Ok events are generated whenever you run a test that produces a result.
Examples are \f(CWok()\fR, and \f(CWis()\fR.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&    use Test2::API qw/context/;
\&    use Test2::Event::Ok;
\&
\&    my $ctx = context();
\&    my $event = $ctx\->ok($bool, $name, \e@diag);
.Ve
.PP
or:
.PP
.Vb 6
\&    my $ctx   = context();
\&    my $event = $ctx\->send_event(
\&        \*(AqOk\*(Aq,
\&        pass => $bool,
\&        name => $name,
\&    );
.Ve
.SH ACCESSORS
.IX Header "ACCESSORS"
.ie n .IP "$rb = $e\->pass" 4
.el .IP "\f(CW$rb\fR = \f(CW$e\fR\->pass" 4
.IX Item "$rb = $e->pass"
The original true/false value of whatever was passed into the event (but
reduced down to 1 or 0).
.ie n .IP "$name = $e\->name" 4
.el .IP "\f(CW$name\fR = \f(CW$e\fR\->name" 4
.IX Item "$name = $e->name"
Name of the test.
.ie n .IP "$b = $e\->effective_pass" 4
.el .IP "\f(CW$b\fR = \f(CW$e\fR\->effective_pass" 4
.IX Item "$b = $e->effective_pass"
This is the true/false value of the test after TODO and similar modifiers are
taken into account.
.SH SOURCE
.IX Header "SOURCE"
The source code repository for Test2 can be found at
\&\fIhttp://github.com/Test\-More/test\-more/\fR.
.SH MAINTAINERS
.IX Header "MAINTAINERS"
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.SH AUTHORS
.IX Header "AUTHORS"
.PD 0
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.PD
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2020 Chad Granum <exodist@cpan.org>.
.PP
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.PP
See \fIhttp://dev.perl.org/licenses/\fR