Skip to content

Commit

Permalink
require types file w/ Config type
Browse files Browse the repository at this point in the history
  • Loading branch information
dOrgJelli committed Feb 1, 2020
1 parent b223207 commit 6d07744
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions rfcs/0003-mutations.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ resolvers:
types: ./index.d.ts
```
NOTE: `resolvers.types` is optional, and is only required if the resolvers module exports a state builder. More on this below.
NOTE: `resolvers.types` is required. More on this below.

### Mutations Schema

Expand Down Expand Up @@ -383,13 +383,15 @@ export default {

// Required Types
export {
Config,
State,
EventMap,
MyEvent
}
```

NOTE: If the resolvers module exports a `stateBuilder`, it's expected that the mutations manifest has a `resolvers.types` file defined. The following types are expected to be defined in the .d.ts type definition file:
NOTE: It's expected that the mutations manifest has a `resolvers.types` file defined. The following types must be defined in the .d.ts type definition file:
- `Config`
- `State`
- `EventMap`
- Any `EventPayload` interfaces defined within the `EventMap`
Expand Down

0 comments on commit 6d07744

Please sign in to comment.