NAME

Data::Object::Args

ABSTRACT

Data-Object Command-line Arguments

SYNOPSIS

  use Data::Object::Args;

  my $args = Data::Object::Args->new(
    named => { command => 0, action => 1 }
  );

  $args->get(0); # $ARGV[0]
  $args->get(1); # $ARGV[1]
  $args->action; # $ARGV[1]
  $args->command; # $ARGV[0]
  $args->exists(0); # exists $ARGV[0]
  $args->exists('command'); # exists $ARGV[0]
  $args->get('command'); # $ARGV[0]

DESCRIPTION

This package provides an object-oriented interface to the process' command-line arguments.

INTEGRATIONS

This package integrates behaviors from:

Data::Object::Role::Stashable

LIBRARIES

This package uses type constraints defined by:

Data::Object::Library

ATTRIBUTES

This package has the following attributes.

named

  named(HashRef)

The attribute is read-only, accepts (HashRef) values, and is optional.

METHODS

This package implements the following methods.

exists

  exists(Str $key) : Any

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

exists example

  $args->exists(0); # exists $ARGV[0]
  $args->exists('command'); # exists $ARGV[0]

get

  get(Str $key) : Any

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

get example

  $args->get(0); # $ARGV[0]
  $args->get('command'); # $ARGV[0]

name

  name(Str $key) : Any

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

name example

  $args->name(0); # 0
  $args->name('command'); # 0

set

  set(Str $key, Maybe[Any] $value) : Any

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

set example

  $args->set(0); # undef
  $args->set('command', undef); # undef

stashed

  stashed() : HashRef

The stashed method returns the stashed data associated with the object.

stashed example

  $args->stashed; # {...}

CREDITS

Al Newkirk, +319

Anthony Brummett, +10

Adam Hopkins, +2

José Joaquín Atria, +1

AUTHOR

Al Newkirk, awncorp@cpan.org

LICENSE

This is free software; you can redistribute it and/or modify it under the terms of the The Apache License, Version 2.0, as elucidated here, https://github.com/iamalnewkirk/do/blob/master/LICENSE.