Skip to content

presence: Fix get_by_key documentation and typespec inconsistencies #6719

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wondr-wclabs wants to merge 1 commit into
base: main
Choose a base branch
from
+2 −2
Open

presence: Fix get_by_key documentation and typespec inconsistencies #6719

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions lib/phoenix/presence.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,12 +312,12 @@ defmodule Phoenix.Presence do
devices, could return:

iex> MyPresence.get_by_key("room:1", "user1")
[%{name: "User 1", metas: [%{device: "Desktop"}, %{device: "Mobile"}]}]
%{name: "User 1", metas: [%{device: "Desktop"}, %{device: "Mobile"}]}

Like `c:list/1`, the presence metadata is passed to the `fetch`
callback of your presence module to fetch any additional information.
"""
@callback get_by_key(Phoenix.Socket.t() | topic, key :: String.t()) :: [presence]
@callback get_by_key(Phoenix.Socket.t() | topic, key :: String.t()) :: map() | []

@doc """
Extend presence information with additional data.
Expand Down