Add run_once function for when polling is not needed

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v1.1.0 - 2024-10-25
+
+- Add `run_once` function for when polling is not needed.
+
 ## v1.0.0 - 2024-10-21
 
 - Initial release with `local_epmd`, `epmd` and `dns` strategies, as well as support

README.md

@@ -89,6 +89,29 @@ pub fn main() {
 }
 ```
 
+### Run the refresh function once
+
+If you don't need any sort of polling, or want to manage your the refresh lifecycle
+yourself, you can call the `run_once` function to run the refresh function a single
+time.
+
+In this case, most of the configuration options will be ignored.
+
+```gleam
+import barnacle
+
+pub fn main() {
+  // Configure your Barnacle
+  let barnacle =
+    barnacle.local_epmd()
+
+  // Run the refresh function once
+  barnacle.run_once(barnacle)
+
+  // Continue your program...
+}
+```
+
 ## Strategies
 
 Barnacle ships with a few built-in strategies, but you can also supply your own by

gleam.toml

@@ -1,5 +1,5 @@
 name = "barnacle"
-version = "1.0.0"
+version = "1.1.0"
 
 description = "Self-healing clusters for Gleam applications on the BEAM!"
 licences = ["MIT"]

src/barnacle.gleam

@@ -257,6 +257,15 @@ pub fn child_spec(
   })
 }
 
+/// Run the refresh function once only. This will not start the actor, and will
+/// not do any polling.
+///
+/// In this case, most configuration options are irrelevant and will be ignored.
+pub fn run_once(barnacle: Barnacle(error)) {
+  barnacle
+  |> refresh_nodes
+}
+
 /// Refresh a barnacle actor. This will attempt to connect to new nodes, and
 /// disconnect from nodes that are no longer available.
 ///