Skip to content

Commit f7ac23f

Browse files
authored
Tweak guide 06_typescript for typos & fluency
1 parent b29bebf commit f7ac23f

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

packages/overmind-website/guides/beginner/06_typescript.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Typescript
22

3-
Overmind is written in Typescript and it is written with a focus on your keeping as little time as possible helping Typescript understand what your app is all about. Typescript will spend a lot more time helping you. If you are not a Typescript developer Overmind is a really great project to start learning it as you will get the most out of the little typing you have to do.
3+
Overmind is written in Typescript and it is written with a focus on you dedicating as little time as possible to help Typescript understand what your app is all about. Typescript will spend a lot more time helping you. If you are not a Typescript developer Overmind is a really great project to start learning it as you will get the most out of the little typing you have to do.
44

55
## Two typing approaches
66

77
### 1. Declare module
88

9-
The most straight forward way to type your application is to use the **declare module** approach. This will work for most applications, but might make you feel uncomfortable as a harcore Typescripter. The reason is that we are overriding an internal type, meaning that you can only have one instance of Overmind running inside your application.
9+
The most straightforward way to type your application is to use the **declare module** approach. This will work for most applications, but might make you feel uncomfortable as a hardcore Typescripter. The reason is that we are overriding an internal type, meaning that you can only have one instance of Overmind running inside your application.
1010

1111
```marksy
1212
h(Example, { name: "guide/typescript/declare" })
@@ -34,7 +34,7 @@ h(Example, { name: "guide/typescript/explicit_import" })
3434
```
3535

3636
```marksy
37-
h(Notice, null, "The Overmind documentation is written for implicit typing. That means whenever you see a type import directly from the Overmind package, you should rather import from your own defined types")
37+
h(Notice, null, "The Overmind documentation is written for implicit typing. That means whenever you see a type import directly from the Overmind package, you should rather import from your own defined types.")
3838
```
3939

4040
## Linting
@@ -43,13 +43,13 @@ When you are using TSLint it is important that you use the official [Microsoft E
4343

4444
## Actions
4545

46-
The action type takes either an input type, an output type or both.
46+
The action type takes either an input type, an output type, or both.
4747

4848
```marksy
4949
h(Example, { name: "guide/typescript/action" })
5050
```
5151

52-
You also have **async** version of this type. You use this when you want to define an **async** function, which implicitly returns a promise, or a function that explicitly returns a promise.
52+
You also have an **async** version of this type. You use this when you want to define an **async** function, which implicitly returns a promise, or a function that explicitly returns a promise.
5353

5454
```marksy
5555
h(Example, { name: "guide/typescript/async_action" })
@@ -58,13 +58,13 @@ h(Example, { name: "guide/typescript/async_action" })
5858

5959
## Operators
6060

61-
Operators is like the **Action** type, it can take an optional input, but it always produces an output. By default the output of an operator is the same as the input.
61+
Operators is like the **Action** type: it can take an optional input, but it always produces an output. By default the output of an operator is the same as the input.
6262

6363
```marksy
6464
h(Example, { name: "guide/typescript/operatorinputsandoutputs" })
6565
```
6666

67-
The **Operator** type is used to type all operators. The type arguments you give to **Operator** has to match the specific operator you use though. So for example if you type a **mutate** operator with a different output than the input:
67+
The **Operator** type is used to type all operators. The type arguments you give to **Operator** have to match the specific operator you use though. So for example if you type a **mutate** operator with a different output than the input:
6868

6969
```marksy
7070
h(Example, { name: "guide/typescript/wrongoperator" })
@@ -90,7 +90,7 @@ To fix this we just add a generic type to the definition of our operator:
9090
h(Example, { name: "guide/typescript/operatorinfer_solution" })
9191
```
9292

93-
Now Typescript infers the input type of the operator and passes it a long.
93+
Now Typescript infers the input type of the operator and passes it along.
9494

9595
### Partial input
9696

@@ -108,4 +108,4 @@ To fix this we again infer the type, but using **extends** to indicate that we d
108108
h(Example, { name: "guide/typescript/operatorpartial_solution" })
109109
```
110110

111-
That means this operator can handle any type that matches an **isAwesome** property, though will pass the original type through.
111+
That means this operator can handle any type that matches an **isAwesome** property, though will pass the original type through.

0 commit comments

Comments
 (0)