azure-sdk-for-js/sdk/core/core-http-compat
Jeremy Meng 6a2c7300eb [eslint-plugin] add rule "@typescript-eslint/consistent-type-imports": "warn"
- apply lint:fix results

- revert fixes that are not related to consistent-type-imports and cases error

- regenerate .api.md files

- format

- update core-comparison diff
2024-10-30 15:48:52 +00:00
..
config [EngSys] Enable Rush build cache for for common packages (#27409) 2023-10-19 14:22:44 -07:00
review [eslint-plugin] add rule "@typescript-eslint/consistent-type-imports": "warn" 2024-10-30 15:48:52 +00:00
src [eslint-plugin] add rule "@typescript-eslint/consistent-type-imports": "warn" 2024-10-30 15:48:52 +00:00
test [eslint-plugin] add rule "@typescript-eslint/consistent-type-imports": "warn" 2024-10-30 15:48:52 +00:00
CHANGELOG.md Post release automated changes for core releases (#29269) 2024-04-11 13:46:11 -04:00
LICENSE Initial version of Shim Project (#20034) 2022-02-16 16:21:43 -08:00
README.md [@azure/core-http-compat] Rename ExtendedOptions to ExtendedClientOptions (#20433) 2022-02-18 12:12:51 -08:00
api-extractor.json [core] Upgrade to ES-Modules for core (#26238) 2024-02-20 17:42:23 +00:00
package.json [EngSys] use vendored version of `mkdirp` and `rimraf` from dev-tool 2024-10-23 17:53:07 +00:00
tsconfig.browser.config.json [core] Add README snippets for core (#31204) 2024-09-25 09:35:12 -04:00
tsconfig.json [EngSys] remove tsconfig.package.json 2024-07-16 13:27:25 +00:00
vitest.browser.config.ts [core] Add README snippets for core (#31204) 2024-09-25 09:35:12 -04:00
vitest.config.ts [core] Add README snippets for core (#31204) 2024-09-25 09:35:12 -04:00

README.md

Azure Core HTTP Compatibility library for JavaScript

This library provides classes and interfaces to be used by Azure client libraries that want to move from using @azure/core-http to @azure/core-client & @azure/core-rest-pipeline without causing breaking changes in their public API surface.

Usage

ExtendedCommonClientOptions

With @azure/core-http library, the options parameter to the custom client will look like:

export interface SearchClientOptions extends PipelineOptions {
  apiVersion?: string;
}

With the @azure/core-client & @azure/core-rest-pipeline libraries, the options parameter to the custom client will look like:

export interface SearchClientOptions extends CommonClientOptions {
  apiVersion?: string;
}

With the Core HTTP Compatibility library, the options parameter to the custom client will look like:

export interface SearchClientOptions extends ExtendedCommonClientOptions {
  apiVersion?: string;
}