-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[WIP] Update Type Definitions and API Docs to Make Sure They Match #5
base: master
Are you sure you want to change the base?
Conversation
Apologies if these are dumb questions, but since I'm not fully an expert in typescript, I need to be honest about gaps in my knowledge and ask a few questions:
|
|
||
### `type MigrationManifest` | ||
```js | ||
{ | ||
[number]: (State) => State | ||
[string]: (State) => State |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I changed this to a string type to match what's in the types.ts file, but I'm wondering, is number correct here? If you look at the migrations.md example, the keys are numbers. So, is the types.ts file wrong or is the api.md
and migrations.md
files wrong?
I'm trying to go through the Type Definitions and API docs to make sure that they're up to date and fully documented. So far, here are the ones I've found:
deserialize
property toPersistConfig
type interface. Updates the APIs docs accordingly. Mentioned in original repo here: #1443