Skip to content

typings file for module #32

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

typings file for module #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
"version": "0.3.0",
"description": "A custom React Hook that provides a multi-instance, multi-tab/browser shared and persistent state.",
"main": "dist/use-persisted-state.js",
"types": "use-persisted-state.d.ts",
"umd:main": "dist/use-persisted-state.umd.js",
"module": "dist/use-persisted-state.m.js",
"source": "src/index.js",
Expand Down
4 changes: 4 additions & 0 deletions use-persisted-state.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
declare module 'use-persisted-state' {
function createPersistedState<T>(key: string, storage: Storage): (initialState: T) => [S, Dispatch<SetStateAction<S>>];
Comment on lines +1 to +2
Copy link

@sb8244 sb8244 Jun 4, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to make storage optional via storage?: Storage, since it has a default

export = createPersistedState;
Copy link

@sb8244 sb8244 Jun 4, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since this is the default export, I had to use export default createPersistedState. Without that, it would work fine, but TS was complaining about synthetic default imports

}