doc for _only methods

[p5sagit/Data-Dumper-Concise.git] / lib / Devel / Dwarn.pm

package Devel::Dwarn;

use Data::Dumper::Concise::Sugar;

sub import {
  Data::Dumper::Concise::Sugar->export_to_level(1, @_);
}

=head1 NAME

Devel::Dwarn - return Dwarn @return_value

=head1 SYNOPSIS

  use Devel::Dwarn;

  return Dwarn some_call(...)

is equivalent to:

  use Data::Dumper::Concise;

  my @return = some_call(...);
  warn Dumper(@return);
  return @return;

but shorter. If you need to force scalar context on the value,

  use Devel::Dwarn;

  return DwarnS some_call(...)

is equivalent to:

  use Data::Dumper::Concise;

  my $return = some_call(...);
  warn Dumper($return);
  return $return;

Sometimes you'll want to C<Dwarn> out part of a result, instead of the entire
thing; for that we have C<Dwarn_only>:

  # Dwarn the TO_JSON of all the objects in the list
  my @results = Dwarn_only { map $_->TO_JSON, @_ } some_call(...);

and C<DwarnS_only>:

  # only Dwarn the first item
  my $data = Dwarn_only { $_->[0] } [ some_call(...) ];

Another trick that is extremely useful when doing method chaining is the
following:

  my $foo = Bar->new;
  $foo->bar->baz->Devel::Dwarn::DwarnS->biff;

which is the same as:

  my $foo = Bar->new;
  (DwarnS $foo->bar->baz)->biff;

=head1 SEE ALSO

This module is really just a shortcut for L<Data::Dumper::Concise::Sugar>, check
it out for more complete documentation.

=cut

1;