Function pushTsRpcMethodJsDoc

scripts/codegen/typescript.ts:95–123

(
    lines: string[],
    indent: string,
    method: RpcMethod,
    options: {
        summaryFallback?: string;
        paramsName?: string;
        paramsDescription?: string;
        includeDeprecated?: boolean;
        includeExperimental?: boolean;
    } = {}
)

}

function pushTsRpcMethodJsDoc(
    lines: string[],
    indent: string,
    method: RpcMethod,
    options: {
        summaryFallback?: string;
        paramsName?: string;
        paramsDescription?: string;
        includeDeprecated?: boolean;
        includeExperimental?: boolean;
    } = {}
): void {
    const entries: string[] = [];
    entries.push(method.description ?? options.summaryFallback ?? `Calls \`${method.rpcMethod}\`.`);
    if (options.paramsName && options.paramsDescription) {
        entries.push(`@param ${options.paramsName} ${options.paramsDescription}`);
    }
    const resultDescription = rpcResultDescription(method);
    if (resultDescription) {
        entries.push(`@returns ${resultDescription}`);
    }
    if (options.includeDeprecated) {
        entries.push("@deprecated");
    }
    if (options.includeExperimental) {
        entries.push("@experimental");
    }
    pushTsJsDoc(lines, indent, entries);
}

function toPascalCase(s: string): string {
    return fixBrandCasing(s.charAt(0).toUpperCase() + s.slice(1));