named

  named(HashRef)

This attribute is read-write, accepts "(HashRef)" values, is optional, and defaults to "{}".

parsed

  parsed(HashRef)

This attribute is read-write, accepts "(HashRef)" values, is optional, and defaults to "{}".

specs

  specs(ArrayRef)

This attribute is read-write, accepts "(ArrayRef)" values, is optional, and defaults to "[]".

warns

  warns(ArrayRef)

This attribute is read-write, accepts "(ArrayRef)" values, is optional, and defaults to "[]".

unused

  unused(ArrayRef)

This attribute is read-write, accepts "(ArrayRef)" values, is optional, and defaults to "[]".

default

  default() (arrayref)

The default method returns the default value, i.e. "[@ARGV]".

Since 0.01

default example 1

  # given: synopsis;
  my $default = $opts->default;
  # []
    

exists

  exists(string $key) (boolean)

The exists method takes a name or index and returns truthy if an associated value exists.

Since 0.01

exists example 1

  # given: synopsis;
  my $exists = $opts->exists('resource');
  # 1
    

exists example 2

  # given: synopsis;
  my $exists = $opts->exists('method');
  # 1
    

exists example 3

  # given: synopsis;
  my $exists = $opts->exists('resources');
  # undef
    

get

  get(string $key) (any)

The get method takes a name or index and returns the associated value.

Since 0.01

get example 1

  # given: synopsis;
  my $get = $opts->get('resource');
  # "users"
    

get example 2

  # given: synopsis;
  my $get = $opts->get('method');
  # "users"
    

get example 3

  # given: synopsis;
  my $get = $opts->get('resources');
  # undef
    

name

  name(string $key) (string | undef)

The name method takes a name or index and returns index if the the associated value exists.

Since 0.01

name example 1

  # given: synopsis;
  my $name = $opts->name('resource');
  # "resource"
    

name example 2

  # given: synopsis;
  my $name = $opts->name('method');
  # "resource"
    

name example 3

  # given: synopsis;
  my $name = $opts->name('resources');
  # undef
    

parse

  parse(arrayref $args) (Venus::Opts)

The parse method optionally takes additional Getopt::Long parser configuration options and retuns the options found based on the object "args" and "spec" values.

Since 0.01

parse example 1

  # given: synopsis;
  my $parse = $opts->parse;
  # bless({...}, 'Venus::Opts')
    

parse example 2

  # given: synopsis;
  my $parse = $opts->parse(['bundling']);
  # bless({...}, 'Venus::Opts')
    

reparse

  reparse(arrayref $specs, arrayref $args) (Venus::Opts)

The reparse method resets the parser, calls the "parse" method and returns the result.

Since 2.55

reparse example 1

  # given: synopsis;
  my $reparse = $opts->reparse(['resource|r=s']);
  # bless({...}, 'Venus::Opts')
    

reparse example 2

  # given: synopsis;
  my $reparse = $opts->reparse(['resource|r=s'], ['bundling']);
  # bless({...}, 'Venus::Opts')
    

set

  set(string $key, any $data) (any)

The set method takes a name or index and sets the value provided if the associated argument exists.

Since 0.01

set example 1

  # given: synopsis;
  my $set = $opts->set('method', 'people');
  # "people"
    

set example 2

  # given: synopsis;
  my $set = $opts->set('resource', 'people');
  # "people"
    

set example 3

  # given: synopsis;
  my $set = $opts->set('resources', 'people');
  # undef
    

unnamed

  unnamed() (arrayref)

The unnamed method returns an arrayref of values which have not been named using the "named" attribute.

Since 0.01

unnamed example 1

  # given: synopsis;
  my $unnamed = $opts->unnamed;
  # [1]