foster/denoland-deno
1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2025-01-14 10:01:51 -05:00
Code Issues Packages 1 Wiki Activity

doc: fix list style (#2823)

Browse source
This commit is contained in:
迷渡 2019-08-28 21:51:36 +08:00 committed by Ryan Dahl
parent 20739a8111
commit 1d34f11a87
1 changed files with 7 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
website/style_guide.md
View file

@ -54,17 +54,22 @@ When designing function interfaces, stick to the following rules.
there is only one, and it seems inconceivable that we would add more optional
parameters in the future.
<!-- prettier-ignore-start -->
<!-- see https://github.com/prettier/prettier/issues/3679 -->
3. The 'options' argument is the only argument that is a regular 'Object'.
Other arguments can be objects, but they must be distinguishable from a
'plain' Object runtime, by having either:
- a distinguishing prototype (e.g. `Array`, `Map`, `Date`, `class MyThing`)
- a well-known symbol property (e.g. an iterable with `Symbol.iterator`).
- a distinguishing prototype (e.g. `Array`, `Map`, `Date`, `class MyThing`)
- a well-known symbol property (e.g. an iterable with `Symbol.iterator`).
This allows the API to evolve in a backwards compatible way, even when the
position of the options object changes.
<!-- prettier-ignore-end -->
```ts
// BAD: optional parameters not part of options object. (#2)
export function resolve(