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

improve API naming #31

Closed
kMutagene opened this issue Sep 10, 2024 · 0 comments · Fixed by #36
Closed

improve API naming #31

kMutagene opened this issue Sep 10, 2024 · 0 comments · Fixed by #36
Assignees

Comments

@kMutagene
Copy link
Member

kMutagene commented Sep 10, 2024

I suggest we make it absolutely clear that the APIs of DynamicObj/DynObj handles dynamic properties, and should therefore reflect that in the naming of methods.

Examples:

//Current API state
let a = DynamicObj()
a.SetValue("some prop", 42)
a.GetValue("some prop")

a |> DynObj.tryGetTypedValue<int> "some prop"
a |> DynObj.remove "some prop"
//Proposed naming changes
let a = DynamicObj()
a.SetProperty("some prop", 42)
a.GetPropertyValue("some prop")

a |> DynObj.tryGetTypedPropertyValue<int> "some prop"
a |> DynObj.removeProperty "some prop"

cc @HLWeil

@github-actions github-actions bot added the Status: Needs Triage This item is up for investigation. label Sep 10, 2024
@kMutagene kMutagene self-assigned this Sep 10, 2024
@kMutagene kMutagene moved this to In discussion in ARCStack Sep 10, 2024
@kMutagene kMutagene removed the Status: Needs Triage This item is up for investigation. label Sep 10, 2024
@kMutagene kMutagene linked a pull request Sep 23, 2024 that will close this issue
@github-project-automation github-project-automation bot moved this from In review to Done in ARCStack Sep 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant