Skip to content

Commit b3c1f06

Browse files
committed
docs(README): update README
1 parent bac142f commit b3c1f06

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,8 @@ All option helpers accept these properties:
249249
| `hidden` | `boolean` | Hide from `--help` output |
250250
| `required` | `boolean` | Mark as required (makes the option non-nullable) |
251251

252+
Example:
253+
252254
```typescript
253255
bargs.string({
254256
aliases: ['o'],
@@ -279,6 +281,8 @@ bargs.variadic('string'); // [files...]
279281
| `name` | `string` | Display name in help (defaults to `arg0`, `arg1`, ...) |
280282
| `required` | `boolean` | Mark as required (shown as `<name>` vs `[name]`) |
281283

284+
Example:
285+
282286
```typescript
283287
bargs.stringPos({
284288
name: 'file',

0 commit comments

Comments
 (0)