Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/appfeel/i18n-mongo
i18n integrated with mongoose to translate mongodb objects
https://github.com/appfeel/i18n-mongo
i18n i18n-node i18n-router language mongodb mongoose node-module
Last synced: 6 days ago
JSON representation
i18n integrated with mongoose to translate mongodb objects
- Host: GitHub
- URL: https://github.com/appfeel/i18n-mongo
- Owner: appfeel
- License: other
- Created: 2017-02-22T12:57:52.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T17:59:46.000Z (almost 2 years ago)
- Last Synced: 2024-12-05T19:49:17.521Z (21 days ago)
- Topics: i18n, i18n-node, i18n-router, language, mongodb, mongoose, node-module
- Language: JavaScript
- Size: 1.46 MB
- Stars: 5
- Watchers: 4
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
i18n-mongo
==========
This README document is under construction
[](https://npmjs.org/package/i18n-mongo)
[](https://npmjs.org/package/i18n-mongo)
[](https://travis-ci.org/appfeel/i18n-mongo)
[](https://coveralls.io/github/appfeel/i18n-mongo)
## Install me
```
$ npm i i18n-mongo --save
```
## How to use it
To create a translatable schema, you can use `localizableModel`:
**server.js**
```js
import express from 'express';
import http from 'http';
import { i18nMongo } from 'i18n-mongo';
const mongodbUrl = 'mongodb://localhost:27017/my-db';
const user = '';
const pass = '';
mongoose.connect(mongodbUrl, { user, pass }, (err) => {
mongoose.Promise = q.Promise;
const app = express();
app.use(i18nMongo());
http.createServer(app).listen(3000);
});
```
**mycollection.js**:
```js
import { localizableModel, Localized } from 'i18n-mongo';
const Schema = mongoose.Schema;
const mycollection = new Schema({
translatableString: Localized
someObject: {
translatableObjString: Localized
}
});
export const MyModel = localizableModel('mycollection', mycollection);
```
**router.js**:
```js
import express from 'express';
import mongoose from 'mongoose';
import { createRouter } from 'i18n-mongo';
import { MyModel } from './mycollection';
const app = express();
const mw = i18nMongo({
logger: console, // Optional
email: { // Optional
transport: nodemailer.createTransport(...),
from: '[email protected]',
to: '[email protected]',
},
defaultLanguage: '--', // Optional, strings in defaultLanguage will not be inserted
}, (err) => {
console.log('Available languages loaded and i18n is ready to be used');
});
app.use(mw);
const router = createRouter(new express.Router(), { auth });
app.use('/lang', router);
router.get('/mycollection', (req, res) => {
MyModel.findLocalized({}, req.lang)
.then(res.json.bind(res))
.catch(err => res.status(500).send(err));
});
router.get('/mycollection/:_id', (req, res) => {
MyModel.findLocalized({ _id: req.params._id }, req.lang)
.then(docs => ((docs && docs.length) ? res.json(doc[0]) : res.status(404).end())
.catch(err => res.status(500).send(err));
});
router.post('/mycollection', async (req, res) => {
MyModel.saveLocalized(req.body)
.then((savedDoc) => {
const uri = `/mycollection/${savedDoc._id}`;
res.setHeader('Location', uri); // res.location(uri);
res.status(201).send(uri);
})
.catch(err => res.status(500).send(err));
});
router.put('/mycollection/:_id', async (req, res) => {
MyModel.saveLocalized(req.body, req.params._id)
.then(() => res.status(204).end())
.catch(err => res.status(500).send(err));
});
router.delete('/mycollection/:_id', async (req, res) => {
MyModel.findOne({ _id: req.params._id }).exec()
then((doc) => {
if (doc) {
doc.remove();
res.status(204).end()
} else {
res.status(404).end()
}
})
.catch(err => res.status(500).send(err));
});
router.get('/admin/mycollection', async (req, res) => {
MyModel.findLocalized({}, '')
.then(res.json.bind(res))
.catch(err => res.status(500).send(err));
});
```
When requesting `GET /mycollection/IDHERE?lang=en` it will return the collection populated:
```json
{
"translatableString": "The value for 'en' language",
"someObject": {
"translatableObjString": "Other string for 'en' language"
}
}
```
When requesting `GET /admin/mycollection?lang=en`, the language will be ignored (as defined in router example) and it will return all languages:
```json
{
"translatableString": {
"en": "The value for 'en' language",
"ca": "El valor traduït al 'ca'"
},
"someObject": {
"translatableObjString": {
"en": "Other string for 'en' language",
"ca": "Una altra string en 'ca'",
}
}
```