rename selfDependant to selfDependent (#53)

re-rxjs · Sep 22, 2023 · b71cef5 · b71cef5
1 parent 149f51d
commit b71cef5
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 9 deletions.
diff --git a/docs/api/utils/selfDependant.md → docs/api/utils/selfDependent.md b/docs/api/utils/selfDependant.md → 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<T>(): [Observable<T>, () => MonoTypeOperatorFunction<T>];
+function selfDependent<T>(): [Observable<T>, () => MonoTypeOperatorFunction<T>]
 ```
 
 #### Returns
@@ -19,11 +19,11 @@ function selfDependant<T>(): [Observable<T>, () => MonoTypeOperatorFunction<T>];
 ### 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<number>()
+const [_resettableCounter$, connectResettableCounter] = selfDependent<number>()
 
 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
+
+[pipeable operator]: https://rxjs.dev/guide/v6/pipeable-operators
diff --git 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<string>();
 
 const [useText, text$] = bind(textChange$, "")
 

diff --git 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",