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 terminology #2

Open
MaxGfeller opened this issue May 2, 2019 · 3 comments
Open

Improve terminology #2

MaxGfeller opened this issue May 2, 2019 · 3 comments

Comments

@MaxGfeller
Copy link
Contributor

It has been pointed out to me that the terminology of certain features of this library is not optimal, especially when you learned about typical MVP patterns somewhere.

Things like instance and controller mean different things there.

My proposal would be the following:

  • resource stays the same
  • instance gets renamed to pager
  • We'll get rid of controller altogether, this can be just resource (it would reflect the relationship to resource better anyway)

Here's an example of how the resource would look like:

import { createResource, resource } from 'vuex-pagination'

let resource = createResource('books', fetchBooksPage)
// returns the same as this:
let resource = resource('books')

Let me know what you think!

@jonleesmith
Copy link

In my use I have mapped it to the name resource also so I definitely agree

@MaxGfeller
Copy link
Contributor Author

@jonleesmith Thanks for the feedback! What do you think about the instance/pager?

@MaxGfeller
Copy link
Contributor Author

controller has been renamed to resource in 1.3.0 but controller will continue to work while we're on the v1.x. In a next minor version, the use of controller will throw a deprecated warning.

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

No branches or pull requests

2 participants