Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #4

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update docs #4

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
38cf291
replaces require with import
erikyo May 2, 2024
49b4c8d
installation instructions
erikyo May 2, 2024
07c29d8
Update README.md
erikyo May 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 25 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,16 @@ Parse and compile gettext *po* and *mo* files with node.js, nothing more, nothin

> *Please note:* starting with version 3 only latest LTS and latest stable node versions are supported. **Use version 2 with older node versions.**

## Installation
To install the library, run the following command:

npm install gettext-parser --save

## Usage

Include the library:

var gettextParser = require("gettext-parser");
import gettextParser from "gettext-parser";

### Parse PO files

Expand All @@ -34,9 +39,15 @@ Method returns gettext-parser specific translation object (see below)
**Example**

```javascript
var input = require('fs').readFileSync('en.po');
var po = gettextParser.po.parse(input);
console.log(po.translations['']); // output translations for the default context
import fs from "node:fs";
import gettextParser from "gettext-parser";

const input = await fs
.readFile("en.po")
// read the PO file
.then((buf) => gettextParser.po.parse(buf))
// output translations for the default context
.then((translations) => console.log(translations));
```

### Parse PO as a Stream
Expand All @@ -53,10 +64,13 @@ Where
**Example**

```javascript
var input = require('fs').createReadStream('en.po');
var po = gettextParser.po.createParseStream();
input.pipe(po);
po.on('data', function(data){
import fs from "node:fs";
import gettextParser from "../index.js";

const input = fs.createReadStream("en.po");
const stream = input.pipe(gettextParser.po.createParseStream());

stream.on('data', function(data){
console.log(data.translations['']); // output translations for the default context
});
```
Expand All @@ -83,7 +97,7 @@ var data = {
...
};
var output = gettextParser.po.compile(data);
require('fs').writeFileSync('filename.po', output);
fs.writeFileSync('filename.po', output);
```

###
Expand All @@ -104,7 +118,7 @@ Method returns gettext-parser specific translation object (see below)
**Example**

```javascript
var input = require('fs').readFileSync('en.mo');
var input = fs.readFileSync('en.mo');
var mo = gettextParser.mo.parse(input);
console.log(mo.translations['']); // output translations for the default context
```
Expand All @@ -126,7 +140,7 @@ var data = {
...
};
var output = gettextParser.mo.compile(data);
require('fs').writeFileSync('filename.mo', output);
fs.writeFileSync('filename.mo', output);
```

### Notes
Expand Down