Class TranslatorConnector

Translation connection interface.

Hierarchy (View Summary)

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

Implements

ITranslatorConnector

Index

Constructors

constructor

Methods

fetch list remove save

Constructors

constructor

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

Methods

fetch

fetch(): Promise<ILanguageList>
Retrieve an item from the data connector.

Returns Promise<ILanguageList>
A promise that resolves with 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 will succeed with undefined.
Implementation of ITranslatorConnector.fetch
Overrides DataConnector.fetch
- Defined in translation/src/tokens.ts:131
fetch(opts: { language: string }): Promise<Language>
Retrieve an item from the data connector.
Parameters
- opts: { 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:132

list

list(
query?: string,
): Promise<
{ ids: (undefined | { language: string })[]; values: Language[] },
>
Retrieve the list of items available from the data connector.
Parameters
- Optionalquery: string
  The optional query filter to apply to the connector request.
Returns Promise<{ ids: (undefined | { 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: undefined | { language: string }): Promise<any>
Remove a value using the data connector.
Parameters
- id: undefined | { language: string }
  The identifier for the data being removed.
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: undefined | { language: string }, value: Language): Promise<any>
Save a value using the data connector.
Parameters
- id: undefined | { language: string }
  The identifier for the data being saved.
- 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

Class TranslatorConnector

Hierarchy (View Summary)

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns TranslatorConnector

Methods

fetch

Returns Promise<ILanguageList>

Notes

Parameters

Returns Promise<Language>

Notes

list

Parameters

Returns Promise<{ ids: (undefined | { language: string })[]; values: Language[] }>

Notes

remove

Parameters

Returns Promise<any>

Notes

save

Parameters

Returns Promise<any>

Notes

Settings

On This Page