convex/src/cli/codegen_templates/common.ts

Client for the Convex Cloud

import { version } from "../version.js";

export function header(oneLineDescription: string) {
  return `/* eslint-disable */
  /**
   * ${oneLineDescription}
   * 
   * THIS CODE IS AUTOMATICALLY GENERATED.
   * 
   * Generated by convex@${version}.
   * To regenerate, run \`npx convex dev\`.
   * @module
   */
  `;
}

/**
 * We generate JS files as .d.ts and .js so that they are usable by both
 * JavaScript and TypeScript developers.
 */
export type GeneratedJsWithTypes = {
  DTS: string;
  JS?: string;
};