https://github.com/liby/bob-translate-types
Type definitions for Bob translate.
https://github.com/liby/bob-translate-types
Last synced: over 1 year ago
JSON representation
Type definitions for Bob translate.
- Host: GitHub
- URL: https://github.com/liby/bob-translate-types
- Owner: liby
- License: mit
- Created: 2024-08-09T09:32:10.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-09T13:33:14.000Z (almost 2 years ago)
- Last Synced: 2025-03-10T14:56:38.956Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@bob-translate/types
- Size: 10.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @bob-translate/types
Type definitions for [Bob translate](https://bobtranslate.com/plugin/api/intro.html).
## Installation
```bash
npm install --save-dev @bob-translate/types
```
## TypeScript Configuration
To ensure TypeScript correctly recognizes the types from `@bob-translate/types`, you may need to add it to your _tsconfig.json_:
```json
{
"compilerOptions": {
"types": ["@bob-translate/types"]
}
}
```
This step is necessary if TypeScript doesn’t automatically include the types from this package.
## Usage
```ts
// main.ts
import { PluginValidate } from '@bob-translate/types';
const pluginValidate: PluginValidate = (completion) => {
// do something
}
```