# i18next-subliminal

> This package helps to pass meta information via invisible characters for the shown translation resources.

Latest version **1.0.1** (published 2025-03-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install i18next-subliminal
pnpm add i18next-subliminal
yarn add i18next-subliminal
bun add i18next-subliminal
```

## Health

**Score 50/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2025-03-28 |
| First published | 2023-10-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 45.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | adrai, jamuhl |
| Keywords | i18next, i18next-backend, i18next-post-processor |

## Links

- npm: https://www.npmjs.com/package/i18next-subliminal
- Repository: https://github.com/i18next/i18next-subliminal
- Issues: https://github.com/i18next/i18next-subliminal/issues
- npm.io page: https://npm.io/package/i18next-subliminal

## Dependencies (1)

- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.27.0

## Alternatives

- [messageformat](https://npm.io/package/messageformat.md) — 329.7K weekly downloads
- [@mintlify/scraping](https://npm.io/package/@mintlify/scraping.md) — 294.8K weekly downloads
- [@mintlify/previewing](https://npm.io/package/@mintlify/previewing.md) — 209.5K weekly downloads
- [@mintlify/prebuild](https://npm.io/package/@mintlify/prebuild.md) — 209.5K weekly downloads
- [@mintlify/link-rot](https://npm.io/package/@mintlify/link-rot.md) — 206.3K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2025-03-28
- 1.0.0 — 2023-11-21
- 0.0.4 — 2023-11-10
- 0.0.3 — 2023-10-28
- 0.0.2 — 2023-10-28
- 0.0.1 — 2023-10-17

## README

# Introduction

[![Actions](https://github.com/i18next/i18next-subliminal/workflows/node/badge.svg)](https://github.com/i18next/i18next-subliminal/actions?query=workflow%3Anode)
[![npm version](https://img.shields.io/npm/v/i18next-subliminal.svg?style=flat-square)](https://www.npmjs.com/package/i18next-subliminal)

This package helps to pass meta information via invisible characters for the shown translation resources.

# Getting started

Source can be loaded via [npm](https://www.npmjs.com/package/i18next-subliminal).

```bash
# npm package
$ npm install i18next-subliminal
```

## Wiring up as i18next plugin:

```js
import i18next from 'i18next'
import { PostProcessor } from 'i18next-subliminal'

i18next.use(PostProcessor).init({
  postProcess: 'subliminal',
  postProcessPassResolved: true,
})
```

## standalone usage:

```js
import { wrap, unwrap, containsHiddenMeta } from 'i18next-subliminal'

const wrapped = wrap('my text', { key: 'my.key', ns: 'my-ns', lng: 'en', source: 'translation' })

const unwrapped = unwrap(wrapped)
unwrapped.text // 'my text'
unwrapped.invisibleMeta // { key: 'my.key', ns: 'my-ns', lng: 'en', source: 'translation' }

containsHiddenMeta(wrapped) // true
```

---

<h3 align="center">Gold Sponsors</h3>

<p align="center">
  <a href="https://locize.com/" target="_blank">
    <img src="https://raw.githubusercontent.com/i18next/i18next/master/assets/locize_sponsor_240.gif" width="240px">
  </a>
</p>

---

**From the creators of i18next: localization as a service - locize.com**

A translation management system built around the i18next ecosystem - [locize.com](https://locize.com).

![locize](https://locize.com/img/ads/github_locize.png)

With using [locize](http://locize.com/?utm_source=react_i18next_readme&utm_medium=github) you directly support the future of i18next.

---

---
_Source: https://npm.io/package/i18next-subliminal · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._