Skip to content

Commit d5ddb4e

Browse files
authored
Soft deprecate is_kv_bucket_stream?/1 in favor of kv_bucket_stream?/1 (#183)
* Soft deprecate is_kv_bucket_stream?/1 in favor of kv_bucket_stream?/1 the `is_` prefix is [reserved for guards](https://hexdocs.pm/elixir/1.18.1/naming-conventions.html#is_-prefix-is_foo) by convention. This PR aligns the function name with the convention for [functions that return booleans](https://hexdocs.pm/elixir/1.18.1/naming-conventions.html#trailing-question-mark-foo)
1 parent 3635276 commit d5ddb4e

File tree

1 file changed

+17
-7
lines changed
  • lib/gnat/jetstream/api

1 file changed

+17
-7
lines changed

lib/gnat/jetstream/api/kv.ex

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,11 @@ defmodule Gnat.Jetstream.API.KV do
233233
end)
234234
"""
235235
def watch(conn, bucket_name, handler) do
236-
Gnat.Jetstream.API.KV.Watcher.start_link(conn: conn, bucket_name: bucket_name, handler: handler)
236+
Gnat.Jetstream.API.KV.Watcher.start_link(
237+
conn: conn,
238+
bucket_name: bucket_name,
239+
handler: handler
240+
)
237241
end
238242

239243
@doc ~S"""
@@ -265,14 +269,20 @@ defmodule Gnat.Jetstream.API.KV do
265269
end
266270
end
267271

272+
@spec is_kv_bucket_stream?(stream_name :: binary()) :: boolean()
273+
@deprecated "Use Gnat.Jetstream.API.KV.kv_bucket_stream?/1 instead"
274+
def is_kv_bucket_stream?(stream_name) do
275+
kv_bucket_stream?(stream_name)
276+
end
277+
268278
@doc """
269279
Returns true if the provided stream is a KV bucket, false otherwise
270280
271281
## Parameters
272282
* `stream_name` - the stream name to test
273283
"""
274-
@spec is_kv_bucket_stream?(stream_name :: binary()) :: boolean()
275-
def is_kv_bucket_stream?(stream_name) do
284+
@spec kv_bucket_stream?(stream_name :: binary()) :: boolean()
285+
def kv_bucket_stream?(stream_name) do
276286
String.starts_with?(stream_name, "KV_")
277287
end
278288

@@ -285,20 +295,20 @@ defmodule Gnat.Jetstream.API.KV do
285295
stream_names =
286296
streams
287297
|> Enum.flat_map(fn bucket ->
288-
if is_kv_bucket_stream?(bucket) do
289-
[bucket |> String.trim_leading(@stream_prefix)]
298+
if kv_bucket_stream?(bucket) do
299+
[bucket |> String.trim_leading(@stream_prefix)]
290300
else
291-
[]
301+
[]
292302
end
293303
end)
304+
294305
{:ok, stream_names}
295306
else
296307
{:error, reason} ->
297308
{:error, reason}
298309
end
299310
end
300311

301-
302312
@doc false
303313
def stream_name(bucket_name) do
304314
"#{@stream_prefix}#{bucket_name}"

0 commit comments

Comments
 (0)