@microsoft/msgraph-sdk-core
Version:
Core functionalities for the Microsoft Graph JavaScript SDK
35 lines • 2.27 kB
TypeScript
import { BaseBearerTokenAuthenticationProvider } from "@microsoft/kiota-abstractions";
import { Middleware } from "@microsoft/kiota-http-fetchlibrary";
import { GraphHttpClient } from "./GraphHttpClient.js";
import { GraphTelemetryOption } from "../middleware/index.js";
/**
* Creates an instance of `GraphHttpClient`, with the provided middlewares and custom fetch implementation both parameters are optional.
* if no middlewares are provided, the default middlewares will be used.
* @param {GraphTelemetryOption} graphTelemetryOption - The telemetry options for the Graph client.
* @param {(request: string, init: RequestInit) => Promise<Response>} customFetch - The custom fetch function to use for HTTP requests.
* @param {BaseBearerTokenAuthenticationProvider} [authenticationProvider] - Optional authentication provider for bearer token.
* @param {Middleware[]} [middlewares] - Optional array of middleware to use in the HTTP pipeline.
* @returns {GraphHttpClient} - A new instance of `GraphHttpClient`.
* @example
* ```Typescript
* // Example usage of createGraphClientFactory method with graphTelemetryOption , customFetch and middlewares parameters provided
* createGraphClientFactory(graphTelemetryOption, customFetch, [middleware1, middleware2]);
* ```
* @example
* ```Typescript
* // Example usage of createGraphClientFactory method with only graphTelemetryOption and customFetch parameter provided
* createGraphClientFactory(graphTelemetryOption, customFetch);
* ```
* @example
* ```Typescript
* // Example usage of createGraphClientFactory method with only graphTelemetryOption and middlewares parameter provided
* createGraphClientFactory(graphTelemetryOption, undefined, [middleware1, middleware2]);
* ```
* @example
* ```Typescript
* // Example usage of createGraphClientFactory method with only graphTelemetryOption parameter provided
* createGraphClientFactory(graphTelemetryOption);
* ```
*/
export declare const createGraphClientFactory: (graphTelemetryOption: GraphTelemetryOption, customFetch?: (request: string, init: RequestInit) => Promise<Response>, authenticationProvider?: BaseBearerTokenAuthenticationProvider, middlewares?: Middleware[]) => GraphHttpClient;
//# sourceMappingURL=GraphClientFactory.d.ts.map