Référence de l'API d'internationalisation
Ajouté à la version :
astro@3.5.0
Ce module fournit des fonctions pour vous aider à créer des URL à l’aide des paramètres régionaux configurés de votre projet.
La création de routes pour votre projet avec le routeur i18n dépendra de certaines valeurs de configuration que vous avez définies et qui affectent les routes de vos pages. Lorsque vous créez des routes avec ces fonctions, veillez à prendre en compte vos paramètres individuels pour :
Notez également que les URL renvoyées créées par ces fonctions pour votre defaultLocale
refléteront votre configuration i18n.routing
.
Pour les fonctionnalités et les exemples d’utilisation, consultez notre guide de routage i18n.
Importations depuis astro:i18n
Titre de la section Importations depuis astro:i18ngetRelativeLocaleUrl()
Titre de la section getRelativeLocaleUrl()Type : (locale: string, path?: string, options?: GetLocaleOptions) => string
Utilisez cette fonction pour récupérer un chemin relatif pour des paramètres régionaux. Si les paramètres régionaux n’existent pas, Astro renvoie une erreur.
getAbsoluteLocaleUrl()
Titre de la section getAbsoluteLocaleUrl()Type : (locale: string, path: string, options?: GetLocaleOptions) => string
Utilisez cette fonction pour récupérer un chemin absolu pour des paramètres régionaux lorsque [site
] a une valeur. Si [site
] n’est pas configuré, la fonction renvoie une URL relative. Si les paramètres régionaux n’existent pas, Astro renvoie une erreur.
getRelativeLocaleUrlList()
Titre de la section getRelativeLocaleUrlList()Type : (path?: string, options?: GetLocaleOptions) => string[]
Utilisez cette fonction de la même manière que getRelativeLocaleUrl
pour renvoyer une liste de chemins relatifs pour tous les paramètres régionaux.
getAbsoluteLocaleUrlList()
Titre de la section getAbsoluteLocaleUrlList()Type : (path?: string, options?: GetLocaleOptions) => string[]
Utilisez cette fonction de la même manière que getAbsoluteLocaleUrl
pour renvoyer une liste de chemins absolus pour tous les paramètres régionaux.
getPathByLocale()
Titre de la section getPathByLocale()Type : (locale: string) => string
Une fonction qui renvoie le chemin (path
) associé à un ou plusieurs codes
lorsque les chemins de paramètres régionaux personnalisés sont configurés.
getLocaleByPath()
Titre de la section getLocaleByPath()Type : (path: string) => string
Une fonction qui renvoie le code
associé à un chemin (path
) de paramètres régionaux.
redirectToDefaultLocale()
Titre de la section redirectToDefaultLocale()Type : (context: APIContext, statusCode?: ValidRedirectStatus) => Promise<Response>
astro@4.6.0
Disponible uniquement lorsque i18n.routing
est défini sur "manual"
Une fonction qui renvoie une Response
qui redirige vers les paramètres régionaux utilisés par défaut (defaultLocale
). Il accepte un code d’état de redirection valide facultatif.
redirectToFallback()
Titre de la section redirectToFallback()Type : (context: APIContext, response: Response) => Promise<Response>
astro@4.6.0
Disponible uniquement lorsque i18n.routing
est défini sur "manual"
Une fonction qui vous permet d’utiliser votre configuration i18n.fallback
dans votre propre middleware.
notFound()
Titre de la section notFound()Type : (context: APIContext, response?: Response) => Promise<Response> | undefined
astro@4.6.0
Disponible uniquement lorsque i18n.routing
est défini sur "manual"
Utilisez cette fonction dans votre middleware de routage pour renvoyer une 404 lorsque :
- le chemin actuel n’est pas une racine, par exemple
/
ou/<base>
- l’URL ne contient pas de paramètres régionaux
Lorsqu’une Response
est transmise, la nouvelle Response
émise par cette fonction contiendra les mêmes en-têtes que la réponse d’origine.
middleware()
Titre de la section middleware()Type : (options: { prefixDefaultLocale: boolean, redirectToDefaultLocale: boolean }) => MiddlewareHandler
astro@4.6.0
Disponible uniquement lorsque i18n.routing
est défini sur "manual"
Une fonction qui vous permet de créer par programmation le middleware i18n d’Astro.
Ceci est utile lorsque vous souhaitez utiliser la logique i18n par défaut tout en ajoutant quelques exceptions pour votre site.
requestHasLocale()
Titre de la section requestHasLocale()Type : (context: APIContext) => boolean
astro@4.6.0
Disponible uniquement lorsque i18n.routing
est défini sur "manual"
Vérifie si l’URL actuelle contient des paramètres régionaux configurés. En interne, cette fonction utilisera APIContext#url.pathname
.