bbc/simorgh

# psammead-detokeniser - [![Known Vulnerabilities](https://snyk.io/test/github/bbc/psammead/badge.svg?targetFile=packages%2Fcomponents%2Fpsammead-detokeniser%2Fpackage.json)](https://snyk.io/test/github/bbc/psammead?targetFile=packages%2Fcomponents%2Fpsammead-detokeniser%2Fpackage.json) [![Dependency Status](https://david-dm.org/bbc/psammead.svg?path=packages/components/psammead-detokeniser)](https://david-dm.org/bbc/psammead?path=packages/components/psammead-detokeniser) [![peerDependencies Status](https://david-dm.org/bbc/psammead/peer-status.svg?path=packages/components/psammead-detokeniser)](https://david-dm.org/bbc/psammead?path=packages/components/psammead-detokeniser&type=peer) [![Storybook](https://raw.githubusercontent.com/storybooks/brand/master/badge/badge-storybook.svg?sanitize=true)](https://bbc.github.io/psammead/?path=/story/detokeniser--containing-image) [![GitHub license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/bbc/psammead/blob/latest/LICENSE) [![npm version](https://img.shields.io/npm/v/#legacy/psammead-detokeniser/src.svg)](https://www.npmjs.com/package/#legacy/psammead-detokeniser/src) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/bbc/psammead/blob/latest/CONTRIBUTING.md)

## Description

The `detokeniser` utility operates on strings and replaces % delimited tokens with a value from the dictionary object.

## Installation

```jsx
npm install #legacy/psammead-detokeniser/src --save
```

## Props

| Argument   | Type   | Required | Default | Example                |
| ---------- | ------ | -------- | ------- | ---------------------- |
| text       | string | yes      | N/A     | `'Foo %token%'`        |
| dictionary | object | yes      | N/A     | { `'%token%': 'Bar'` } |

`dictionary` is an object which maps keys as tokens to values. For example, in `psammead-social-embeds`, all social media providers in the data are in lowercase which corresponds as the token to be interpolated into the full name.
E.g. `'%youtube%' -> 'YouTube'`

## Usage

```
import detokenise from "#legacy/psammead-detokeniser/src"

// This will return 'Duration: 20 minutes'
detokenise('Duration: %token%', { '%token%': '20 minutes' });

```

### When to use this utility

<!-- Description of the where the utility can be used -->

### When not to use this utility

<!-- Description of the where the utility shouldn't can be used -->

### Accessibility notes

<!-- Information about accessibility for this utility -->

### Roadmap

<!-- Known future changes of the utility -->

## Contributing

Psammead is completely open source. We are grateful for any contributions, whether they be new utilities, bug fixes or general improvements. Please see our primary contributing guide which can be found at [the root of the Psammead repository](https://github.com/bbc/psammead/blob/latest/CONTRIBUTING.md).

### [Code of Conduct](https://github.com/bbc/psammead/blob/latest/CODE_OF_CONDUCT.md)

We welcome feedback and help on this work. By participating in this project, you agree to abide by the [code of conduct](https://github.com/bbc/psammead/blob/latest/CODE_OF_CONDUCT.md). Please take a moment to read it.

### License

Psammead is [Apache 2.0 licensed](https://github.com/bbc/psammead/blob/latest/LICENSE).