Giters

Azure / azure-sdk-for-js

This repository is for active development of the Azure SDK for JavaScript (NodeJS & Browser). For consumers of the SDK we recommend visiting our public developer docs at https://docs.microsoft.com/javascript/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-js.

Repository from Github https://github.comAzure/azure-sdk-for-jsRepository from Github https://github.comAzure/azure-sdk-for-js

[@azure-rest/ai-inference] client instanciation is not following JS standards

sinedied opened this issue · comments

commented
  • Package Name: @azure-rest/ai-inference
  • Package Version: 1.0.0-beta.5
  • Operating system: MacOS
  • nodejs
    • version: v22.13.1
  • browser
    • name/version:
  • typescript
    • version: 5.8.2
  • Is the bug related to documentation in

Describe the bug
It's not specific to this SDK, but while using something like const client = ModelClient(...) works, as a JS dev the syntax looks confusing: it's a generally accepted standard in JS/TS that only classes should use an uppercase, so we can distinguish constructors from regular functions.

Many linters also throw in an error on this syntax, so it can be an issue in enterprise contexts:
Image

The real issue might only be the documentation and sample code though, as in code the function is properly named createClient():

azure-sdk-for-js/sdk/ai/ai-inference-rest/src/modelClient.ts

Line 24 in 93f4001

export default function createClient(

Expected behavior
I would expect the documentation and sample code to follow commonly accepted JS/TS conventions, hence using a regular createClient() factory function and not a ModelClient() method that could be confused as a class constructor.

It might also be interesting to export the createClient() for as default export (to keep compatibility) but also as a proper named export. Having to mix both default exports and named export is generally considered an anti-pattern (again, often triggering linter errors/warnings).

commented

I like the idea of naming this factory export createFooClient()