-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #14 from umbrellio/feature/jsdoc-type-coverage
Types for better intellisense
- Loading branch information
Showing
10 changed files
with
154 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| import { Component, PureComponent, FC } from "react" | ||
|
|
||
| export declare type SubscribeFn<T> = (data: T) => void | ||
|
|
||
| export declare type UnsubscribeFn = () => void | ||
|
|
||
| export declare type MapFn<T> = (data: T) => T | any | ||
|
|
||
| export declare type ReactComponent<Props, State, SnapShot> = ( | ||
| Component<Props, State, SnapShot> | PureComponent<Props, State, SnapShot> | FC<Props> | ||
| ) | ||
|
|
||
| export declare type ComponentWrapper<Props, State, SnapShot> = ( | ||
| (component: ReactComponent<Props, State, SnapShot>) => Component<Props, State, SnapShot> | ||
| ) | ||
|
|
||
| export declare interface Store<State> { | ||
| getState(): State | ||
| set(data: Partial<State>): void | ||
| observer<ComponentState, ComponentSnapShot> | ||
| (options: ObserverOptions<State>): Observer<State, ComponentState, ComponentSnapShot> | ||
| subscribe(sub: SubscribeFn<State>): UnsubscribeFn | ||
| reset(): void | ||
| } | ||
|
|
||
| export declare interface ObserverOptions<T> { | ||
| key: string | ||
| map: MapFn<T> | ||
| } | ||
|
|
||
| export declare interface Observer<State, ComponentState, ComponentSnapShot> { | ||
| (store: Store<State>, options?: ObserverOptions<State>): | ||
| ComponentWrapper<State, ComponentState, ComponentSnapShot> | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| import { Component } from "react" | ||
|
|
||
| import { Store, ReactComponent, MapFn } from "./common" | ||
|
|
||
| declare interface StoreConfig<T> { | ||
| store: Store<T> | ||
| key: string | ||
| map?: MapFn<T> | ||
| } | ||
|
|
||
| declare type Wrapper<Props, State, SnapShot> = ( | ||
| (component: ReactComponent<Props, State, SnapShot>) => Component<Props, State, SnapShot> | ||
| ) | ||
|
|
||
| declare function multipleObserver<State, ComponentState, ComponentSnapShot> | ||
| (stores: [StoreConfig<State>]): Wrapper<State, ComponentState, ComponentSnapShot> | ||
|
|
||
| declare function multipleObserver<T1, T2, S, SS> | ||
| (stores: [StoreConfig<T1>, StoreConfig<T2>]): Wrapper<T1 & T2, S, SS> | ||
|
|
||
| declare function multipleObserver<T1, T2, T3, S, SS> | ||
| (stores: [StoreConfig<T1>, StoreConfig<T2>, StoreConfig<T3>]): Wrapper<T1 & T2 & T3, S, SS> | ||
|
|
||
| declare function multipleObserver<T1, T2, T3, T4, S, SS> | ||
| (stores: [StoreConfig<T1>, StoreConfig<T2>, StoreConfig<T3>, StoreConfig<T4>]): Wrapper<T1 & T2 & T3 & T4, S, SS> | ||
|
|
||
| declare function multipleObserver<T1, T2, T3, T4, T5, S, SS> | ||
| (stores: [StoreConfig<T1>, StoreConfig<T2>, StoreConfig<T3>, StoreConfig<T4>, StoreConfig<T5>]): Wrapper<T1 & T2 & T3 & T4 & T5, S, SS> | ||
|
|
||
| declare function multipleObserver<T1, T2, T3, T4, T5, T6, S, SS> | ||
| (stores: [StoreConfig<T1>, StoreConfig<T2>, StoreConfig<T3>, StoreConfig<T4>, StoreConfig<T5>, StoreConfig<T6>]): Wrapper<T1 & T2 & T3 & T4 & T5 & T6, S, SS> | ||
|
|
||
| declare function multipleObserver<T1, T2, T3, T4, T5, T6, T7, S, SS> | ||
| (stores: [StoreConfig<T1>, StoreConfig<T2>, StoreConfig<T3>, StoreConfig<T4>, StoreConfig<T5>, StoreConfig<T6>, StoreConfig<T7>]): Wrapper<T1 & T2 & T3 & T4 & T5 & T6 & T7, S, SS> | ||
|
|
||
| export default multipleObserver |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| import { Store } from "./common" | ||
|
|
||
| declare function observable<T> (initialData: T): Store<T> | ||
|
|
||
| export default observable |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| import { ComponentWrapper, ObserverOptions, Store } from "./common" | ||
|
|
||
| declare function observer<State, ComponentState, ComponentSnapShot> | ||
| (store: Store<State>, options?: ObserverOptions<State>): | ||
| ComponentWrapper<State, ComponentState, ComponentSnapShot> | ||
|
|
||
| export default observer |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| import { Store, MapFn } from "./common" | ||
|
|
||
| declare interface Options<T> { | ||
| map: MapFn<T> | ||
| } | ||
|
|
||
| declare function useStore<T> (store: Store<T>, options?: Options<T>): T | ||
|
|
||
| export default useStore |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters