API

getOptions()

Retrieves current airport instance's options.

Arguments

• none

Returns

• (Option): current instance's option

const options = airport.getOptions()

getLocale()

Retrieves current locale.

Arguments

• none

Returns

• (LocaleText): current locale in string

const locale = airport.getLocale()

getLanguage()

Retrieves current language.

Arguments

• none

Returns

• (string): current language in string

const language = airport.getLanguage()

getRegion()

Retrieves current region.

Arguments

• none

Returns

• (string): current region in string

const region = airport.getRegion()

changeLocale(locale: LocaleText)

Change locale to desired locale.

Arguments

• locale(LocaleText): Any entry in supportedLocales to change locale to.

Returns

• none

const newLocale = `ko`
airport.changeLocale(newLocale)

t(ls, variableMap?: Record<any,any>, _forcedLocale?: LocaleText)

Function that selects appropriate text from language set according to current locale. Dynamic values can be applied by passing variableMap as a second parameter.

Arguments

• ls can be any of the types below:
  • lso(LSO): Language Set Object(LSO) that has values for all supported locales.
  • partialLso(PartialLSO): Language Set Object that has values for at least 1 supported locales.
  • globalLSKey(keyof G): key of global Langauge Set Object.
• variableMap(Record<any,any>)(optional): Key-value object that has values to substitute from text.
• _forcedLocale(LocaleText)(optional): locale to apply instead of current airport instance's locale.

Returns

• (string): Current locale's text from ls. Returns '' if current locale entry doesn't exist in ls.

// lso
const createLS = createLSFactory<LocaleType>()
const LS = createLS({
  helloFull: {
    ko: '안녕하세요',
    en: 'Hello',
  },
})
console.log(airport.t(LS.helloFull))

// partialLSO
export const createPartialLS = createLSFactory<LocaleType, false>()
const PartialLS = createPartialLS({
  helloPartial: {
    en: 'Hello',
  }
})
console.log(airport.t(LS.helloPartial))

// globalLSKey
// Assume that airport has been initialized with global LSO that has 'hello' entry.
console.log(airport.t('hello')) 

// dynamic variable
export const createPartialLS = createLSFactory<LocaleType, false>()
const dynamicVarLS = createPartialLS({
  hello: {
    en: 'Hello, {name}',
  }
})
console.log(airport.t(dynamicVarLS.hello, { name: 'Jun' }))

// forced locale
export const createLS = createLSFactory<LocaleType>()
const LS = createLS({
  hello: {
    ko: '안녕하세요',
    en: 'Hello',
  }
})
console.log(airport.t(LS.hello, undefined, 'ko'))

fn(value: number, options?: ImprovedNumberFormatOptions, _forcedLocale?: T[number])

Formats given number value appropriate to current locale

Arguments

• value(number): number to format
• options(ImprovedNumberFormatOptions)(optional): options for format with extra options added from Intl.NumberFormatOptions
• _forcedLocale(LocaleText)(optional): custom locale to apply instead of current locale.

Returns

• (string): formatted number in current locale's number format.

console.log(airport.fn(10000))

fc(value: number, customFormat?: string, baseCurrency?: Currency, isFixedCurrency = false, _forcedLocale?: T[number])

Formats given number to current locale's currency. (Uses Option.currencyMap, Option.currencyFormatValueKey,Option.currencyFormat)

Arguments

• value(number): number to format as currency.
• customFormat(string)(optional): custom format to apply instead of Option.currencyFormat.
• baseCurrency(Currency)(optional): currency of value. baseCurrency is required if isFixedCurrency is true.
• isFixedCurrency(boolean)(optional): if isFixedCurrency is true, value will not be exchanged and formatted to current locale's currency.
• _forcedLocale(LocaleText)(optional): custom locale to apply instead of current locale.

Returns

• (string): formatted number in current locale's currency.

// Assume that airport has been constructed with following option:
// 
// locale: 'ko-KR',
// currency: {
//   'ko-KR': 'KRW',
//   'en-US': 'USD',
// },
// currencyFormat: {
//   'USD': 'USD {v}',
//   'KRW': 'KRW {v},  
// },
// keyCurrency: Currency.USD,
// exchangeRate: {
//   [Currency.USD]: 1,
//   [Currency.KRW]: 1000,
// }

// KRW 10,000
console.log(airport.fc(10000)) 
// KRW 10,000,000
console.log(airport.fc(10000, undefined, USD))
// USD 10,000
console.log(airport.fc(10000, undefined, USD, true))