Origami Frontend Components & Services

JSDoc: o-author-alerts

o-author-alerts has a support status of "dead". This means that there are no plans to fix any issues with this component, and it may stop working at any point. More information on the status of this component is available in the README. If you still rely on this component or have concerns, please contact the Origami team.

Config

Global Function

Config class which can be instantiated. It will create an isolated set of configuration options. It can be extended and read.

Returns

  • undefined

Links

get(param)

Global Function

Read the current configuration or a configuration entry

parameter type default description
param string Optional. Entry key of the configuration object. If specified, only the value of the entry is returned.

Returns

  • string | object - Either the value of the key specified or the whole object.

Links

set(keyOrObject, value)

Global Function

Extends the current configuration.

parameter type default description
keyOrObject string | object If a key is specified, then the next parameter (value) will be merged into the current config object. If an object is specified, then the object will be merged into the current config object.
value

Returns

  • undefined

Links

jsonp(options, callback)

Global Function

The actual function which does the jsonp.

parameter type default description
options object Several configuration options (e.g. url, data)
callback function function (err, data)

Returns

  • undefined

Links

param(data)

Global Function

Data object transformation into query string.

parameter type default description
data object Object to be transformed into a query string.

Returns

  • string - Query string.

Links

scriptLoader(options, callback)

Global Function

The actual function which does the script loading.

parameter type default description
options object Several configuration options (e.g. url)
callback function function (err)

Returns

  • undefined

Links

merge(destination, source)

Global Function

Merges two or more objects into a single object. It either overrides if the key is the same, or appends to the existing object. The first parameter is the destination, all the other parameters are the sources. The level of importance increases starting from the destination to the last source (the last source will be the most important).

parameter type default description
destination object The object to which the source objects will be merged
source object Any number of further arguments which are sources and will be merged to the destination.

Returns

  • object - The modified destination object with the sources merged in.

Links

Config~config

Inner Property

Type

  • Object

Local object of the configuration.

Links

Status
dead Origami v1 (Bower)
Switch component view

GitHub: o-author-alerts

Install o-author-alerts

If using the Build Service, add o-author-alerts@^4.2.6 to your script and link tags.

If using the npm package manager for a Manual Build, run npm install --save-peer "@financial-times/o-author-alerts@^4.2.6".

Help & Support

o-author-alerts is maintained directly by the Origami team. If you have any questions about o-author-alerts or Origami in general, we are happy to help. 😊

Slack: #ft-origami
Email: origami.support@ft.com

Feedback / Issues

To report a bug or request features please create an issue on Github. For support or general feedback please get in touch 😊

Slack: #ft-origami
Email: origami.support@ft.com