henderjon/flags

v0.0.3 2024-05-20 15:19 UTC

This package is auto-updated.

Last update: 2024-11-22 21:13:53 UTC


README

Flags takes an object, parses it's properties and methods and evaluates a given array (e.g. $argv) and populates the object with the given array.

Flags uses Attributes to parse/echo documentation.

For example usage, see the example

special cases

  • To set a bool true simply use it (e.g. -var). To set it's value it is required to use the equal sign (e.g. -var=false)
  • -help or --help will always print DocStings
  • when combing custom types, nullables, default values, and shadow methods, it can be tricky to make sure that everything that OUGHT to be nullable, is so
  • errors/exception in the vein of Argument #1 ($v) must be of type $TYPE, null given that means that the expected type of the property, shadow function parameter, and shadow function return type don't match. Specifically, nullable types require everything else to be nullable, especially when it's a complex type that is nullable and defaults to null as a value.