Argument of type '"blob"' is not assignable to parameter of type 'ResponseType' in SPFX project
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 38/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- typescript
- Domain
- api
Research direction
Start with the responseType("blob") call in src/webparts/helloWorld/HelloWorldWebPart.ts and inspect the @microsoft/sp-http 1.18.2 types used by MSGraphClientV3. Run gulp serve to reproduce the TypeScript error; done means the blob response type is accepted and the sample builds successfully.
Written by the indexing model from the issue text.
Description
Bug Report
Hello, I've created a new web part in my SPFX project and my SPFX package version was upgraded from 1.17 to 1.18 automatically by the creation wizard.
This seem to have brought a breaking change with existing Microsoft Graph code used in the project.
Prerequisites
- Can you reproduce the problem?
- Are you running the latest version?
- Are you reporting to the correct repository?
- Did you perform a cursory search?
For more information, see the CONTRIBUTING guide.
Description
Here is my code:
private async _getUserProfilePicture(): Promise<HTMLImageElement | void> {
return await this.context.msGraphClientFactory.getClient('3').then(
async (graphclient: MSGraphClientV3) => {
return await graphclient
.api('/me/photo/$value')
.responseType("blob")
.get()
// eslint-disable-next-line @typescript-eslint/no-explicit-any
.then((blob: Blob): Promise<any> => {
// eslint-disable-next-line no-async-promise-executor
return new Promise(async (resolve, reject) => {
const b64 = await blobToBase64(blob);
const img = new Image();
img.src = b64;
this.properties.hasProfilePicture = true;
return resolve(img);
});
})
.catch((e) => {
// ...
});
});
And the IDE error:
Argument of type '"blob"' is not assignable to parameter of type 'ResponseType'.ts(2345)
Console Errors: [Is there any console error]
Screenshots: [If applicable, add screenshots to help explain your problem]
Steps to Reproduce
- Create a new folder and initialize a new SPFX solution:
yo @microsoft/sharepoint - Choose WebPart for the client-side component and React for template, leave everything else default
- Install the @microsoft/sp-http package for the MSGraphClientV3:
npm i @microsoft/sp-http - Modify config/serve.json with your SharePoint tenant URL
- Open up
src/webparts/helloWorld/HelloWorldWebPart.ts - Modify the
onInitmethod to look like this:
protected async onInit(): Promise<void> {
await this.context.msGraphClientFactory.getClient('3').then(
async (graphclient: MSGraphClientV3) => {
return await graphclient
.api('/me/photo/$value')
.responseType("blob")
.get()
// eslint-disable-next-line @typescript-eslint/no-explicit-any
.then((blob: Blob): Promise<any> => {
// eslint-disable-next-line no-async-promise-executor
return new Promise(async (resolve, reject) => {
return resolve(blob);
});
})
});
}
- Run the
gulp servecommand - The build will fail:
Error - [tsc] src/webparts/helloWorld/HelloWorldWebPart.ts(45,25): error TS2345: Argument of type '"blob"' is not assignable to parameter of type 'ResponseType'.
Expected behavior: [What you expected to happen]
The string "blob" to be accepted as an argument for responseType method on the GraphRequest.
Actual behavior: [What actually happened]
Cannot build because of error.
Additional Context
"@microsoft/sp-http": "^1.18.2" was installed
Usage Information
Request ID - Value of the requestId field if you are receiving a Graph API error response
SDK Version - [SDK version you are using]
- Node (Check, if using Node version of SDK)
Node Version - 18
- Browser (Check, if using Browser version of SDK)
Browser Name - [The name of Browser that you are using for SDK]
Version - [The version of the browser you are using]
- Dominant language
- TypeScript
- Stars
- 833
- Forks
- 240
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from microsoftgraph/msgraph-sdk-javascript
-
status:waiting-for-triage
Difficulty 1/5 Under an hour Newbie friendliness 62/100
-
Is anyone here? Open
Difficulty 4/5 3-5 days Newbie friendliness 25/100
microsoftgraph/msgraph-sdk-javascript#2005 · 1 reaction ·
-
Is it really correct that the Javascript version of the graph SDK doesn't offer typed requests? Openstatus:waiting-for-triage
Difficulty 5/5 Over a week Newbie friendliness 42/100
-
status:waiting-for-triage type:bug
Difficulty 3/5 1-2 days Newbie friendliness 48/100
microsoftgraph/msgraph-sdk-javascript#1999 · 2 comments · 1 reaction ·
-
status:waiting-for-triage type:bug
Difficulty 4/5 3-5 days Newbie friendliness 45/100
All issues in microsoftgraph/msgraph-sdk-javascript
Similar issues
-
Type/Bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
OpenNSW/nsw-srilanka#497 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
0xMiden/bridge-portal#132 ·
-
react-doctor severity:warning tech-debt
Difficulty 1/5 Under an hour Newbie friendliness 88/100
digidem/comapeo-cloud-app#403 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100