feat: rename Client.getAuthUrl() -> Client.makeAuthUrl()

BREAKING CHANGE: `Client.getAuthUrl()` has been renamed to `Client.makeAuthUrl()`.
ekrzeptowski · Feb 3, 2022 · ba87fdf · ba87fdf
1 parent 6ffe0cc
commit ba87fdf
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/examples/oauth/index.ts b/examples/oauth/index.ts
@@ -21,7 +21,7 @@ app.get("/", (_req, res) => res.send("Hello world!"));
 
 // When the user navigates to /login redirect them to the Reddit OAuth url.
 app.get("/login", (_req, res) => {
-  const uri = Client.getAuthUrl(
+  const uri = Client.makeAuthUrl(
     creds.clientId,
     ["identity"],
     redirectUri,

diff --git a/src/client.ts b/src/client.ts
@@ -178,7 +178,7 @@ export default class Client {
   }
 
   /**
-   * Get an OAuth login url.
+   * Make an OAuth login url.
    *
    * @param clientId The ID of the Reddit app.
    * @param scopes The scopes to authorize with.
@@ -190,7 +190,7 @@ export default class Client {
    *
    * @returns The URL to direct the user to for authorization.
    */
-  static getAuthUrl(
+  static makeAuthUrl(
     clientId: string,
     scopes: string[],
     redirectUri: string,