.\" -*- 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 "MetaCPAN::Client::Favorite 3pm"
.TH MetaCPAN::Client::Favorite 3pm 2024-03-24 "perl v5.38.2" "User Contributed Perl Documentation"
.\" 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
MetaCPAN::Client::Favorite \- A Favorite data object
.SH VERSION
.IX Header "VERSION"
version 2.031001
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    # Query favorites for a given distribution:
\&
\&    my $favorites = $mcpan\->favorite( {
\&        distribution => \*(AqMoose\*(Aq
\&    } );
\&
\&
\&    # Total number of matches ("how many favorites does the dist have?"):
\&
\&    print $favorites\->total;
\&
\&
\&    # Iterate over the favorite matches
\&
\&    while ( my $fav = $favorites\->next ) { ... }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
A MetaCPAN favorite entity object.
.SH ATTRIBUTES
.IX Header "ATTRIBUTES"
.SS date
.IX Subsection "date"
An ISO8601 datetime string like \f(CW\*(C`2016\-11\-19T12:41:46\*(C'\fR indicating when the
favorite was created.
.SS user
.IX Subsection "user"
The user ID (\fBnot\fR PAUSE ID) of the person who favorited the thing in
question.
.SS release
.IX Subsection "release"
The release that was favorited.
.SS id
.IX Subsection "id"
The favorite ID.
.SS author
.IX Subsection "author"
The PAUSE ID of the author whose release was favorited.
.SS distribution
.IX Subsection "distribution"
The distribution that was favorited.
.SH AUTHORS
.IX Header "AUTHORS"
.IP \(bu 4
Sawyer X <xsawyerx@cpan.org>
.IP \(bu 4
Mickey Nasriachi <mickey@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2016 by Sawyer X.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.