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

Update README.md to reflect change to 'name' option for the service. #96

Closed
githugger opened this issue Jul 6, 2016 · 1 comment
Closed

Comments

@githugger
Copy link
Contributor

githugger commented Jul 6, 2016

The readme displays the use of a mongoose-service option "name" in the code example "Complete Example". The option and corresponding service property appear to have been deprecated with 210ccc8:

Excerpt from Complete Example in the readme:

// Connect to the db, create and register a Feathers service.
app.use('messages', service({
  name: 'message',
  Model: Message,
  paginate: {
    default: 2,
    max: 4
  }
}));

Excerpt from service.js:

// this.name = options.name;
this.Model = options.Model;
this.id = options.id || '_id';
this.paginate = options.paginate || {};
this.lean = options.lean || false;
this.overwrite = (options.overwrite === false) ? false : true;

I don't know what this option or the corresponding service property have originally been used for, but to me it seems they are not in use anymore, so I suggest changing the line of the readme. If I am not misreading the service.js and it is not the intention to add back the option in an upcoming release I can create a pull request.

Edit: Okay I just created a PR for this, because the name option does not seem to do anything in the current release.

githugger pushed a commit to githugger/feathers-mongoose that referenced this issue Jul 6, 2016
daffl pushed a commit that referenced this issue Jul 7, 2016
@daffl
Copy link
Member

daffl commented Jul 7, 2016

Closed via #97

@daffl daffl closed this as completed Jul 7, 2016
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