Skip to content

Commit

Permalink
docs: update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
continuous-deployment committed Nov 27, 2016
1 parent 979458c commit 4cc2d73
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Expand Up @@ -215,6 +215,9 @@ type X = boolean

// Options: ["bool"]
type X = bool

// Options: ["boolean"]
type X = bool
```


Expand Down Expand Up @@ -885,6 +888,8 @@ The following patterns are not considered problems:

```js
type FooType = { a: number, b: string, c: number }

type FooType = { a: number, b: string, a: number }
```


Expand Down Expand Up @@ -1132,6 +1137,8 @@ type X = any; type Y = Object

// Options: [{"Function":false}]
type X = Function

function foo(thing): Function {}
```
Expand Down Expand Up @@ -1257,6 +1264,9 @@ declare class Foo { (): Foo; }

// Options: ["comma"]
declare class Foo { (): Foo, }

// Options: ["semicolon"]
type Foo = { a: Foo, b: Bar }
```
Expand Down Expand Up @@ -1390,6 +1400,8 @@ The following patterns are not considered problems:

// Options: [{"excludeParameterMatch":"^_"}]
(_foo: number, bar: string) => {}

(foo) => {}
```
Expand Down Expand Up @@ -1862,6 +1874,8 @@ type FooType = { a: number;
}
// Options: ["never"]
type FooType = {}
type FooType = {}
```

Expand Down Expand Up @@ -1966,6 +1980,8 @@ type FooType = { a: number, b: number, C: number, c: number }
// Options: ["asc",{"natural":true}]
type FooType = { 1:number, 2: number, 10: number }
type FooType = { b: number, a: number }
```
Expand Down Expand Up @@ -3244,6 +3260,8 @@ The following patterns are not considered problems:
type FooType = {};
// Options: ["^foo$"]
type foo = {};
type foo = {};
```
Expand Down Expand Up @@ -3372,6 +3390,8 @@ type X =
| number
}
type X = string| number;
type X = string & number;
type X = string & number & boolean;
Expand All @@ -3392,6 +3412,8 @@ type X =
& string
& number
}
type X = string& number;
```
Expand Down

0 comments on commit 4cc2d73

Please sign in to comment.