Skip to content

Commit 2e0b124

Browse files
cscottsaschanaz
andauthored
chore(README): Document the default field of arguments (#532)
Closes: #531 Co-authored-by: Kagami Sascha Rosylight <[email protected]>
1 parent 5383a2e commit 2e0b124

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -405,7 +405,7 @@ All the members are fields as follows:
405405
* `required`: `true` if the field is required.
406406
* `idlType`: An [IDL Type](#idl-type) describing what field's type.
407407
* `extAttrs`: An array of [extended attributes](#extended-attributes).
408-
* `default`: A [default value](#default-and-const-values), absent if there is none.
408+
* `default`: A [default value](#default-and-const-values), or `null` if there is none.
409409

410410
### Enum
411411

@@ -515,6 +515,7 @@ An operation looks like this:
515515
},
516516
"name": "intersection",
517517
"arguments": [{
518+
"default": null,
518519
"optional": false,
519520
"variadic": true,
520521
"extAttrs": [],
@@ -551,6 +552,7 @@ A constructor operation member looks like this:
551552
{
552553
"type": "constructor",
553554
"arguments": [{
555+
"default": null,
554556
"optional": false,
555557
"variadic": true,
556558
"extAttrs": [],
@@ -651,6 +653,7 @@ The arguments (e.g. for an operation) look like this:
651653
{
652654
"arguments": [{
653655
"type": "argument",
656+
"default": null,
654657
"optional": false,
655658
"variadic": true
656659
"extAttrs": []
@@ -670,6 +673,7 @@ The arguments (e.g. for an operation) look like this:
670673

671674
The fields are as follows:
672675

676+
* `default`: A [default value](#default-and-const-values), or `null` if there is none.
673677
* `optional`: `true` if the argument is optional.
674678
* `variadic`: `true` if the argument is variadic.
675679
* `idlType`: An [IDL Type](#idl-type) describing the type of the argument.

0 commit comments

Comments
 (0)