Class TranslatorConnector

Translation connection interface.

Hierarchy (view full)

DataConnector<Language, Language, {
language: string;
}>
- TranslatorConnector

Implements

ITranslatorConnector

Index

Constructors

Properties

_serverSettings _translationsUrl

Methods

fetch list remove save

Constructors

constructor

new TranslatorConnector(translationsUrl?, serverSettings?): TranslatorConnector
Parameters
- translationsUrl: string = ''
- Optional serverSettings: ServerConnection.ISettings
Returns TranslatorConnector
Overrides DataConnector.constructor
- Defined in translation/src/tokens.ts:35

Properties

`Private` _serverSettings

_serverSettings: undefined | ServerConnection.ISettings

`Private` _translationsUrl

_translationsUrl: string

Methods

fetch

fetch(opts): Promise<Language>
Retrieve an item from the data connector.
Parameters
- opts: {
  language: string;
  }
  The identifier used to retrieve an item.
  - language: string
Returns Promise<Language>
A promise that bears a data payload if available.

Notes
The promise returned by this method may be rejected if an error occurs in retrieving the data. Nonexistence of an id resolves with undefined.
Implementation of ITranslatorConnector.fetch
Overrides DataConnector.fetch
- Defined in translation/src/tokens.ts:44

list

list(query?): Promise<{
    ids: {
        language: string;
    }[];
    values: Language[];
}>
Retrieve the list of items available from the data connector.
Parameters
- Optional query: string
  The optional query filter to apply to the connector request.
Returns Promise<{
    ids: {
        language: string;
    }[];
    values: Language[];
}>
A promise that always rejects with an error.

Notes
Subclasses should reimplement if they support a back-end that can list.
Implementation of ITranslatorConnector.list
Inherited from DataConnector.list
- Defined in statedb/lib/dataconnector.d.ts:47

remove

remove(id): Promise<any>
Remove a value using the data connector.
Parameters
- id: {
  language: string;
  }
  The identifier for the data being removed.
  - language: string
Returns Promise<any>
A promise that always rejects with an error.

Notes
Subclasses should reimplement if they support a back-end that can remove.
Implementation of ITranslatorConnector.remove
Inherited from DataConnector.remove
- Defined in statedb/lib/dataconnector.d.ts:61

save

save(id, value): Promise<any>
Save a value using the data connector.
Parameters
- id: {
  language: string;
  }
  The identifier for the data being saved.
  - language: string
- value: Language
  The data being saved.
Returns Promise<any>
A promise that always rejects with an error.

Notes
Subclasses should reimplement if they support a back-end that can save.
Implementation of ITranslatorConnector.save
Inherited from DataConnector.save
- Defined in statedb/lib/dataconnector.d.ts:74