Skip to content

Reverse EventCallback state$ and inputs$ order #115

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

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ function App() {
type RestrictArray<T> = T extends any[] ? T : []
type InputFactory<State, Inputs = undefined> = Inputs extends undefined
? (state$: Observable<State>) => Observable<State>
: (inputs$: Observable<RestrictArray<Inputs>>, state$: Observable<State>) => Observable<State>
: (state$: Observable<State>, inputs$: Observable<RestrictArray<Inputs>>) => Observable<State>

declare function useObservable<State>(inputFactory: InputFactory<State>): State | null
declare function useObservable<State>(inputFactory: InputFactory<State>, initialState: State): State
Expand Down Expand Up @@ -140,7 +140,7 @@ import { of } from 'rxjs'
import { map } from 'rxjs/operators'

function App(props: { foo: number }) {
const value = useObservable((inputs$) => inputs$.pipe(
const value = useObservable((_, inputs$) => inputs$.pipe(
map(([val]) => val + 1),
), 200, [props.foo])
return (
Expand Down Expand Up @@ -202,8 +202,8 @@ type EventCallback<EventValue, State, Inputs> = Inputs extends void
? (eventSource$: Observable<EventValue>, state$: Observable<State>) => Observable<State>
: (
eventSource$: Observable<EventValue>,
inputs$: Observable<RestrictArray<Inputs>>,
state$: Observable<State>,
inputs$: Observable<RestrictArray<Inputs>>,
) => Observable<State>

declare function useEventCallback<EventValue, State = void>(
Expand Down Expand Up @@ -335,7 +335,7 @@ import "./styles.css";
function App() {
const [count, setCount] = useState(0);
const [clickCallback, [description, x, y, prevDesc]] = useEventCallback(
(event$, inputs$, state$) =>
(event$, state$, inputs$) =>
event$.pipe(
map(event => [event.target.innerHTML, event.clientX, event.clientY]),
combineLatest(inputs$),
Expand Down
4 changes: 2 additions & 2 deletions playground/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ const mockBackendRequest = (event$: Observable<React.MouseEvent<HTMLHeadElement>

function IntervalValue(props: { interval: number }) {
const [clickCallback, value] = useEventCallback(mockBackendRequest, 0, [])
const intervalValue = useObservable(
(inputs$, _) =>
const intervalValue = useObservable<number, number[]>(
(_, inputs$) =>
inputs$.pipe(
switchMap(([intervalTime]) => interval(intervalTime)),
scan((acc) => acc + 1, 0),
Expand Down
2 changes: 1 addition & 1 deletion src/__test__/use-event-callback.spec.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -134,8 +134,8 @@ describe('useEventCallback specs', () => {
const timeToDelay = 200
const factory = (
event$: Observable<React.MouseEvent<HTMLButtonElement>>,
inputs$: Observable<number[]>,
_state$: Observable<number>,
inputs$: Observable<number[]>,
): Observable<number> =>
event$.pipe(
combineLatest(inputs$),
Expand Down
9 changes: 5 additions & 4 deletions src/__test__/use-observable.spec.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -121,10 +121,11 @@ describe('useObservable specs', () => {
const spy = Sinon.spy()
const timeToDelay = 200
function Fixture(props: { foo: number; bar: string; baz: any }) {
const value = useObservable((inputs$: Observable<[number, any] | null>) => inputs$.pipe(tap(spy)), null, [
props.foo,
props.baz,
] as any)
const value = useObservable(
(_: Observable<number | null>, inputs$: Observable<[number, any] | null>) => inputs$.pipe(tap(spy)),
null,
[props.foo, props.baz] as any,
)
return (
<>
<h1>{value && value[0]}</h1>
Expand Down
4 changes: 2 additions & 2 deletions src/use-event-callback.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ export type EventCallback<EventValue, State, Inputs> = Not<
Inputs extends void ? true : false,
(
eventSource$: Observable<EventValue>,
inputs$: Observable<RestrictArray<Inputs>>,
state$: Observable<State>,
inputs$: Observable<RestrictArray<Inputs>>,
) => Observable<State>,
(eventSource$: Observable<EventValue>, state$: Observable<State>) => Observable<State>
>
Expand Down Expand Up @@ -67,7 +67,7 @@ export function useEventCallback<EventValue, State = void, Inputs = void>(
if (!inputs) {
value$ = (callback as EventCallback<EventValue, State, void>)(event$, state$ as Observable<State>)
} else {
value$ = (callback as any)(event$, inputs$ as Observable<Inputs>, state$ as Observable<State>)
value$ = (callback as any)(event$, state$ as Observable<State>, inputs$ as Observable<Inputs>)
}
const subscription = value$.subscribe((value) => {
state$.next(value)
Expand Down
23 changes: 15 additions & 8 deletions src/use-observable.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,18 @@ import useConstant from 'use-constant'

import { RestrictArray } from './type'

export type InputFactory<State> = (state$: Observable<State>) => Observable<State>;
export type InputFactoryWithInputs<State, Inputs> = (inputs$: Observable<RestrictArray<Inputs>>, state$: Observable<State>) => Observable<State>;
export function useObservable<State>(inputFactory: InputFactory<State>): State | null;
export function useObservable<State>(inputFactory: InputFactory<State>, initialState: State): State;
export function useObservable<State, Inputs>(inputFactory: InputFactoryWithInputs<State, Inputs>, initialState: State, inputs: RestrictArray<Inputs>): State;
export type InputFactory<State> = (state$: Observable<State>) => Observable<State>
export type InputFactoryWithInputs<State, Inputs> = (
state$: Observable<State>,
inputs$: Observable<RestrictArray<Inputs>>,
) => Observable<State>
export function useObservable<State>(inputFactory: InputFactory<State>): State | null
export function useObservable<State>(inputFactory: InputFactory<State>, initialState: State): State
export function useObservable<State, Inputs>(
inputFactory: InputFactoryWithInputs<State, Inputs>,
initialState: State,
inputs: RestrictArray<Inputs>,
): State
export function useObservable<State, Inputs extends ReadonlyArray<any>>(
inputFactory: InputFactoryWithInputs<State, Inputs>,
initialState?: State,
Expand All @@ -27,11 +34,11 @@ export function useObservable<State, Inputs extends ReadonlyArray<any>>(
let output$: BehaviorSubject<State>
if (inputs) {
output$ = (inputFactory as (
inputs$: Observable<RestrictArray<Inputs> | undefined>,
state$: Observable<State | undefined>,
) => Observable<State>)(inputs$, state$) as BehaviorSubject<State>
inputs$: Observable<RestrictArray<Inputs> | undefined>,
) => Observable<State>)(state$, inputs$) as BehaviorSubject<State>
} else {
output$ = (inputFactory as unknown as (state$: Observable<State | undefined>) => Observable<State>)(
output$ = ((inputFactory as unknown) as (state$: Observable<State | undefined>) => Observable<State>)(
state$,
) as BehaviorSubject<State>
}
Expand Down