# node-gettext

**Repository Path**: mirrors_Dexus/node-gettext

## Basic Information

- **Project Name**: node-gettext
- **Description**: Gettext module For Node.JS to use .MO and .PO files
- **Primary Language**: Unknown
- **License**: MIT-0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2026-04-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# node-gettext

[![Greenkeeper badge](https://badges.greenkeeper.io/Dexus/node-gettext.svg)](https://greenkeeper.io/)

[![Build Status](https://secure.travis-ci.org/alexanderwallin/node-gettext.png)](http://travis-ci.org/alexanderwallin/node-gettext)
[![npm version](https://badge.fury.io/js/node-gettext.svg)](https://badge.fury.io/js/node-gettext)

**node-gettext** is a Node.JS module to use .MO and .PO files.

**NB!** If you just want to parse or compile mo/po files, check out [gettext-parser](https://github.com/andris9/gettext-parser).

## Features

  * Load binary *MO* or source *PO* files
  * Supports contexts and plurals

## Installation

```sh
npm install node-gettext
```

## Usage

### Create a new Gettext object

```js
var Gettext = require("node-gettext");

var gt = new Gettext();

// or
var config = {
	locale: de_DE,
	domain: 'message',
	localeDir: './locale',
	localeDirStyle: 'GETTEXT',
}
var gt = new Gettext(config);
```

### Add a language

*loadTextdomainDirectory(domain, directory, directoryStyle)*

Load from a *MO* file

```js
var config = {
	locale: de_DE,
	domain: 'message',
	localeDir: './locale',
	localeDirStyle: 'GETTEXT',
}
var gt = new Gettext(config);
gt.loadTextdomainDirectory();
// loads ./locale/de_DE/LC_MESSAGES/message.mo or ./locale/de/LC_MESSAGES/message.mo
```

```js
var config = {
	locale: de_DE,
	domain: 'message',
	localeDir: './locale',
	localeDirStyle: 'NONGNU',
}
var gt = new Gettext(config);
gt.loadTextdomainDirectory();
// loads ./locale/de_DE/message.mo or ./locale/de/message.mo
```

```js
var config = {
	locale: de_DE,
	domain: 'message',
	localeDir: './locale',
	localeDirStyle: 'GNU',
}
var gt = new Gettext(config);
gt.loadTextdomainDirectory();
// loads ./locale/de_DE.mo or ./locale/de.mo
```

OR without Gettext Config

```js
var gt = new Gettext();
gt.setlocale('de_DE');
var fileDirectory = './locale/message/';
gt.loadTextdomainDirectory("message", fileDirectory);
// loads ./locale/message/de_DE.mo or ./locale/message/de.mo
```

```js
var gt = new Gettext();
gt.setlocale('de_DE');
var fileDirectory = './locale/message/';
gt.loadTextdomainDirectory("message", fileDirectory, 'GNU');
// loads ./locale/message/de_DE.mo or ./locale/message/de.mo
```

```js
var gt = new Gettext();
gt.setlocale('de_DE');
var fileDirectory = './locale/';
gt.loadTextdomainDirectory("message", fileDirectory, 'NONGNU');
// loads ./locale/de_DE/message.mo or ./locale/de/message.mo
```

```js
var gt = new Gettext();
gt.setlocale('de_DE');
var fileDirectory = './locale/';
gt.loadTextdomainDirectory("message", fileDirectory, 'GETTEXT');
// loads ./locale/de_DE/LC_MESSAGES/message.mo or ./locale/de/LC_MESSAGES/message.mo
```

Plural rules are automatically detected from the language code


### Change options after init

*setOptions(options)*

Sets the options for the gettext functions.


```js
var config = {
	locale: de_DE,
	domain: 'message',
	localeDir: './locale',
	localeDirStyle: 'GETTEXT',
	nonExistingStringCallback: function(locale, domain, msgctxt, msgid) {
    	console.warn('Missing Translation: locale ('+locale+'), domain ('+domain+'), msgctxt ('+msgctxt+'), msgid ('+msgid+')');
    },
};
gt.setOptions(config);
```

### Add a language

*addTextdomain(domain, file)*

Language data needs to be in the Buffer format - it can be either contents of a *MO* or *PO* file.

*addTextdomain(domain[, fileContents])*

Load from a *MO* file

```js
var fileContents = fs.readFileSync("et.mo");
gt.addTextdomain("message", fileContents);
```

or load from a *PO* file

```js
var fileContents = fs.readFileSync("et.po");
gt.addTextdomain("message", fileContents);
```

Plural rules are automatically detected from the language code

```js
gt.addTextdomain("message");
gt.setTranslation("message", false, "hello!", "tere!");
```

### Check or change default locale

*setlocale(locale)*

```js
gt.setlocale("de");
```

Unlike the C interface, this function does not return the current locale value. This might change in the future.

*getlocale()*

```js
var curlang = gt.getlocale();
```

The function also returns the current locale value

### Check or change default domain

*textdomain(domain)*

```js
gt.textdomain("message");
```

The function also returns the current texdomain value

```js
var curlang = gt.textdomain();
```

## Translation methods

### Load a string from default language file

*gettext(msgid)*

```js
var greeting = gt.gettext("Hello!");
```

### Load a string from a specific language file

*dgettext(domain, msgid)*

```js
var greeting = gt.dgettext("message", "Hello!");
```

### Load a plural string from default language file

*ngettext(msgid, msgid_plural, count)*

```js
gt.ngettext("%d Comment", "%d Comments", 10);
```

### Load a plural string from a specific language file

*dngettext(domain, msgid, msgid_plural, count)*

```js
gt.dngettext("message", "%d Comment", "%d Comments", 10);
```

### Load a string of a specific context

*pgettext(msgctxt, msgid)*

```js
gt.pgettext("menu items", "File");
```

### Load a string of a specific context from specific language file

*dpgettext(domain, msgctxt, msgid)*

```js
gt.dpgettext("message", "menu items", "File");
```

### Load a plural string of a specific context

*npgettext(msgctxt, msgid, msgid_plural, count)*

```js
gt.npgettext("menu items", "%d Recent File", "%d Recent Files", 3);
```

### Load a plural string of a specific context from specific language file

*dnpgettext(domain, msgctxt, msgid, msgid_plural, count)*

```js
gt.dnpgettext("message", "menu items", "%d Recent File", "%d Recent Files", 3);
```

### Get comments for a translation (if loaded from PO)

*getComment(domain, msgctxt, msgid)*

```js
gt.getComment("message", "menu items", "%d Recent File");
```

Returns an object in the form of `{translator: "", extracted: "", reference: "", flag: "", previous: ""}`

## Advanced handling

If you need the translation object for a domain, for example `message`, you can access it from `gt.domains.message`.

If you want modify it and compile it to *mo* or *po*, checkout [gettext-parser](https://github.com/andris9/gettext-parser) module.

## License

MIT