https://github.com/zerebos/trilium-types
A @types package for Trilium Notes!
https://github.com/zerebos/trilium-types
Last synced: 9 months ago
JSON representation
A @types package for Trilium Notes!
- Host: GitHub
- URL: https://github.com/zerebos/trilium-types
- Owner: zerebos
- License: apache-2.0
- Created: 2023-08-21T05:02:56.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-12T22:48:57.000Z (about 2 years ago)
- Last Synced: 2025-04-06T01:19:51.637Z (over 1 year ago)
- Size: 96.7 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# trilium-types
A [TypeScript](https://www.typescriptlang.org/) `@types` package for [Trilium Notes](https://github.com/zadam/trilium).
## Installation
```sh
npm install @types/trilium@npm:trilium-types
```
## Usage
This package keeps up with the latest version of Trilium available, there is not existing table or mapping showing old version of this package that correspond to old version of Trilium.
### TypeScript
The Trilium frontend `api` will automatically be available in all files since working with the frontend is the most common use-case. You can easily override this with the backend api if needed:
```js
import {BackendAPI} from "trilium/backend";
declare const api: BackendAPI;
```
Otherwise, all the types should be available under `trilium/frontend`, `trilium/backend`, and `trilium/common`.
### JavaScript
Similarly to in TypeScript, your IDE (like VSCode) should automatically pick up `api` as the frontend. You can override this using JSDoc syntax. First, make sure your IDE and/or linter are setup to allow an `api` global, then you can do.
```js
/**
* @type {import("trilium/backend").BackendAPI}
*/
const api = api;
```
For other types, you can follow the same methodology and use the JSDoc syntax with `import`.
## Why?
Because it's nice to have autocompletion and type recognition whether you're using JS or TS.
### Why not [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped/)?
I chose not to try to push this to DefinitelyTyped because I'm still an amateur when it comes to TypeScript and writing custom type definitions. They tend to have a quality requirement that I don't think I would meet.
## Links
Check out my other Trilium-based projects:
- [Trilium Markdown Preview](https://github.com/rauenzi/Trilium-MarkdownPreview/)
- [Trilium Breadcrumbs](https://github.com/rauenzi/Trilium-Breadcrumbs)
Want more? Be sure to check out the [Awesome Trilium](https://github.com/Nriver/awesome-trilium) list!