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.

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

Jump to bottom

feat: add client reserved userdata property #942

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat: add client reserved userdata property #942

wants to merge 3 commits into from
+65 −0

Conversation

btsimonh
Copy link

Adds client.userdata description to client doc, and an example in examples doc.

@btsimonh
Update Client.md
47d7fab 
add details about client.userdata being free for use by users
@btsimonh
Update Examples.md
c827622 
Add an example of using client.userdata
@btsimonh
Update Examples.md
e2e4a9c 
fold up client.userdata example code to keep the page looking short.
robertsLando
robertsLando requested changes Feb 29, 2024
View reviewed changes
Copy link
Member

@robertsLando robertsLando left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would declare it also on code side and types (remember to add types test as well)

@robertsLando robertsLando changed the title Client.userdata document updates feat: add client reserved userdata property Feb 29, 2024
@btsimonh
Copy link
Author

I'll not get to these mods for a few weeks - last day before holiday today, and I don't yet have a local repo to run tests etc....
You could accept the docs change, and I'll look at the code changes as I progress my migration, and issue another PR then?
(maybe with a full working example of JWT authentication)

robertsLando
robertsLando requested changes Feb 29, 2024
View reviewed changes
docs/Examples.md
Comment on lines +113 to +116
## Client userdata

The tag `userdata` on the client structure is free for use by users to store whatever they want.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would name this section JWT Authentication and then explain that we will store JWT auth and client ip in client.userdata

@robertsLando
Copy link
Member

I'll not get to these mods for a few weeks - last day before holiday today, and I don't yet have a local repo to run tests etc.... You could accept the docs change, and I'll look at the code changes as I progress my migration, and issue another PR then? (maybe with a full working example of JWT authentication)

I prefer to merge this once it's complete

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@robertsLando robertsLando robertsLando requested changes

@gnought gnought Awaiting requested review from gnought

@getlarge getlarge Awaiting requested review from getlarge

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@btsimonh @robertsLando