mirror of
https://github.com/xxnuo/MTranServer.git
synced 2026-05-08 14:36:07 +08:00
53 lines
1.2 KiB
Markdown
53 lines
1.2 KiB
Markdown
# MTranServer Usage Examples
|
|
|
|
This directory contains examples of how to use `mtranserver` programmatically in your Node.js/Bun applications.
|
|
|
|
## Prerequisites
|
|
|
|
Ensure you have installed the library:
|
|
|
|
```bash
|
|
bun install mtranserver@latest
|
|
```
|
|
|
|
## Running the Example
|
|
|
|
You can run the example using `bun`:
|
|
|
|
```bash
|
|
bun example/usage.ts
|
|
```
|
|
|
|
## Code Explanation
|
|
|
|
The key component is the `MTran` class:
|
|
|
|
```typescript
|
|
import { MTran } from 'mtranserver';
|
|
|
|
// 1. Create instance
|
|
const mtran = new MTran({
|
|
modelDir: './models' // Directory to store translation models
|
|
});
|
|
|
|
// 2. Initialize
|
|
await mtran.init();
|
|
|
|
// 3. Translate
|
|
const result = await mtran.translate('en', 'es', 'Hello world');
|
|
console.log(result); // "Hola mundo"
|
|
|
|
// 4. Cleanup
|
|
await mtran.close();
|
|
```
|
|
|
|
## Configuration
|
|
|
|
The `MTran` constructor accepts a config object with the following optional properties:
|
|
|
|
- `modelDir`: Path to store downloaded models.
|
|
- `configDir`: Path to store configuration files (like `records.json`).
|
|
- `logLevel`: Logging verbosity ('debug', 'info', 'warn', 'error').
|
|
- `workersPerLanguage`: Number of parallel workers for translation.
|
|
- `enableOfflineMode`: If true, disables auto-downloading of models.
|