Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

docs: (fix) typos #89

Merged
merged 1 commit into from
Dec 14, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/authenticator.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 /# to
// In the view, we will render our login form and do a POST against /# 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
Expand Down
4 changes: 2 additions & 2 deletions docs/strategies/kcd.md
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -262,7 +262,7 @@ interface KCDStrategyOptions<User> {
* 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;
/**
Expand Down
4 changes: 2 additions & 2 deletions src/authenticator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ export class Authenticator<User = unknown> {
/**
* 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
Expand All @@ -170,7 +170,7 @@ export class Authenticator<User = unknown> {
* // 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(
Expand Down
4 changes: 2 additions & 2 deletions src/strategies/kcd.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -60,7 +60,7 @@ export interface KCDStrategyOptions<User> {
* 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;
/**
Expand Down
8 changes: 4 additions & 4 deletions src/strategies/oauth2.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand All @@ -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 {
Expand All @@ -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 {
Expand Down