Skip to content
This repository was archived by the owner on Dec 31, 2020. It is now read-only.

Commit 06a130e

Browse files
mweststratemweststrate
committed
useLocalStore -> useObservable
1 parent b3749e8 commit 06a130e

File tree

4 files changed

+29
-29
lines changed

4 files changed

+29
-29
lines changed

‎src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@ import "./assertEnvironment"
33
export { isUsingStaticRendering, useStaticRendering } from "./staticRendering"
44
export { observer, IObserverOptions } from "./observer"
55
export { Observer } from "./ObserverComponent"
6-
export { useLocalStore } from "./useLocalStore"
6+
export { useObservable } from "./useObservable"
77
export { observerBatching } from "./observerBatching"

‎src/useLocalStore.ts renamed to ‎src/useObservable.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import React from "react"
33

44
import { AnnotationsMap } from "mobx"
55

6-
export function useLocalStore<TStore extends Record<string, any>>(
6+
export function useObservable<TStore extends Record<string, any>>(
77
initializer: () => TStore,
88
annotations?: AnnotationsMap<TStore, never>
99
): TStore {

‎test/useAsObservableSource.test.tsx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { autorun, configure, observable } from "mobx"
55
import * as React from "react"
66
import { useEffect, useState } from "react"
77

8-
import { Observer, observer, useLocalStore } from "../src"
8+
import { Observer, observer, useObservable } from "../src"
99
import { resetMobx } from "./utils"
1010
import { useObserver } from "../src/useObserver"
1111

@@ -19,9 +19,9 @@ describe("base useAsObservableSource should work", () => {
1919

2020
function Counter({ multiplier }: { multiplier: number }) {
2121
counterRender++
22-
const observableProps = useLocalStore(() => ({ multiplier }))
22+
const observableProps = useObservable(() => ({ multiplier }))
2323
Object.assign(observableProps, { multiplier })
24-
const store = useLocalStore(() => ({
24+
const store = useObservable(() => ({
2525
count: 10,
2626
get multiplied() {
2727
return observableProps.multiplier * this.count
@@ -84,7 +84,7 @@ describe("base useAsObservableSource should work", () => {
8484

8585
function Counter({ multiplier }: { multiplier: number }) {
8686
counterRender++
87-
const store = useLocalStore(() => ({
87+
const store = useObservable(() => ({
8888
multiplier,
8989
count: 10,
9090
get multiplied() {
@@ -153,7 +153,7 @@ describe("base useAsObservableSource should work", () => {
153153
const Counter = observer(({ multiplier }: { multiplier: number }) => {
154154
counterRender++
155155

156-
const store = useLocalStore(() => ({
156+
const store = useObservable(() => ({
157157
multiplier,
158158
count: 10,
159159
get multiplied() {
@@ -214,7 +214,7 @@ test("useAsObservableSource with effects should work", () => {
214214
const thingsSeenByEffect: Array<[number, number, number]> = []
215215

216216
function Counter({ multiplier }: { multiplier: number }) {
217-
const store = useLocalStore(() => ({
217+
const store = useObservable(() => ({
218218
multiplier,
219219
count: 10,
220220
get multiplied() {
@@ -291,7 +291,7 @@ test("useAsObservableSource with effects should work", () => {
291291
describe("combining observer with props and stores", () => {
292292
it("keeps track of observable values", () => {
293293
const TestComponent = observer((props: any) => {
294-
const localStore = useLocalStore(() => ({
294+
const localStore = useObservable(() => ({
295295
get value() {
296296
return props.store.x + 5 * props.store.y
297297
}
@@ -317,7 +317,7 @@ describe("combining observer with props and stores", () => {
317317
const renderedValues: number[] = []
318318

319319
const TestComponent = observer((props: any) => {
320-
const localStore = useLocalStore(() => ({
320+
const localStore = useObservable(() => ({
321321
y: props.y,
322322
get value() {
323323
return props.store.x + 5 * this.y
@@ -348,7 +348,7 @@ describe("enforcing actions", () => {
348348
configure({ enforceActions: "never" })
349349
const { result } = renderHook(() => {
350350
const [thing, setThing] = React.useState("world")
351-
useLocalStore(() => ({ hello: thing }))
351+
useObservable(() => ({ hello: thing }))
352352
useEffect(() => setThing("react"), [])
353353
})
354354
expect(result.error).not.toBeDefined()
@@ -357,7 +357,7 @@ describe("enforcing actions", () => {
357357
configure({ enforceActions: "observed" })
358358
const { result } = renderHook(() => {
359359
const [thing, setThing] = React.useState("world")
360-
useLocalStore(() => ({ hello: thing }))
360+
useObservable(() => ({ hello: thing }))
361361
useEffect(() => setThing("react"), [])
362362
})
363363
expect(result.error).not.toBeDefined()
@@ -366,7 +366,7 @@ describe("enforcing actions", () => {
366366
configure({ enforceActions: "always" })
367367
const { result } = renderHook(() => {
368368
const [thing, setThing] = React.useState("world")
369-
useLocalStore(() => ({ hello: thing }))
369+
useObservable(() => ({ hello: thing }))
370370
useEffect(() => setThing("react"), [])
371371
})
372372
expect(result.error).not.toBeDefined()
@@ -377,7 +377,7 @@ it("doesn't update a component while rendering a different component - #274", ()
377377
// https://github.com/facebook/react/pull/17099
378378

379379
const Parent = observer((props: any) => {
380-
const observableProps = useLocalStore(() => props)
380+
const observableProps = useObservable(() => props)
381381
useEffect(() => {
382382
Object.assign(observableProps, props)
383383
}, [props])

‎test/useLocalStore.test.tsx

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import * as React from "react"
33
import { renderHook } from "@testing-library/react-hooks"
44
import { act, cleanup, fireEvent, render } from "@testing-library/react"
55

6-
import { Observer, observer, useLocalStore } from "../src"
6+
import { Observer, observer, useObservable } from "../src"
77
import { useEffect, useState } from "react"
88
import { autorun } from "mobx"
99
import { useObserver } from "../src/useObserver"
@@ -19,7 +19,7 @@ test("base useLocalStore should work", () => {
1919

2020
function Counter() {
2121
counterRender++
22-
const store = (outerStoreRef = useLocalStore(() => ({
22+
const store = (outerStoreRef = useObservable(() => ({
2323
count: 0,
2424
count2: 0, // not used in render
2525
inc() {
@@ -70,7 +70,7 @@ test("base useLocalStore should work", () => {
7070
describe("is used to keep observable within component body", () => {
7171
it("value can be changed over renders", () => {
7272
const TestComponent = () => {
73-
const obs = useLocalStore(() => ({
73+
const obs = useObservable(() => ({
7474
x: 1,
7575
y: 2
7676
}))
@@ -95,7 +95,7 @@ describe("is used to keep observable within component body", () => {
9595
const TestComponent = observer(() => {
9696
renderCount++
9797

98-
const obs = useLocalStore(() => ({
98+
const obs = useObservable(() => ({
9999
x: 1,
100100
y: 2
101101
}))
@@ -118,7 +118,7 @@ describe("is used to keep observable within component body", () => {
118118

119119
it("actions can be used", () => {
120120
const TestComponent = observer(() => {
121-
const obs = useLocalStore(() => ({
121+
const obs = useObservable(() => ({
122122
x: 1,
123123
y: 2,
124124
inc() {
@@ -140,7 +140,7 @@ describe("is used to keep observable within component body", () => {
140140

141141
it("computed properties works as well", () => {
142142
const TestComponent = observer(() => {
143-
const obs = useLocalStore(() => ({
143+
const obs = useObservable(() => ({
144144
x: 1,
145145
y: 2,
146146
get z() {
@@ -158,7 +158,7 @@ describe("is used to keep observable within component body", () => {
158158

159159
it("computed properties can use local functions", () => {
160160
const TestComponent = observer(() => {
161-
const obs = useLocalStore(() => ({
161+
const obs = useObservable(() => ({
162162
x: 1,
163163
y: 2,
164164
getMeThatX() {
@@ -181,7 +181,7 @@ describe("is used to keep observable within component body", () => {
181181
const seen: number[] = []
182182

183183
const TestComponent = observer(() => {
184-
const obs = useLocalStore(() => ({
184+
const obs = useObservable(() => ({
185185
x: 1,
186186
inc(delta: number) {
187187
this.x += delta
@@ -215,7 +215,7 @@ describe("is used to keep observable within component body", () => {
215215

216216
it("Map can used instead of object", () => {
217217
const TestComponent = observer(() => {
218-
const map = useLocalStore(() => new Map([["initial", 10]]))
218+
const map = useObservable(() => new Map([["initial", 10]]))
219219
return (
220220
<div onClick={() => map.set("later", 20)}>
221221
{Array.from(map).map(([key, value]) => (
@@ -241,7 +241,7 @@ describe("is used to keep observable within component body", () => {
241241
function Counter({ multiplier }: { multiplier: number }) {
242242
counterRender++
243243

244-
const store = useLocalStore(() => ({
244+
const store = useObservable(() => ({
245245
multiplier,
246246
count: 10,
247247
get multiplied() {
@@ -309,7 +309,7 @@ describe("is used to keep observable within component body", () => {
309309
function Counter({ multiplier }: { multiplier: number }) {
310310
counterRender++
311311

312-
const store = useLocalStore(() => ({
312+
const store = useObservable(() => ({
313313
multiplier,
314314
count: 10,
315315
get multiplied() {
@@ -378,7 +378,7 @@ describe("is used to keep observable within component body", () => {
378378
const Counter = observer(({ multiplier }: { multiplier: number }) => {
379379
counterRender++
380380

381-
const store = useLocalStore(() => ({
381+
const store = useObservable(() => ({
382382
multiplier,
383383
count: 10,
384384
get multiplied() {
@@ -437,7 +437,7 @@ describe("enforcing actions", () => {
437437
mobx.configure({ enforceActions: "never" })
438438
const { result } = renderHook(() => {
439439
const [multiplier, setMultiplier] = React.useState(2)
440-
const store = useLocalStore(() => ({
440+
const store = useObservable(() => ({
441441
multiplier,
442442
count: 10,
443443
get multiplied() {
@@ -458,7 +458,7 @@ describe("enforcing actions", () => {
458458
mobx.configure({ enforceActions: "observed" })
459459
const { result } = renderHook(() => {
460460
const [multiplier, setMultiplier] = React.useState(2)
461-
const store = useLocalStore(() => ({
461+
const store = useObservable(() => ({
462462
multiplier,
463463
count: 10,
464464
get multiplied() {
@@ -479,7 +479,7 @@ describe("enforcing actions", () => {
479479
mobx.configure({ enforceActions: "always" })
480480
const { result } = renderHook(() => {
481481
const [multiplier, setMultiplier] = React.useState(2)
482-
const store = useLocalStore(() => ({
482+
const store = useObservable(() => ({
483483
multiplier,
484484
count: 10,
485485
get multiplied() {

0 commit comments

Comments
 (0)