docs(website): update typing docs and add typescript guide

Author: christianalfoni

packages/node_modules/overmind/src/index.ts

@@ -19,6 +19,7 @@ import {
   TOperator,
   TReaction,
   TValueContext,
+  TOnInitialize,
 } from './types'
 
 export * from './types'
@@ -41,9 +42,7 @@ export type Derive<Parent extends object, Value> = TDerive<
 
 export type Reaction = TReaction<TheConfig>
 
-export type OnInitialize = (
-  context: TValueContext<TheConfig, ResolveActions<TheConfig['actions']>>
-) => void
+export type OnInitialize = TOnInitialize<TheConfig>
 
 const isPlainObject = require('is-plain-object')
 const IS_PRODUCTION = process.env.NODE_ENV === 'production'

packages/node_modules/overmind/src/types.ts

@@ -56,3 +56,7 @@ export type TReaction<Config extends Configuration> = (
     action: TAction<Config, void> | TOperator<Config, void, any>
   ) => any
 ) => any
+
+export type TOnInitialize<Config extends Configuration> = (
+  context: TValueContext<Config, ResolveActions<Config['actions']>>
+) => void

packages/overmind-website/examples/api/config_merge.ts

@@ -4,7 +4,7 @@ export default (ts, view) =>
         {
           fileName: 'app.ts',
           code: `
-import { Overmind, TApp } from 'overmind'
+import { Overmind, TConfig } from 'overmind'
 import { merge } from 'overmind/config'
 import * as moduleA from './moduleA'
 import * as moduleB from './moduleB'
@@ -15,7 +15,7 @@ const config = merge({
 })
 
 declare module 'overmind' {
-  interface IApp extends TApp<typeof config> {}
+  interface IConfig extends TConfig<typeof config> {}
 }
 
 const app = new Overmind(config)

packages/overmind-website/examples/api/config_namespaced.ts

@@ -4,7 +4,7 @@ export default (ts, view) =>
         {
           fileName: 'app.ts',
           code: `
-import { Overmind, TApp } from 'overmind'
+import { Overmind, TConfig } from 'overmind'
 import { namespaced } from 'overmind/config'
 import * as moduleA from './moduleA'
 import * as moduleB from './moduleB'
@@ -15,7 +15,7 @@ const config = namespaced({
 })
 
 declare module 'overmind' {
-  interface IApp extends TApp<typeof config> {}
+  interface IConfig extends TConfig<typeof config> {}
 }
 
 const app = new Overmind(config)

packages/overmind-website/examples/guide/routing/router.ts

@@ -4,7 +4,7 @@ export default (ts, view) =>
         {
           fileName: 'app/actions.ts',
           code: `
-import { Overmind, TApp } from 'overmind'
+import { Overmind, TConfig } from 'overmind'
 import { createConnect, TConnect } from 'overmind-${view}'
 import * as page from 'page'
 import { state } from './state'
@@ -18,7 +18,7 @@ const config = {
 }
 
 declare module 'overmind' {
-  interface App extends TApp<typeof config> {}
+  interface IConfig extends TConfig<typeof config> {}
 }
 
 export const app = new Overmind(config)

packages/overmind-website/examples/guide/structuringtheapp/namespaced.ts

@@ -4,7 +4,7 @@ export default (ts, view) =>
         {
           fileName: 'app/index.ts',
           code: `
-import { Overmind, TApp } from 'overmind'
+import { Overmind, TConfig } from 'overmind'
 import { namespaced } from 'overmind/config'
 import * as posts from './posts'
 import * as admin from './admin'
@@ -15,7 +15,7 @@ const config = namespaced({
 })
 
 declare module 'overmind' {
-  interface IApp extends TApp<typeof config> {}
+  interface IConfig extends TConfig<typeof config> {}
 }
 
 const app = new Overmind(config)

packages/overmind-website/examples/guide/typescript/declare.ts

@@ -0,0 +1,13 @@
+export default () => [
+  {
+    code: `
+import { TConfig } from 'overmind'
+
+const config = {}
+
+declare module 'overmind' {
+  interface IConfig extends TConfig<typeof config> {}
+}
+        `,
+  },
+]

packages/overmind-website/examples/guide/typescript/declare_imports.ts

@@ -0,0 +1,16 @@
+export default () => [
+  {
+    code: `
+import {
+  Action,
+  Operator,
+  Reaction,
+  Derive,
+  pipe,
+  map,
+  filter,
+  ...
+} from 'overmind'
+        `,
+  },
+]

packages/overmind-website/examples/guide/typescript/explicit.ts

@@ -0,0 +1,28 @@
+export default () => [
+  {
+    code: `
+import {
+  TConfig,
+  TOnInitialize,
+  TAction,
+  TOperator,
+  TDerive,
+  TReaction
+} from 'overmind'
+
+const config = {}
+
+export type Config = TConfig<typeof config>
+
+export type OnInitialize = TOnInitialize<Config>
+
+export type Action<Input> = TAction<Config, Input>
+
+export type Operator<Input, Output> = TOperator<Config, Input, Output>
+
+export type Derive<Parent extends object, Output> = TDerive<Config, Parent, Output>
+
+export type Reaction = TReaction<Config>
+        `,
+  },
+]

packages/overmind-website/examples/guide/typescript/explicit_operators.ts

@@ -0,0 +1,16 @@
+export default () => [
+  {
+    code: `
+import { pipe, map, run } from 'overmind'
+import { Config, Operator } from '../'
+
+const toUpperCase = map<string, string, Config>(...)
+const doSomething = run<string, Config>(...)
+
+export const doThis: Operator<string, string> = pipe(
+  toUpperCase,
+  doSomething
+)
+        `,
+  },
+]