Skip to content
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.

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

Rename getPresences to getUsers #618

Closed
wants to merge 4 commits into from
Closed

Rename getPresences to getUsers #618

wants to merge 4 commits into from

Conversation

chacha912
Copy link
Contributor

What this PR does / why we need it?

Rename doc.getPresences() to doc.getUsers() as the returned value aligns more closely with user information, making this name easier to comprehend.

The reason users is used in getUsers is that using clients (as yorkie Client) might imply that it should hold all information about the yorkie client. However, users only contain clientID and presence information, so I used the term users instead of clients.

Any background context you want to provide?

What are the relevant tickets?

Related yorkie-team/yorkie#609, yorkie-team/yorkie#665

Checklist

  • Added relevant tests or not required
  • Didn't break anything

@hackerwins hackerwins added the discussion 💭 Need to be discussed label Aug 18, 2023
@codecov
Copy link

codecov bot commented Aug 21, 2023

Codecov Report

Merging #618 (cfbd698) into main (2ac69bb) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     yorkie-team/yorkie-js-sdk#618   +/-   ##
=======================================
  Coverage   88.62%   88.62%           
=======================================
  Files          80       80           
  Lines        8893     8893           
  Branches      817      817           
=======================================
  Hits         7881     7881           
  Misses        704      704           
  Partials      308      308           
Files Changed Coverage Δ
src/client/client.ts 76.81% <ø> (ø)
src/document/document.ts 76.27% <100.00%> (ø)
test/integration/presence_test.ts 100.00% <100.00%> (ø)

@hackerwins
Copy link
Member

I will close this PR for now. Please let me know when you proceed.

@hackerwins hackerwins closed this Nov 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion 💭 Need to be discussed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants