Merge pull request #3149 from emma-sg/fix-runtime-comment-typo

Fix a typo in a comment in runtime.js
opral · Sep 25, 2024 · be98983 · be98983
2 parents d9ba219 + f34086c
commit be98983
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 31 deletions.
diff --git a/inlang/source-code/paraglide/paraglide-js/src/compiler/runtime.ts b/inlang/source-code/paraglide/paraglide-js/src/compiler/runtime.ts
@@ -7,12 +7,12 @@ export function createRuntime(
 	opts: Pick<ProjectSettings, "languageTags" | "sourceLanguageTag">
 ): string {
 	return `/* eslint-disable */
-/** @type {((tag: AvailableLanguageTag) => void) | undefined} */ 
+/** @type {((tag: AvailableLanguageTag) => void) | undefined} */
 let _onSetLanguageTag
 
 /**
  * The project's source language tag.
- * 
+ *
  * @example
  *   if (newlySelectedLanguageTag === sourceLanguageTag){
  *     // do nothing as the source language tag is the default language
@@ -23,8 +23,8 @@ export const sourceLanguageTag = "${opts.sourceLanguageTag}"
 
 /**
  * The project's available language tags.
- * 
- * @example 
+ *
+ * @example
  *   if (availableLanguageTags.includes(userSelectedLanguageTag) === false){
  *     throw new Error("Language tag not available")
  *   }
@@ -33,33 +33,33 @@ export const availableLanguageTags = /** @type {const} */ (${JSON.stringify(opts
 
 /**
  * Get the current language tag.
- * 
+ *
  * @example
  *   if (languageTag() === "de"){
  *     console.log("Germany 🇩🇪")
  *   } else if (languageTag() === "nl"){
  *     console.log("Netherlands 🇳🇱")
  *   }
- * 
+ *
  * @type {() => AvailableLanguageTag}
  */
 export let languageTag = () => sourceLanguageTag
 
 /**
  * Set the language tag.
- * 
- * @example 
- * 
- *   // changing to language 
+ *
+ * @example
+ *
+ *   // changing to language
  *   setLanguageTag("en")
- * 
- *   // passing a getter function also works. 
- *   // 
- *   // a getter function is useful for resolving a language tag 
+ *
+ *   // passing a getter function also works.
+ *   //
+ *   // a getter function is useful for resolving a language tag
  *   // on the server where every request has a different language tag
  *   setLanguageTag(() => {
- *     return request.langaugeTag
- *   }) 
+ *     return request.languageTag
+ *   })
  *
  * @param {AvailableLanguageTag | (() => AvailableLanguageTag)} tag
  */
@@ -93,22 +93,22 @@ function enforceLanguageTag(unsafeLanguageTag) {
 /**
  * Set the \`onSetLanguageTag()\` callback function.
  *
- * The function can be used to trigger client-side side-effects such as 
- * making a new request to the server with the updated language tag, 
- * or re-rendering the UI on the client (SPA apps).  
- * 
+ * The function can be used to trigger client-side side-effects such as
+ * making a new request to the server with the updated language tag,
+ * or re-rendering the UI on the client (SPA apps).
+ *
  * - Don't use this function on the server (!).
  *   Triggering a side-effect is only useful on the client because a server-side
- *   environment doesn't need to re-render the UI. 
- *     
+ *   environment doesn't need to re-render the UI.
+ *
  * - The \`onSetLanguageTag()\` callback can only be defined once to avoid unexpected behavior.
- * 
+ *
  * @example
- *   // if you use inlang paraglide on the server, make sure 
+ *   // if you use inlang paraglide on the server, make sure
  *   // to not call \`onSetLanguageTag()\` on the server
  *   if (isServer === false) {
  *     onSetLanguageTag((tag) => {
- *       // (for example) make a new request to the 
+ *       // (for example) make a new request to the
  *       // server with the updated language tag
  *       window.location.href = \`/\${tag}/\${window.location.pathname}\`
  *     })
@@ -122,14 +122,14 @@ export const onSetLanguageTag = (fn) => {
 
 /**
  * Check if something is an available language tag.
- * 
+ *
  * @example
  * 	if (isAvailableLanguageTag(params.locale)) {
  * 		setLanguageTag(params.locale)
  * 	} else {
  * 		setLanguageTag("en")
  * 	}
- * 
+ *
  * @param {any} thing
  * @returns {thing is AvailableLanguageTag}
  */
@@ -141,10 +141,10 @@ export function isAvailableLanguageTag(thing) {
 
 /**
  * A language tag that is available in the project.
- * 
+ *
  * @example
  *   setLanguageTag(request.languageTag as AvailableLanguageTag)
- * 
+ *
  * @typedef {typeof availableLanguageTags[number]} AvailableLanguageTag
  */`
 }
diff --git a/inlang/source-code/paraglide/paraglide-next/mocks/runtime.js b/inlang/source-code/paraglide/paraglide-next/mocks/runtime.js
@@ -52,7 +52,7 @@ export let languageTag = () => sourceLanguageTag
  *   // a getter function is useful for resolving a language tag
  *   // on the server where every request has a different language tag
  *   setLanguageTag(() => {
- *     return request.langaugeTag
+ *     return request.languageTag
  *   })
  *
  * @param {AvailableLanguageTag | (() => AvailableLanguageTag)} tag

diff --git a/inlang/source-code/paraglide/paraglide-sveltekit/mocks/runtime.js b/inlang/source-code/paraglide/paraglide-sveltekit/mocks/runtime.js
@@ -50,7 +50,7 @@ export let languageTag = () => sourceLanguageTag
  *   // a getter function is useful for resolving a language tag
  *   // on the server where every request has a different language tag
  *   setLanguageTag(() => {
- *     return request.langaugeTag
+ *     return request.languageTag
  *   })
  *
  * @param {AvailableLanguageTag | (() => AvailableLanguageTag)} tag