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

Fix of Fields documentation #1125

Merged
merged 2 commits into from
Mar 31, 2020
Merged

Fix of Fields documentation #1125

merged 2 commits into from
Mar 31, 2020

Conversation

AJIXuMuK
Copy link
Contributor

Category

  • Bug fix?
  • New feature?
  • New sample?
  • Documentation update?

What's in this Pull Request?

The PR fixes some issues in Fields documentation related to return types of get and add requests.

1. `await sp.web.lists.getById('id').fields.getById('id')();` returns `IFieldInfo`, not `IField`
2. `IFieldInfo` can't be used for `select` requests, like `field.select('Title'). `IField` instance should be used instead
3. Adding a field returns `IFieldAddInfo` type, not `IField`
@AJIXuMuK AJIXuMuK changed the title Patch 1 Fix of Fields documentation Mar 27, 2020
@patrick-rodgers
Copy link
Member

Thanks Alex, probably a copy paste error on my part, great to get it fixed!

@patrick-rodgers patrick-rodgers added this to the 2.0.4 milestone Mar 31, 2020
@patrick-rodgers patrick-rodgers merged commit ab613c1 into pnp:version-2 Mar 31, 2020
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 10, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants