TAP::Parser::Result::Plan(3pm) Perl Programmers Reference Guide TAP::Parser::Result::Plan(3pm)

# [NAME](#NAME)

TAP::Parser::Result::Plan - Plan result token.

# [VERSION](#VERSION)

Version 3.52

# [DESCRIPTION](#DESCRIPTION)

This is a subclass of TAP::Parser::Result. A token of this class will be returned if a plan line is encountered.

```
 1..1
 ok 1 - woo hooo!
```

1..1 is the plan. Gotta have a plan.

# [OVERRIDDEN METHODS](#OVERRIDDEN_METHODS)

Mainly listed here to shut up the pitiful screams of the pod coverage tests. They keep me awake at night.

- "as\_string"
- "raw"

## [Instance Methods](#Instance_Methods)

*"plan"*

```
  if ( $result->is_plan ) {
     print $result->plan;
  }
```

This is merely a synonym for "as\_string".

*"tests\_planned"*

```
  my $planned = $result->tests_planned;
```

Returns the number of tests planned. For example, a plan of 1..17 will cause this method to return '17'.

*"directive"*

```
 my $directive = $plan->directive;
```

If a SKIP directive is included with the plan, this method will return it.

```
 1..0 # SKIP: why bother?
```

*"has\_skip"*

```
  if ( $result->has_skip ) { ... }
```

Returns a boolean value indicating whether or not this test has a SKIP directive.

*"explanation"*

```
 my $explanation = $plan->explanation;
```

If a SKIP directive was included with the plan, this method will return the explanation, if any.

*"todo\_list"*

```
  my $todo = $result->todo_list;
  for ( @$todo ) {
      ...
  }
```

2026-10-21 perl v5.44.0

---

Document: TAP::Parser::Result::Plan(3pm) from perl 5.44.0-r2 (Chainguard OS)
Source: https://github.com/Perl/perl5.git