From db981deab6c2ebb445255a57c80f9a197aaec930 Mon Sep 17 00:00:00 2001 From: Aymeric PINEAU Date: Thu, 25 Apr 2024 12:31:31 +0200 Subject: [PATCH] docs: update doc --- .../content_transformers/enumeration/enumeration.ts | 2 ++ .../enumeration/getEnumerationContent.ts | 13 ++++++++----- .../translation/getTranslationContent.ts | 9 +++++---- .../content_transformers/translation/translation.ts | 2 ++ .../src/middleware/intlayerMiddleware.ts | 2 ++ packages/next-intlayer/src/server/withIntlayer.ts | 2 ++ packages/react-intlayer/src/client/useTraduction.ts | 11 ++++++----- packages/react-intlayer/src/getEnumeration.ts | 13 ++++++++----- packages/react-intlayer/src/getTranslation.ts | 5 +++-- packages/react-intlayer/src/server/useTraduction.ts | 7 ++++--- 10 files changed, 42 insertions(+), 24 deletions(-) diff --git a/packages/@intlayer/core/src/transpiler/content_transformers/enumeration/enumeration.ts b/packages/@intlayer/core/src/transpiler/content_transformers/enumeration/enumeration.ts index 45a943f72..8495dcbe8 100644 --- a/packages/@intlayer/core/src/transpiler/content_transformers/enumeration/enumeration.ts +++ b/packages/@intlayer/core/src/transpiler/content_transformers/enumeration/enumeration.ts @@ -38,12 +38,14 @@ export type EnumerationContent = Partial> & * * Usage: * + * ```ts * const content = enu({ * '<=-2.3': 'You have less than -2.3', * '<1': 'You have less than one', * '2': 'You have two', * '>=3': 'You have three or more', * }); + * ``` * * The order of the keys will define the priority of the content. * diff --git a/packages/@intlayer/core/src/transpiler/content_transformers/enumeration/getEnumerationContent.ts b/packages/@intlayer/core/src/transpiler/content_transformers/enumeration/getEnumerationContent.ts index 145e185d0..1c3d0414a 100644 --- a/packages/@intlayer/core/src/transpiler/content_transformers/enumeration/getEnumerationContent.ts +++ b/packages/@intlayer/core/src/transpiler/content_transformers/enumeration/getEnumerationContent.ts @@ -7,22 +7,25 @@ type Key = keyof QuantityContent; * * Usage: * + * ```ts * const content = getEnumerationContent({ * '<=-2.3': 'You have less than -2.3', * '<1': 'You have less than one', * '2': 'You have two', * '>=3': 'You have three or more', - * }, - * 2); + * }, 2); * // 'You have two' + * ``` * * The order of the keys will define the priority of the content. * + * ```ts * const content = getEnumerationContent({ - * '<4': 'You have less than four', - * '2': 'You have two', - * }); + * '<4': 'You have less than four', + * '2': 'You have two', + * }, 2); * // 'You have less than four' + * ``` * */ export const getEnumerationContent = ( diff --git a/packages/@intlayer/core/src/transpiler/content_transformers/translation/getTranslationContent.ts b/packages/@intlayer/core/src/transpiler/content_transformers/translation/getTranslationContent.ts index c75cbd5ed..4195381f2 100644 --- a/packages/@intlayer/core/src/transpiler/content_transformers/translation/getTranslationContent.ts +++ b/packages/@intlayer/core/src/transpiler/content_transformers/translation/getTranslationContent.ts @@ -18,12 +18,13 @@ type GetTranslationContent = ( * * Usage: * + * ```ts * const content = getTranslationContent({ - * en: 'Hello', - * fr: 'Bonjour', - * }, - * 'fr'); + * en: 'Hello', + * fr: 'Bonjour', + * }, 'fr'); * // 'Bonjour' + * ``` * * Using TypeScript: * - this function will require each locale to be defined if defined in the project configuration. diff --git a/packages/@intlayer/core/src/transpiler/content_transformers/translation/translation.ts b/packages/@intlayer/core/src/transpiler/content_transformers/translation/translation.ts index e24890283..9333c9ebf 100644 --- a/packages/@intlayer/core/src/transpiler/content_transformers/translation/translation.ts +++ b/packages/@intlayer/core/src/transpiler/content_transformers/translation/translation.ts @@ -13,11 +13,13 @@ const { defaultLocale } = intlayerConfiguration.internationalization; * * Usage: * + * ```ts * translation({ * "en": "Hello", * "fr": "Bonjour", * // ... any other available locale * }) + * ``` * * Using TypeScript: * - this function require each locale to be defined if defined in the project configuration. diff --git a/packages/next-intlayer/src/middleware/intlayerMiddleware.ts b/packages/next-intlayer/src/middleware/intlayerMiddleware.ts index 5a93b01ed..7019b6070 100644 --- a/packages/next-intlayer/src/middleware/intlayerMiddleware.ts +++ b/packages/next-intlayer/src/middleware/intlayerMiddleware.ts @@ -20,12 +20,14 @@ const { * * // ./src/middleware.ts * + * ```ts * export { intlayerMiddleware as middleware } from '@intlayer/next/middleware'; * * // applies this middleware only to files in the app directory * export const config = { * matcher: '/((?!api|static|.*\\..*|_next).*)', * }; + * ``` * */ export const intlayerMiddleware = (request: NextRequest): NextResponse => { diff --git a/packages/next-intlayer/src/server/withIntlayer.ts b/packages/next-intlayer/src/server/withIntlayer.ts index 817caff0b..5c6123af3 100644 --- a/packages/next-intlayer/src/server/withIntlayer.ts +++ b/packages/next-intlayer/src/server/withIntlayer.ts @@ -16,8 +16,10 @@ type WebpackParams = Parameters; * * Usage: * + * ```ts * // next.config.js * export default withIntlayer(nextConfig) + * ``` * */ export const withIntlayer = diff --git a/packages/react-intlayer/src/client/useTraduction.ts b/packages/react-intlayer/src/client/useTraduction.ts index 3c7d9b046..6a7075e3e 100644 --- a/packages/react-intlayer/src/client/useTraduction.ts +++ b/packages/react-intlayer/src/client/useTraduction.ts @@ -12,12 +12,13 @@ import { IntlayerClientContext } from './IntlayerClientProvider'; * * Usage: * - * const content = getTranslation({ - * en: 'Hello', - * fr: 'Bonjour', - * }, - * 'fr'); + * ```tsx + * const content = useTraduction({ + * en: 'Hello', + * fr: 'Bonjour', + * }, 'fr'); * // 'Bonjour' + * ``` * * Using TypeScript: * - this function will require each locale to be defined if defined in the project configuration. diff --git a/packages/react-intlayer/src/getEnumeration.ts b/packages/react-intlayer/src/getEnumeration.ts index efc882f0d..c6f72cb35 100644 --- a/packages/react-intlayer/src/getEnumeration.ts +++ b/packages/react-intlayer/src/getEnumeration.ts @@ -8,22 +8,25 @@ import { contentRender } from './ContentEditor/contentRender'; * * Usage: * + * ```ts * const content = getEnumeration({ * '<=-2.3': 'You have less than -2.3', * '<1': 'You have less than one', * '2': 'You have two', * '>=3': 'You have three or more', - * }, - * 2); + * }, 2); * // 'You have two' + * ``` * * The order of the keys will define the priority of the content. * + * ```ts * const content = getEnumeration({ - * '<4': 'You have less than four', - * '2': 'You have two', - * }); + * '<4': 'You have less than four', + * '2': 'You have two', + * }, 2); * // 'You have less than four' + * ``` * */ export const getEnumeration = ( diff --git a/packages/react-intlayer/src/getTranslation.ts b/packages/react-intlayer/src/getTranslation.ts index d9abd5c21..34b93f264 100644 --- a/packages/react-intlayer/src/getTranslation.ts +++ b/packages/react-intlayer/src/getTranslation.ts @@ -14,12 +14,13 @@ import { contentRender } from './ContentEditor/contentRender'; * * Usage: * + * ```ts * const content = getTranslation({ * en: 'Hello', * fr: 'Bonjour', - * }, - * 'fr'); + * }, 'fr'); * // 'Bonjour' + * ``` * * Using TypeScript: * - this function will require each locale to be defined if defined in the project configuration. diff --git a/packages/react-intlayer/src/server/useTraduction.ts b/packages/react-intlayer/src/server/useTraduction.ts index 8ee2ee482..900c7387f 100644 --- a/packages/react-intlayer/src/server/useTraduction.ts +++ b/packages/react-intlayer/src/server/useTraduction.ts @@ -13,12 +13,13 @@ import { getServerContext } from './serverContext'; * * Usage: * - * const content = getTranslation({ + * ```ts + * const content = useTraduction({ * en: 'Hello', * fr: 'Bonjour', - * }, - * 'fr'); + * }, 'fr'); * // 'Bonjour' + * ``` * * Using TypeScript: * - this function will require each locale to be defined if defined in the project configuration.