# gengojs-default-memory

> The default memory backend plugin for gengojs

Latest version **0.2.1** (published 2015-10-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install gengojs-default-memory
pnpm add gengojs-default-memory
yarn add gengojs-default-memory
bun add gengojs-default-memory
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2015-10-23 |
| First published | 2015-04-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Known vulnerabilities | 0 (+8 in 2 direct dependencies) |
| Install scripts | no |
| Author | iwatakeshi |
| Maintainers | iwatakeshi |
| Keywords | i18n, i10n, translate, gengo, gengojs, gengojs-plugin |

## Links

- npm: https://www.npmjs.com/package/gengojs-default-memory
- Repository: https://github.com/gengojs/plugin-backend
- Issues: https://github.com/gengojs/plugin-backend/issues
- npm.io page: https://npm.io/package/gengojs-default-memory

## Dependencies (7)

- [glob](https://npm.io/package/glob.md) ^5.0.15
- [toml](https://npm.io/package/toml.md) ^2.3.0
- [lodash](https://npm.io/package/lodash.md) ^3.10.1
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.4.3
- [read-json](https://npm.io/package/read-json.md) ^1.0.0
- [globwatcher](https://npm.io/package/globwatcher.md) ^1.4.0
- [gengojs-debug](https://npm.io/package/gengojs-debug.md) ^2.0.4

## Recent versions

- 0.2.1 (latest) — 2015-10-23
- 0.2.0 — 2015-10-21
- 0.1.4 — 2015-10-09
- 0.1.3 — 2015-10-07
- 0.1.2 — 2015-10-07
- 0.1.1 — 2015-10-02
- 0.1.0 — 2015-10-01
- 0.0.3 — 2015-08-23
- 0.0.2 — 2015-05-08
- 0.0.1 — 2015-05-07
- 0.0.1-beta.9 — 2015-04-22
- 0.0.1-beta.8 — 2015-04-19
- 0.0.1-beta.7 — 2015-04-19
- 0.0.1-beta.6 — 2015-04-12
- 0.0.1-beta.5 — 2015-04-09
- … 4 more at https://npm.io/package/gengojs-default-memory/versions

## README

# gengojs-default-memory

The default memory backend plugin for gengo.js.

[![Build Status](https://travis-ci.org/gengojs/plugin-backend.svg)](https://travis-ci.org/gengojs/plugin-backend)

This module will be used for [gengo.js](https://github.com/gengojs/gengojs).

## Documentation

See [documentation](https://gengojs.github.io/plugin-backend).

## Usage

An example usage with options is:

```js

var gengo = require('gengojs');
var backend = require('gengojs-default-memory');

/* In whatever framework you are using: */

// I'll use express for an example
// but it shouldn't matter

var app = require('express')();
app.use(gengo({
   // Specify the type
   // of option to modify
	backend:{
		/* options */
	}
},/*backend()*/));
```
The default backend is already included in gengojs so you should not have to require it.


## Options

```json
{
  "directory": "./locales",
  "extension": "json",
  "prefix": "",
  "cache": true
}
```

## Supported Extensions

The supported file types are:

* `.json`
* `.yaml`
* `.toml`
* `.js`


## Internal API

* `find(locale:String)`
  * Should return the dictionary by locale
* `catalog(locale:String)` 
  * Should return the dictionary by locale or the entire dictionary.

For more see [documentation](https://gengojs.github.io/plugin-backend)

## Dependencies

Not Applicable

## Debug

Unix:

```bash
DEBUG=gengo.backend
```
Windows:

```bash
SET DEBUG=gengo.backend
```

See [gengojs-debug](https://github.com/gengojs/gengojs-debug) for usage.

## Contribute

Feel free to contribute or even fork the project. This plugin has been
written in ES6 and can be seen under `lib/index.js`.

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