Backup_Repos/stash
1
0
Fork 0
mirror of https://github.com/stashapp/stash.git synced 2025-12-29 11:45:56 +01:00
Code Issues Projects Releases Wiki Activity

Fix headings

Browse source
This commit is contained in:
DogmaDragon 2024-06-03 23:50:28 +03:00
parent c3bebd0c89
commit 7dbf315168
1 changed files with 13 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
ui/v2.5/src/docs/en/Manual/EmbeddedPlugins.md
View file

@ -6,19 +6,19 @@ Embedded plugin tasks are executed within the stash process using a scripting sy
Stash currently supports Javascript embedded plugin tasks using [goja](https://github.com/dop251/goja).
# Javascript plugins
## Javascript plugins
## Plugin input
### Plugin input
The input is provided to Javascript plugin tasks using the `input` global variable, and is an object based on the structure provided in the `Plugin input` section of the [Plugins](/help/Plugins.md) page. Note that the `server_connection` field should not be necessary in most embedded plugins.
## Plugin output
### Plugin output
The output of a Javascript plugin task is derived from the evaluated value of the script. The output should conform to the structure provided in the `Plugin output` section of the [Plugins](/help/Plugins.md) page.
There are a number of ways to return the plugin output:
### Example #1
#### Example #1
```
(function() {
return {
@ -27,7 +27,7 @@ There are a number of ways to return the plugin output:
})();
```
### Example #2
#### Example #2
```
function main() {
return {
@ -38,7 +38,7 @@ function main() {
main();
```
### Example #3
#### Example #3
```
var output = {
Output: "ok"
@ -51,20 +51,20 @@ output;
See the `Javascript API` section below on how to log with Javascript plugins.
# Plugin configuration file format
## Plugin configuration file format
## exec
### exec
For embedded plugins, the `exec` field is a list with the first element being the path to the Javascript file that will be executed. It is expected that the path to the Javascript file is relative to the directory of the plugin configuration file.
## interface
### interface
For embedded plugins, the `interface` field must be set to one of the following values:
* `js`
# Javascript API
## Javascript API
## Logging
### Logging
Stash provides the following API for logging in Javascript plugins:
@ -77,7 +77,7 @@ Stash provides the following API for logging in Javascript plugins:
| `log.Error(<string>)` | Log with the `error` log level. |
| `log.Progress(<float between 0 and 1>)` | Sets the progress of the plugin task, as a float, where `0` represents 0% and `1` represents 100%. |
## GQL
### GQL
Stash provides the following API for communicating with stash using the graphql interface:
@ -85,7 +85,7 @@ Stash provides the following API for communicating with stash using the graphql
|--------|-------------|
| `gql.Do(<query/mutation string>, <variables object>)` | Executes a graphql query/mutation on the stash server. Returns an object in the same way as a graphql query does. |
### Example
#### Example
```
// creates a tag