From 53596ab5dab83b8444118de7a0d303e074087984 Mon Sep 17 00:00:00 2001 From: edgesoft Date: Tue, 14 Dec 2021 05:15:54 +0100 Subject: [PATCH] docs: (fix) typos --- docs/authenticator.md | 2 +- docs/strategies/kcd.md | 4 ++-- src/authenticator.ts | 4 ++-- src/strategies/kcd.ts | 4 ++-- src/strategies/oauth2.ts | 8 ++++---- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/authenticator.md b/docs/authenticator.md index 7813286..e88c35d 100644 --- a/docs/authenticator.md +++ b/docs/authenticator.md @@ -94,7 +94,7 @@ export let loader: LoaderFunction = async ({ request }) => { }; export default function Login() { - // In the view, we will render our login form and do a POST againt /login to + // In the view, we will render our login form and do a POST against /login to // trigger our action and authenticate the user, you may also want to change // it to use the Form component from Remix in case you provide a custom loading // state to your form diff --git a/docs/strategies/kcd.md b/docs/strategies/kcd.md index 6139d11..30a9647 100644 --- a/docs/strategies/kcd.md +++ b/docs/strategies/kcd.md @@ -143,7 +143,7 @@ import { sessionStorage } from "~/services/session.server"; export let loader: LoaderFunction = async ({ request }) => { await auth.authenticate("kcd", request, { // If the user was authenticated, we redirect them to their profile page - // This redirect is optional, if not defined the user will be returnted by + // This redirect is optional, if not defined the user will be returned by // the `authenticate` function and you can render something on this page // manually redirect the user. successRedirect: "/me", @@ -262,7 +262,7 @@ interface KCDStrategyOptions { * email address as a string and return a Promise. The value of the Promise * will be ignored, in case of error throw an error. * - * By default it only test the email agains the RegExp `/.+@.+/`. + * By default it only test the email against the RegExp `/.+@.+/`. */ verifyEmailAddress?: KCDVerifyEmailFunction; /** diff --git a/src/authenticator.ts b/src/authenticator.ts index 25a9240..83d1b87 100644 --- a/src/authenticator.ts +++ b/src/authenticator.ts @@ -147,7 +147,7 @@ export class Authenticator { /** * Call this to check if the user is authenticated. It will return a Promise * with the user object or null, you can use this to check if the user is - * logged-in or not withour triggering the whole authentication flow. + * logged-in or not without triggering the whole authentication flow. * @example * let loader: LoaderFunction = async ({ request }) => { * // if the user is not authenticated, redirect to login @@ -170,7 +170,7 @@ export class Authenticator { * // manually handle what happens if the user is or not authenticated * let user = await authenticator.isAuthenticated(request); * if (!user) return json(publicData); - * return essionLoader(request); + * return sessionLoader(request); * } */ async isAuthenticated( diff --git a/src/strategies/kcd.ts b/src/strategies/kcd.ts index 2afad5f..58db176 100644 --- a/src/strategies/kcd.ts +++ b/src/strategies/kcd.ts @@ -31,7 +31,7 @@ export interface KCDMagicLinkPayload { */ emailAddress: string; /** - * Whent the magic link was created, as an ISO string. This is used to check + * When the magic link was created, as an ISO string. This is used to check * the email link is still valid. */ creationDate: string; @@ -60,7 +60,7 @@ export interface KCDStrategyOptions { * email address as a string and return a Promise. The value of the Promise * will be ignored, in case of error throw an error. * - * By default it only test the email agains the RegExp `/.+@.+/`. + * By default it only test the email against the RegExp `/.+@.+/`. */ verifyEmailAddress?: KCDVerifyEmailFunction; /** diff --git a/src/strategies/oauth2.ts b/src/strategies/oauth2.ts index 0f81898..8774709 100644 --- a/src/strategies/oauth2.ts +++ b/src/strategies/oauth2.ts @@ -64,7 +64,7 @@ export interface OAuth2StrategyVerifyCallback< * - `authorizationURL` URL used to obtain an authorization grant * - `tokenURL` URL used to obtain an access token * - `clientID` identifies client to service provider - * - `clientSecret` secret used to establish ownership of the client identifer + * - `clientSecret` secret used to establish ownership of the client identifier * - `callbackURL` URL to which the service provider will redirect the user after obtaining authorization * * @example @@ -197,7 +197,7 @@ export class OAuth2Strategy< /** * Retrieve user profile from service provider. * - * OAuth 2.0-based authentication strategies can overrride this function in + * OAuth 2.0-based authentication strategies can override this function in * order to load the user's profile from the service provider. This assists * applications (and users of those applications) in the initial registration * process by automatically submitting required information. @@ -217,7 +217,7 @@ export class OAuth2Strategy< * Some OAuth 2.0 providers allow additional, non-standard parameters to be * included when requesting authorization. Since these parameters are not * standardized by the OAuth 2.0 specification, OAuth 2.0-based authentication - * strategies can overrride this function in order to populate these + * strategies can override this function in order to populate these * parameters as required by the provider. */ protected authorizationParams(): URLSearchParams { @@ -230,7 +230,7 @@ export class OAuth2Strategy< * Some OAuth 2.0 providers allow additional, non-standard parameters to be * included when requesting an access token. Since these parameters are not * standardized by the OAuth 2.0 specification, OAuth 2.0-based authentication - * strategies can overrride this function in order to populate these + * strategies can override this function in order to populate these * parameters as required by the provider. */ protected tokenParams(): URLSearchParams {