api.md

Classes

Name	Description
LocaleUtils	Utility class for loading locale files

Typedefs

Name	Description
LocaleManifest	Locale settings and known locale file paths
LocalePathPart	Partial URL representing a directory containing locale .json files or a URL template with a :locale path param to a .json file.
LocalePathThunk	Callback which receives a context object for resolving a LocalePathPath
LocalePathPartOrThunk	A localePathPart string or callback which returns one
LocalePath	URL path to a locale .json file
Lang	Language code only
Locale	Language code with region
LocalesState	State of loaded locale files
LocalesProps	Props for a Next.js page containing locale and initial state
LocaleStatus	Fetch status of a locale file

LocaleUtils

Utility class for loading locale files

Kind: global class

• LocaleUtils
  • new LocaleUtils(config)
  • .getFallbackLocale(locale)
  • .formatLocalePath(localePathPart, locale)
  • .resolveLocalePathPart(localePathPart, [context])
  • .getLocalePath(localePathPart, locale, [context])
  • .pathToUrl(localePath)
  • .serverLoadData(localePathPart, locale, localesDir)

new LocaleUtils(config)

Param	Type	Description
config	Object	Configuration
config.manifest	LocaleManifest	Locale file manifest
[config.basePath]	string	Locale file base path. Defaults to manifest.basePath

localeUtils.getFallbackLocale(locale)

Fallback to the lang part of a locale or to defaultLocale. Strategy is: <locale lang (if doesn't match default lang)> <default locale (if a locale)> null

Here's an example using da-DK/da with en-US as defaultLocale da-DK ==> da ==> en-US ==> en ==> null

Kind: instance method of LocaleUtils
Returns: Locale ⎮ Lang ⎮ null - language - fallback language to use.

Param	Type	Description
locale	Locale	Current locale

localeUtils.formatLocalePath(localePathPart, locale)

Format a localePath with provided locale. Ensures path starts with slash and ends with .json file.

Kind: instance method of LocaleUtils
Returns: LocalePath - localePath

Param	Type	Description
localePathPart	LocalePathPart	Path containing locale files
locale	Locale	Locale

localeUtils.resolveLocalePathPart(localePathPart, [context])

Get a localePathPart from provided string or thunk callback results

Kind: instance method of LocaleUtils
Returns: LocalePath - localePath

Param	Type	Description
localePathPart	LocalePathPartOrThunk	Path containing locale files
[context]	object	Context

localeUtils.getLocalePath(localePathPart, locale, [context])

Get a formatted localePath considering language mappings and fallbacks

Kind: instance method of LocaleUtils
Returns: LocalePath - localePath

Param	Type	Description
localePathPart	LocalePathPartOrThunk	Path containing locale files
locale	Locale	Locale
[context]	object	Context

localeUtils.pathToUrl(localePath)

Add base path from window.gasket.intl or manifest if set to the locale path

Kind: instance method of LocaleUtils
Returns: string - url

Param	Type	Description
localePath	LocalePath	URL path to a locale file

localeUtils.serverLoadData(localePathPart, locale, localesDir)

Load locale file(s) and return localesProps. Throws error if attempted to use in browser.

Kind: instance method of LocaleUtils
Returns: LocalesProps - localesProps

Param	Type	Description
localePathPart	LocalePathPart | Array.<LocalePathPart>	Path(s) containing locale files
locale	Locale	Locale to load
localesDir	string	Disk path to locale files dir

LocaleStatus

Enum for local status values

Kind: global enum
Properties

Name	Type	Default
LOADING	LocaleStatus	loading
LOADED	LocaleStatus	loaded
ERROR	LocaleStatus	error

• LocaleStatus
  • .LOADING
  • .LOADED
  • .ERROR

LocaleStatus.LOADING

Kind: static property of LocaleStatus
Default: loading

LocaleStatus.LOADED

Kind: static property of LocaleStatus
Default: loaded

LocaleStatus.ERROR

Kind: static property of LocaleStatus
Default: error

LocaleManifest

Locale settings and known locale file paths

Kind: global typedef
Properties

Name	Type	Description
[basePath]	string	Base URL where locale files are served
localesPath	LocalePathPart	Path to endpoint with JSON files
defaultLocale	Locale	Locale to fallback to when loading files
[localesMap]	Object	Mapping of locales to share files
paths	Object	Available locale files to content hashes

LocalePathPart

Partial URL representing a directory containing locale .json files or a URL template with a :locale path param to a .json file.

Kind: global typedef
Example

"/locales"

Example

// as a template
"/locales/:locale/component.json"

Example

// other param formats
"/locales/$locale/component.json"
"/locales/{locale}/component.json"

LocalePathThunk

Callback which receives a context object for resolving a LocalePathPath

Kind: global typedef
Returns: string - localePathPart

Param	Type
context	object

LocalePathPartOrThunk

A localePathPart string or callback which returns one

Kind: global typedef

LocalePath

URL path to a locale .json file

Kind: global typedef
Example

"/locales/en-US.json"

Example

// from a template
"/locales/en-US/component.json"

Lang

Language code only

Kind: global typedef
Example

"en"

Locale

Language code with region

Kind: global typedef
Example

"en-US"

LocalesState

State of loaded locale files

Kind: global typedef
Properties

Name	Type
messages	Object
status	Object

LocalesProps

Props for a Next.js page containing locale and initial state

Kind: global typedef
Properties

Name	Type
locale	Locale

LocaleStatus

Fetch status of a locale file

Kind: global typedef
Read only: true

• LocaleStatus
  • .LOADING
  • .LOADED
  • .ERROR

LocaleStatus.LOADING

Kind: static property of LocaleStatus
Default: loading

LocaleStatus.LOADED

Kind: static property of LocaleStatus
Default: loaded

LocaleStatus.ERROR

Kind: static property of LocaleStatus
Default: error