DoggoTranslator | @tabuckner/doggo-translator-ts

Given a language.json object, returns an instance of DoggoTranslator.

Hierarchy

DoggoTranslator

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DoggoTranslator(config: DoggoTranslatorConfig): DoggoTranslator

- Defined in doggo-translator-ts/doggo-translator-ts.ts:21
Parameters
- config: DoggoTranslatorConfig
Returns DoggoTranslator

Properties

defaultLanguage

defaultLanguage: english = LANGUAGE_TOKENS_ENUM.english

defaultResponse

defaultResponse: "Bork" = "Bork"

Private languageToken

languageToken: string

Private localeLoaderService

localeLoaderService: LocaleLoaderService = new LocaleLoaderService()

Methods

Private capitalizeFirstCharacter

capitalizeFirstCharacter(target: string): string

- Defined in doggo-translator-ts/doggo-translator-ts.ts:171
Returns a string with the first character capitalized.

Parameters
- target: string
  
  The string to format
Returns string

Private configValidation

configValidation(config: DoggoTranslatorConfig): void

- Defined in doggo-translator-ts/doggo-translator-ts.ts:72
Parameters
- config: DoggoTranslatorConfig
Returns void

Private escapeRegex

escapeRegex(target: string): string

- Defined in doggo-translator-ts/doggo-translator-ts.ts:182
Given a string, returns the string with all special characters escaped so that the translation regex see them as special characters.

Parameters
- target: string
  
  The string to escape
Returns string

getAllLanguageTokens

getAllLanguageTokens(): string[]

- Defined in doggo-translator-ts/doggo-translator-ts.ts:54
Returns available languages.

Returns string[]

Private languageAvailable

languageAvailable(languageToken: LANGUAGE_TOKENS_ENUM): boolean

- Defined in doggo-translator-ts/doggo-translator-ts.ts:92
Given a language token, will return whether the language is available.

Parameters
- languageToken: LANGUAGE_TOKENS_ENUM
Returns boolean

Private replaceSuffixes

replaceSuffixes(suffixes: object, reverse: boolean, sourceSentence: string): string

- Defined in doggo-translator-ts/doggo-translator-ts.ts:114
Parameters
- suffixes: object
  - [key: string]: string
- reverse: boolean
- sourceSentence: string
Returns string

Private replaceWholeWords

replaceWholeWords(words: object, reverse: boolean, sourceSentence: string): string

- Defined in doggo-translator-ts/doggo-translator-ts.ts:96
Parameters
- words: object
  - [key: string]: string
- reverse: boolean
- sourceSentence: string
Returns string

setLanguage

setLanguage(languageToken: LANGUAGE_TOKENS_ENUM): void

- Defined in doggo-translator-ts/doggo-translator-ts.ts:62
Given a language token, will attempt to set the current language.

Parameters
- languageToken: LANGUAGE_TOKENS_ENUM
  
  the language token
Returns void

Private setUpTranslator

setUpTranslator(config: DoggoTranslatorConfig): void

- Defined in doggo-translator-ts/doggo-translator-ts.ts:80
Parameters
- config: DoggoTranslatorConfig
Returns void

Private transformSuffixes

transformSuffixes(input: string, regex: string, replace: string): string

- Defined in doggo-translator-ts/doggo-translator-ts.ts:154
Parameters
- input: string
- regex: string
- replace: string
Returns string

translateSentence

translateSentence(sourceSentence: string, reverse?: boolean): string

- Defined in doggo-translator-ts/doggo-translator-ts.ts:33
Parameters
- sourceSentence: string
  
  Sentence in the sourceLanguage
- Default value reverse: boolean = false
  
  boolean to control direction of translation (e.g. true = sourceLanguage => doggo, false = doggo => sourceLanguage)
Returns string

Private translateWholeWord

translateWholeWord(input: string, regex: string, replace: string): string

- Defined in doggo-translator-ts/doggo-translator-ts.ts:138
Replaces a part from the input and tries to format it with the proper case.

Parameters
- input: string
  
  The complete input
- regex: string
- replace: string
  
  The word or sentence to replace the found word or sentence
Returns string

Generated using TypeDoc