Skip to content

134 Enhance ReadMe with documentation on parser options #145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chawes13 merged 5 commits into from
Jan 5, 2024
Merged

134 Enhance ReadMe with documentation on parser options #145

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3d9dd87
document parsers
nicoledow Dec 4, 2023
edd3e76
increment version
nicoledow Dec 4, 2023
cd0e1a4
Revert "increment version"
nicoledow Dec 4, 2023
57d0f4e
additional details on default for parse_each
nicoledow Dec 4, 2023
aac6ea3
bump version
nicoledow Jan 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,11 +137,19 @@ input :ids, :array, parse_each: :integer

### Parser options

Parsers can receive options that modify their behavior. These options are passed in as named arguments to `input`:
Some parsers can receive options that modify their behavior. These options are passed in as named arguments to `input`:

**Example:**

```ruby
input :start_date, :date, parse_format: '%Y-%m-%d'
```
**Available Options:**
| Parser | Option | Default | Notes
| ----------- | ----------- | -----------| -----------
| `ArrayParser` | `parse_each`| N/A | Accepts a parser type, then uses that parser to parse each element in the array. If this option is not defined, each element is simply returned.
| `DateParser`| `parse_format` | `'%m/%d/%Y'`| Accepts any format string accepted by Ruby's `strftime` method
| `DateTimeParser` | `parse_format` | `'%m/%d/%Y %I:%M:%S %p'` | Accepts any format string accepted by Ruby's `strftime` method

### Exceptions

Expand Down