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

generateDeadCodeAnalysisRaw() — typescript-sdk Function Reference

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

Entity Profile

Dependency Diagram

graph TD
  97996eb2_1128_25bb_df75_0effdc595e19["generateDeadCodeAnalysisRaw()"]
  90a8ed01_576a_b51e_d76d_000ea81ed696["generateDeadCodeAnalysis()"]
  90a8ed01_576a_b51e_d76d_000ea81ed696 -->|calls| 97996eb2_1128_25bb_df75_0effdc595e19
  74960889_775b_bd9a_fdec_2cb4ceaa6c56["request()"]
  97996eb2_1128_25bb_df75_0effdc595e19 -->|calls| 74960889_775b_bd9a_fdec_2cb4ceaa6c56
  90a8ed01_576a_b51e_d76d_000ea81ed696["generateDeadCodeAnalysis()"]
  97996eb2_1128_25bb_df75_0effdc595e19 -->|calls| 90a8ed01_576a_b51e_d76d_000ea81ed696
  127aee54_a736_b134_3830_b9d334cc2bf3["apiKey()"]
  97996eb2_1128_25bb_df75_0effdc595e19 -->|calls| 127aee54_a736_b134_3830_b9d334cc2bf3
  50f1658c_dac3_fca2_706e_547ab98e76be["canConsumeForm()"]
  97996eb2_1128_25bb_df75_0effdc595e19 -->|calls| 50f1658c_dac3_fca2_706e_547ab98e76be
  style 97996eb2_1128_25bb_df75_0effdc595e19 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/apis/DefaultApi.ts lines 243–307

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

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

        const queryParameters: any = {};

        if (requestParameters['minConfidence'] != null) {
            queryParameters['min_confidence'] = requestParameters['minConfidence'];
        }

        if (requestParameters['limit'] != null) {
            queryParameters['limit'] = requestParameters['limit'];
        }

        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/dead-code`,
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: formParams,
        }, initOverrides);

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

Domain

Subdomains

Frequently Asked Questions

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

Analyze Your Own Codebase

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

Try Supermodel Free