Skip to content

Commit 2275dba

Browse files
authored
Merge pull request #795 from scala-js/prefer-overloads
Mention preference for overloads in contrib doc
2 parents d157768 + 9f55fd0 commit 2275dba

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

CONTRIBUTING.md

+7
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,13 @@ Please:
5454
* Use `def` for read-only properties unless there is a compelling reason it should be a `val`
5555
(i.e., the spec definitively states it is constant)
5656
* Use `Double` for integer-values that can fall outside the range of `Int`
57+
* Prefer adding overloads instead of using union `|` types for method and constructor parameters. For example:
58+
```diff
59+
- def createElement(tagName: String, options: String | ElementCreationOptions = js.native): Element = js.native
60+
+ def createElement(tagName: String): Element = js.native
61+
+ def createElement(tagName: String, options: String): Element = js.native
62+
+ def createElement(tagName: String, options: ElementCreationOptions): Element = js.native
63+
```
5764
* Add scaladocs via copy-paste from MDN
5865

5966

0 commit comments

Comments
 (0)