Rename install() to use() (#29359)

GitOrigin-RevId: 45231b104168569e9ad5123ce9357b0cece0d92e
get-convex · Aug 30, 2024 · 036e1b3 · 036e1b3
1 parent dcefdc7
commit 036e1b3
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 11 deletions.
diff --git a/npm-packages/component-tests/envVars/convex.config.ts b/npm-packages/component-tests/envVars/convex.config.ts
@@ -4,7 +4,7 @@ import { defineComponent } from "convex/server";
 import { default as otherComponent } from "../component/convex.config";
 
 const component = defineComponent("envVars");
-component.install(otherComponent, {
+component.use(otherComponent, {
   name: "component",
 });
 

diff --git a/npm-packages/component-tests/projects/basic/convex/convex.config.ts b/npm-packages/component-tests/projects/basic/convex/convex.config.ts
@@ -8,7 +8,7 @@ import errors from "../../../errors/convex.config";
 // @ts-ignore
 const app = defineApp();
 
-app.install(errors);
-app.install(envVars);
+app.use(errors);
+app.use(envVars);
 
 export default app;
diff --git a/npm-packages/component-tests/projects/mounted/convex/convex.config.ts b/npm-packages/component-tests/projects/mounted/convex/convex.config.ts
@@ -8,7 +8,7 @@ import envVars from "../../../envVars/convex.config";
 // @ts-ignore
 const app = defineApp();
 
-app.install(component);
-app.install(envVars);
+app.use(component);
+app.use(envVars);
 
 export default app;
diff --git a/npm-packages/component-tests/projects/with-schema/convex/convex.config.ts b/npm-packages/component-tests/projects/with-schema/convex/convex.config.ts
@@ -7,6 +7,6 @@ import component from "../../../component/convex.config";
 // @ts-ignore
 const app = defineApp();
 
-app.install(component);
+app.use(component);
 
 export default app;
diff --git a/npm-packages/convex/src/server/components/index.ts b/npm-packages/convex/src/server/components/index.ts
@@ -75,7 +75,7 @@ export type ComponentDefinition<Exports extends ComponentExports = any> = {
    * For editor tooling this method expects a {@link ComponentDefinition}
    * but at runtime the object that is imported will be a {@link ImportedComponentDefinition}
    */
-  install<Definition extends ComponentDefinition<any>>(
+  use<Definition extends ComponentDefinition<any>>(
     definition: Definition,
     options?: {
       name?: string;
@@ -106,7 +106,7 @@ export type AppDefinition = {
    * For editor tooling this method expects a {@link ComponentDefinition}
    * but at runtime the object that is imported will be a {@link ImportedComponentDefinition}
    */
-  install<Definition extends ComponentDefinition<any>>(
+  use<Definition extends ComponentDefinition<any>>(
     definition: Definition,
     options?: {
       name?: string;
@@ -186,7 +186,7 @@ function createExports(name: string, pathParts: string[]): any {
   return new Proxy({}, handler);
 }
 
-function install<Definition extends ComponentDefinition<any>>(
+function use<Definition extends ComponentDefinition<any>>(
   this: CommonDefinitionData,
   definition: Definition,
   options?: {
@@ -336,7 +336,7 @@ export function defineComponent<Exports extends ComponentExports = any>(
     _onInitCallbacks: {},
 
     export: exportComponentForAnalysis,
-    install,
+    use,
 
     // pretend to conform to ComponentDefinition, which temporarily expects __args
     ...({} as { __args: any; __exports: any }),
@@ -355,7 +355,7 @@ export function defineApp(): AppDefinition {
     _exportTree: {},
 
     export: exportAppForAnalysis,
-    install,
+    use,
   };
   return ret as AppDefinition;
 }