Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Fix a typo in a comment in runtime.js #3149

Merged
merged 1 commit into from
Sep 25, 2024
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
58 changes: 29 additions & 29 deletions inlang/source-code/paraglide/paraglide-js/src/compiler/runtime.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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")
* }
Expand All @@ -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
*/
Expand Down Expand Up @@ -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}\`
* })
Expand All @@ -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}
*/
Expand All @@ -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
*/`
}
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading