README.md snippet does not compile

[chrisribe]

• Package Name:
• @azure-rest/health-deidentification
  • https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/healthdataaiservices/azure-health-deidentification/README.md
• Package Version:
• 1.0.0-beta.1 (2024-08-15)
• Operating system:
• nodejs
  • version: v20.17.0
• browser
  • name/version: N/A
• typescript
  • version: Version 5.6.3
• Is the bug related to documentation in
  • README.md
  • source code documentation
  • SDK API docs on https://learn.microsoft.com

Describe the bug

• The current documentation snippet does not compile because calling await outside of an async function is invalid.
• The use of isUnexpected is invalid in this context response.ts does not have this defined. Expected output interface is DeidentificationResultOutput

To Reproduce
Steps to reproduce the behavior:

1. Take snippet code + tsc compile + run

Expected behavior
Expecting a working simple snippet

Screenshots

Additional context
Code suggestion: Provide a more robust sample in TypeScript and Plain JS.

PlainJS

const { DefaultAzureCredential } = require("@azure/identity");
const createClient = require("@azure-rest/health-deidentification").default;
const dotenv = require("dotenv");
dotenv.config();

const credential = new DefaultAzureCredential();
const serviceEndpoint = "<xyz-url>.api.deid.azure.com";
const client = createClient(serviceEndpoint, credential);

const content = {
  inputText: "Hello John!"
};

async function postToDeid() {
  console.log("Posting:", content.inputText);
  const response = await client.path("/deid").post({ body: content });

  if(response.status == 200){
	console.log("Result:", response.body.outputText);
  }
  else if (response.body && response.body.error) {
    throw response.body.error;
  } else {
    throw new Error(`Unexpected response without error details. Status: ${response.status}, Headers: ${JSON.stringify(response.headers)}, Body: ${JSON.stringify(response.body)}`);	
  }
}

postToDeid().catch((err) => {
  if (err instanceof Error) {
    console.error("Error message:", err.message);
    console.error("Error stack:", err.stack);
    console.error("Error details:", err);
  } else {
    console.error("Unknown error:", err);
  }
});

[github-actions]

@KarishmaGhiya @maorleger

[github-actions]

Thank you for your feedback. Tagging and routing to the team member best able to assist.

[github-actions]

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @GrahamMThomas.

[jeremymeng]

/cc @danielszaniszlo