Home / Function/ generateCircularDependencyAnalysisRaw() — typescript-sdk Function Reference

generateCircularDependencyAnalysisRaw() — typescript-sdk Function Reference

Architecture documentation for the generateCircularDependencyAnalysisRaw() function in DefaultApi.ts from the typescript-sdk codebase.

Entity Profile

Dependency Diagram

graph TD
  16910354_f818_10fb_fd49_e5755374a9c2["generateCircularDependencyAnalysisRaw()"]
  b7d2b026_c00a_c475_4db1_f933e2985624["generateCircularDependencyAnalysis()"]
  b7d2b026_c00a_c475_4db1_f933e2985624 -->|calls| 16910354_f818_10fb_fd49_e5755374a9c2
  74960889_775b_bd9a_fdec_2cb4ceaa6c56["request()"]
  16910354_f818_10fb_fd49_e5755374a9c2 -->|calls| 74960889_775b_bd9a_fdec_2cb4ceaa6c56
  b7d2b026_c00a_c475_4db1_f933e2985624["generateCircularDependencyAnalysis()"]
  16910354_f818_10fb_fd49_e5755374a9c2 -->|calls| b7d2b026_c00a_c475_4db1_f933e2985624
  127aee54_a736_b134_3830_b9d334cc2bf3["apiKey()"]
  16910354_f818_10fb_fd49_e5755374a9c2 -->|calls| 127aee54_a736_b134_3830_b9d334cc2bf3
  50f1658c_dac3_fca2_706e_547ab98e76be["canConsumeForm()"]
  16910354_f818_10fb_fd49_e5755374a9c2 -->|calls| 50f1658c_dac3_fca2_706e_547ab98e76be
  style 16910354_f818_10fb_fd49_e5755374a9c2 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/apis/DefaultApi.ts lines 172–228

    async generateCircularDependencyAnalysisRaw(requestParameters: GenerateCircularDependencyAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CircularDependencyResponseAsync>> {
        if (requestParameters['idempotencyKey'] == null) {
            throw new runtime.RequiredError(
                'idempotencyKey',
                'Required parameter "idempotencyKey" was null or undefined when calling generateCircularDependencyAnalysis().'
            );
        }

        if (requestParameters['file'] == null) {
            throw new runtime.RequiredError(
                'file',
                'Required parameter "file" was null or undefined when calling generateCircularDependencyAnalysis().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

        if (requestParameters['idempotencyKey'] != null) {
            headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
        }

        if (this.configuration && this.configuration.apiKey) {
            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
        }

        const consumes: runtime.Consume[] = [
            { contentType: 'multipart/form-data' },
        ];
        // @ts-ignore: canConsumeForm may be unused
        const canConsumeForm = runtime.canConsumeForm(consumes);

        let formParams: { append(param: string, value: any): any };
        let useForm = false;
        // use FormData to transmit files using content-type "multipart/form-data"
        useForm = canConsumeForm;
        if (useForm) {
            formParams = new FormData();
        } else {
            formParams = new URLSearchParams();
        }

        if (requestParameters['file'] != null) {
            formParams.append('file', requestParameters['file'] as any);
        }

        const response = await this.request({
            path: `/v1/analysis/circular-dependencies`,
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: formParams,
        }, initOverrides);

        return new runtime.JSONApiResponse(response, (jsonValue) => CircularDependencyResponseAsyncFromJSON(jsonValue));
    }

Domain

Subdomains

Frequently Asked Questions

What does generateCircularDependencyAnalysisRaw() do?
generateCircularDependencyAnalysisRaw() is a function in the typescript-sdk codebase.
What does generateCircularDependencyAnalysisRaw() call?
generateCircularDependencyAnalysisRaw() calls 4 function(s): apiKey, canConsumeForm, generateCircularDependencyAnalysis, request.
What calls generateCircularDependencyAnalysisRaw()?
generateCircularDependencyAnalysisRaw() is called by 1 function(s): generateCircularDependencyAnalysis.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free