Merge pull request cerebral#153 from cerebral/typescript

Typescript

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/api/derive.md

@@ -12,3 +12,13 @@ The function defining your derived state receives two arguments. The first argum
 ```marksy
 h(Notice, null, "Accessing **rootState** might cause unnecessary updates to the derived function as it will track more state, though typically not an issue")
 ```
+
+An other use case for derived is to return a function. This allows you to insert functions into your state tree which can execute logic, even based on existing state. Even the function itself might be changed out based on the state of the application.
+
+```marksy
+h(Example, { name: "api/derive_function" })
+```
+
+```marksy
+h(Notice, null, "Using state inside the returned function will not be tracked. You have to access the state in the scope of the derived function")
+```

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/api/derive_function.ts

@@ -0,0 +1,41 @@
+export default (ts) =>
+  ts
+    ? [
+        {
+          fileName: 'app/state.ts',
+          code: `
+import { Derive } from 'overmind'
+
+export type User = {
+  name: string
+}
+
+export type State = {
+  user: User
+  tellUser: Derive<State, (message: string) => {}>
+}
+
+export const state: State = {
+  user: {
+    name: 'John'
+  },
+  tellUser: (state) =>
+    (message) => console.log(message, ', ' + state.user.name)
+}
+    `,
+        },
+      ]
+    : [
+        {
+          fileName: 'app/state.js',
+          code: `
+export const state = {
+  user: {
+    name: 'John'
+  },
+  tellUser: (state) =>
+    (message) => console.log(message, ', ' + state.user.name)
+}
+    `,
+        },
+      ]

packages/overmind-website/examples/guide/definingstate/derived.ts

@@ -0,0 +1,31 @@
+export default (ts) =>
+  ts
+    ? [
+        {
+          fileName: 'app/state.ts',
+          code: `
+import { Derive } from 'overmind'
+
+export type State = {
+  title: string
+  upperTitle: Derive<State, string>
+}
+
+export const state: State = {
+  title: 'My awesome title',
+  upperTitle: state => state.title.toUpperCase()
+}
+  `,
+        },
+      ]
+    : [
+        {
+          fileName: 'app/state.js',
+          code: `
+export const state = {
+  title: 'My awesome title',
+  upperTitle: state => state.title.toUpperCase()
+}
+  `,
+        },
+      ]

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> {}
+}
+        `,
+  },
+]