From a1550460ce8cda98998d074243c995955cf6557a Mon Sep 17 00:00:00 2001 From: Evan Almloff Date: Thu, 7 Dec 2023 11:37:59 -0600 Subject: [PATCH] Fix peek spelling --- packages/signals/src/signal.rs | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/packages/signals/src/signal.rs b/packages/signals/src/signal.rs index 6c4052b98..1dc4bd36e 100644 --- a/packages/signals/src/signal.rs +++ b/packages/signals/src/signal.rs @@ -203,7 +203,7 @@ impl Signal { self.inner.origin_scope() } - /// Get the current value of the signal. This will subscribe the current scope to the signal. If you would like to read the signal without subscribing to it, you can use [`Self::peak`] instead. + /// Get the current value of the signal. This will subscribe the current scope to the signal. If you would like to read the signal without subscribing to it, you can use [`Self::peek`] instead. /// /// If the signal has been dropped, this will panic. #[track_caller] @@ -237,7 +237,7 @@ impl Signal { /// Get the current value of the signal. **Unlike read, this will not subscribe the current scope to the signal which can cause parts of your UI to not update.** /// /// If the signal has been dropped, this will panic. - pub fn peak(&self) -> GenerationalRef { + pub fn peek(&self) -> GenerationalRef { let inner = self.inner.read(); GenerationalRef::map(inner, |v| &v.value) } @@ -428,7 +428,7 @@ impl ReadOnlySignal { self.inner.origin_scope() } - /// Get the current value of the signal. This will subscribe the current scope to the signal. If you would like to read the signal without subscribing to it, you can use [`Self::peak`] instead. + /// Get the current value of the signal. This will subscribe the current scope to the signal. If you would like to read the signal without subscribing to it, you can use [`Self::peek`] instead. /// /// If the signal has been dropped, this will panic. #[track_caller] @@ -439,8 +439,8 @@ impl ReadOnlySignal { /// Get the current value of the signal. **Unlike read, this will not subscribe the current scope to the signal which can cause parts of your UI to not update.** /// /// If the signal has been dropped, this will panic. - pub fn peak(&self) -> GenerationalRef { - self.inner.peak() + pub fn peek(&self) -> GenerationalRef { + self.inner.peek() } /// Run a closure with a reference to the signal's value.