diff --git a/docs/api/utils/selfDependant.md b/docs/api/utils/selfDependent.md similarity index 70% rename from docs/api/utils/selfDependant.md rename to docs/api/utils/selfDependent.md index a75984f..fcbce7f 100644 --- a/docs/api/utils/selfDependant.md +++ b/docs/api/utils/selfDependent.md @@ -1,11 +1,11 @@ --- -title: selfDependant() +title: selfDependent() --- A utility for creating observables that have circular dependencies. ```ts -function selfDependant(): [Observable, () => MonoTypeOperatorFunction]; +function selfDependent(): [Observable, () => MonoTypeOperatorFunction] ``` #### Returns @@ -19,11 +19,11 @@ function selfDependant(): [Observable, () => MonoTypeOperatorFunction]; ### Example ```ts -import { merge, of, Subject } from 'rxjs' -import { delay, map, share, switchMapTo, withLatestFrom } from 'rxjs/operators' -import { selfDependant } from '@react-rxjs/utils' +import { merge, of, Subject } from "rxjs" +import { delay, map, share, switchMapTo, withLatestFrom } from "rxjs/operators" +import { selfDependent } from "@react-rxjs/utils" -const [_resettableCounter$, connectResettableCounter] = selfDependant() +const [_resettableCounter$, connectResettableCounter] = selfDependent() const clicks$ = new Subject() const inc$ = clicks$.pipe( @@ -39,4 +39,5 @@ const resettableCounter$ = merge(inc$, reset$, of(0)).pipe( connectResettableCounter(), ) ``` -[pipeable operator]: https://rxjs.dev/guide/v6/pipeable-operators \ No newline at end of file + +[pipeable operator]: https://rxjs.dev/guide/v6/pipeable-operators diff --git a/docs/getting-started.md b/docs/getting-started.md index 32c2b84..4f98106 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -28,7 +28,7 @@ import { bind } from "@react-rxjs/core" import { createSignal } from "@react-rxjs/utils" // A signal is an entry point to react-rxjs. It's equivalent to using a subject -const [textChange$, setText] = createSignal(); +const [textChange$, setText] = createSignal(); const [useText, text$] = bind(textChange$, "") diff --git a/sidebars.js b/sidebars.js index 2f80110..83fcd52 100644 --- a/sidebars.js +++ b/sidebars.js @@ -27,7 +27,7 @@ module.exports = { "api/utils/createKeyedSignal", "api/utils/mergeWithKey", "api/utils/partitionByKey", - "api/utils/selfDependant", + "api/utils/selfDependent", "api/utils/suspend", "api/utils/suspended", "api/utils/switchMapSuspended",