Skip to content

Commit

Permalink
close #18
Browse files Browse the repository at this point in the history
  • Loading branch information
rodber committed Feb 14, 2025
1 parent fd8baab commit 26974bc
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,11 +261,11 @@ function myCallable(): ParameterInterface

## Types

A Parameter is an object implementing `ParameterInterface`. Every Parameter can define a `description` and a `default` value, plus additional validation rules depending on the type.
A Parameter is an object implementing `ParameterInterface`. Every Parameter can define a `description`, `default` value, `sensitive` flag, plus additional validation rules depending on the type.

A Parameter can be defined using functions and/or attributes, it takes same arguments for both.
A Parameter can be defined using functions or attributes, it takes same arguments for both.

When invoking a Parameter `$param('value')` it will trigger validation against the passed argument.
When invoking a Parameter `$param($arg)` or `$param->__invoke($arg)` it will trigger validation against the passed argument. This method will fill-in any missing optional parameters with their default values. It will also exclude any extra unexpected parameters.

## String

Expand Down

0 comments on commit 26974bc

Please sign in to comment.