Class PhraseyTranslation

constructor

• new PhraseyTranslation(path, schema, locale, extras, fallback): PhraseyTranslation

• Parameters

  • path: string

  • schema: PhraseySchema

  • locale: PhraseyLocaleType

  • extras: Record<string, any>

  • fallback: string[]

  Returns PhraseyTranslation

extras

fallback

keys

locale

path

schema

stats

getKey

• getKey(key): undefined | PhraseyTranslationStringValue

• Parameters

  • key: string

  Returns undefined | PhraseyTranslationStringValue

hasKey

• hasKey(key): boolean

• Parameters

  • key: string

  Returns boolean

json

• json(stringFormatter): PhraseyTranslationJson

• Parameters

  • stringFormatter: PhraseyTranslationStringFormatter<any>

  Returns PhraseyTranslationJson

keysCount

• keysCount(): number

• Returns number

setKey

• setKey(key, value): void

• Parameters

  • key: string

  • value: PhraseyTranslationStringValue

  Returns void

Static create

• create(path, schema, formatter, locales, globalFallback): Promise<PhraseyResult<PhraseyTranslation, Error>>

• Parameters

  • path: string

  • schema: PhraseySchema

  • formatter: PhraseyContentFormatter

  • locales: PhraseyLocales

  • globalFallback: string[]

  Returns Promise<PhraseyResult<PhraseyTranslation, Error>>

Static parseTranslationKeyValue

• parseTranslationKeyValue(key, content): PhraseyResult<PhraseyTranslationStringPart[], Error>

• Parameters

  • key: {
        description?: string;
        name: string;
        parameters?: string[];
    }

    • Optional description?: string

    • name: string

    • Optional parameters?: string[]

  • content: string

  Returns PhraseyResult<PhraseyTranslationStringPart[], Error>