# @financial-times/n-content-decorator

> Decorates FT content prior to rendering

Latest version **1.0.5** (published 2016-11-01) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @financial-times/n-content-decorator
pnpm add @financial-times/n-content-decorator
yarn add @financial-times/n-content-decorator
bun add @financial-times/n-content-decorator
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2016-11-01 |
| First published | 2016-09-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | financial-times |

## Links

- npm: https://www.npmjs.com/package/@financial-times/n-content-decorator
- Repository: https://github.com/Financial-Times/n-content-decorator
- Homepage: https://github.com/Financial-Times/n-content-decorator#readme
- Issues: https://github.com/Financial-Times/n-content-decorator/issues
- npm.io page: https://npm.io/package/@financial-times/n-content-decorator

## Dependencies (1)

- [ft-n-article-branding](https://npm.io/package/ft-n-article-branding.md) ^3.0.6

## Recent versions

- 1.0.5 (latest) — 2016-11-01
- 1.0.4 — 2016-10-26
- 1.0.3 — 2016-10-20
- 1.0.2 — 2016-09-19
- 1.0.1 — 2016-09-19
- 1.0.0 — 2016-09-15

## README

[![Coverage Status](https://coveralls.io/repos/github/Financial-Times/n-content-decorator/badge.svg?branch=master)](https://coveralls.io/github/Financial-Times/n-content-decorator?branch=master)

#n-content-decorator

Provides decoration for content sourced either directly from the next Elastic Search cluster, or via the next-graphql-api, for compatibility for rendering content cards.

##Options supported;

###Decoration type

`mutateOriginal: true` will mutate the object passed to it.

`mutateOriginal: false` will return the decoration object, which can be merged in with the original object by the calling application (eg. `Object.assign(original, decoration)``).

`false` is the default option and need not be passed in.

###Excluded Taxonomies

`excludeTaxonomies: true` prevents specific taxonomies (organisations, regions, people) from appearing in the tag that is returned.

`excludeTaxonomies: false` leaves taxonomies unaffected.

`false` is the default and need not be passed in.

###Minor Branding

Determines how brand (if content is associated with a brand) is displayed.

`minorBranding: true` brand appears below standfirst and primary Tag is shown eg. as on stream list.

`minorBranding: false` brand replaces primary Tag at the top of the card.

`false` is the default option and need not be passed in.

(NOTE: the intention is to migrate this display option to n-card rather than handle it here)

##Example usage

###With an array of content items

####With `mutateOriginal: false`

```
const decoration = require('ft-n-content-decoration');

contentArray.map(content => Object.assign(content, decoration(content, {options})));

```

####With `mutateOriginal: true`

```
const decorateContent = require('ft-n-content-decoration');

contentArray.map(content => decorateContent(content, {options}));

```

---
_Source: https://npm.io/package/@financial-times/n-content-decorator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
