Class PhraseyWatcher

constructor

• new PhraseyWatcher(options): PhraseyWatcher

• Parameters

  • options: PhraseyWatcherOptions

  Returns PhraseyWatcher

Optional configWatcher

listeners

Optional localesWatcher

options

phrasey

Optional schemaWatcher

state

Optional translationsWatcher

log

• get log(): PhraseyLogger

• Returns PhraseyLogger

destroy

• destroy(): Promise<void>

• Returns Promise<void>

dispatch

• dispatch(apply): Promise<void>

• Parameters

  • apply: ((listener) => Promise<void>)

    • • (listener): Promise<void>

      • Parameters

        • listener: Partial<PhraseyWatcherCompleteListener>

        Returns Promise<void>

  Returns Promise<void>

initialize

• initialize(): Promise<void>

• Returns Promise<void>

listen

• listen(listener): (() => void)

• Parameters

  • listener: Partial<PhraseyWatcherCompleteListener>

  Returns (() => void)

  • • (): void

    • Returns void

onConfigChange

• onConfigChange(): Promise<void>

• Returns Promise<void>

onError

• onError(error): Promise<void>

• Parameters

  • error: Error

  Returns Promise<void>

onLocalesChange

• onLocalesChange(): Promise<void>

• Returns Promise<void>

onSchemaChange

• onSchemaChange(): Promise<void>

• Returns Promise<void>

onTranslationChange

• onTranslationChange(path): Promise<void>

• Parameters

  • path: string

  Returns Promise<void>

onTranslationsChange

• onTranslationsChange(): Promise<void>

• Returns Promise<void>

unlisten

• unlisten(listener): void

• Parameters

  • listener: Partial<PhraseyWatcherCompleteListener>

  Returns void

updateConfig

• updateConfig(): Promise<void>

• Returns Promise<void>

updateLocales

• updateLocales(): Promise<void>

• Returns Promise<void>

updateSchema

• updateSchema(): Promise<void>

• Returns Promise<void>

updateTranslation

• updateTranslation(path): Promise<void>

• Parameters

  • path: string

  Returns Promise<void>

updateTranslations

• updateTranslations(): Promise<void>

• Returns Promise<void>

Static create

• create(options): Promise<PhraseyWatcher>

• Parameters

  • options: PhraseyWatcherOptions

  Returns Promise<PhraseyWatcher>

Static createWatcher

• createWatcher(path, listener): FSWatcher

• Parameters

  • path: string | string[]

  • listener: PhraseyChokidarWatcherListener

  Returns FSWatcher