Merge pull request #757 from HaveAGitGat/custom_func

Add example info to Custom JS Function

FlowPlugins/CommunityFlowPlugins/tools/customFunction/1.0.0/index.js

@@ -1,4 +1,5 @@
 "use strict";
+/* eslint-disable max-len */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -57,7 +58,7 @@ var details = function () { return ({
             label: 'JS Code',
             name: 'code',
             type: 'string',
-            defaultValue: "\nmodule.exports = async (args) => {\n\n// do something here\n\n  return {\n    outputFileObj: args.inputFileObj,\n    outputNumber: 1,\n    variables: args.variables,\n  };\n}\n      ",
+            defaultValue: "\nmodule.exports = async (args) => {\n\n// see args object data here https://github.com/HaveAGitGat/Tdarr_Plugins/blob/master/FlowPluginsTs/FlowHelpers/1.0.0/interfaces/interfaces.ts\n// example setting flow variable: https://github.com/HaveAGitGat/Tdarr/issues/1147#issuecomment-2593348443\n// example reading ffmpeg metadata: https://github.com/HaveAGitGat/Tdarr_Plugins/issues/737#issuecomment-2581536112\n\n// some example file data:\nconsole.log(args.inputFileObj._id)\nconsole.log(args.inputFileObj.file_size)\nconsole.log(args.inputFileObj.ffProbeData.streams[0].codec_name)\nconsole.log(args.inputFileObj.mediaInfo.track[0].BitRate)\n\n// access global variable:\nconsole.log(args.userVariables.global.test)\n// access library variable:\nconsole.log(args.userVariables.library.test)\n\n\n\n// do something here\n\n  return {\n    outputFileObj: args.inputFileObj,\n    outputNumber: 1,\n    variables: args.variables,\n  };\n}\n      ",
             inputUI: {
                 type: 'textarea',
                 style: {

FlowPluginsTs/CommunityFlowPlugins/tools/customFunction/1.0.0/index.ts

@@ -1,3 +1,5 @@
+/* eslint-disable max-len */
+
 import { promises as fsp } from 'fs';
 import { getPluginWorkDir } from '../../../../FlowHelpers/1.0.0/fileUtils';
 import {
@@ -27,6 +29,23 @@ const details = (): IpluginDetails => ({
       defaultValue: `
 module.exports = async (args) => {
 
+// see args object data here https://github.com/HaveAGitGat/Tdarr_Plugins/blob/master/FlowPluginsTs/FlowHelpers/1.0.0/interfaces/interfaces.ts
+// example setting flow variable: https://github.com/HaveAGitGat/Tdarr/issues/1147#issuecomment-2593348443
+// example reading ffmpeg metadata: https://github.com/HaveAGitGat/Tdarr_Plugins/issues/737#issuecomment-2581536112
+
+// some example file data:
+console.log(args.inputFileObj._id)
+console.log(args.inputFileObj.file_size)
+console.log(args.inputFileObj.ffProbeData.streams[0].codec_name)
+console.log(args.inputFileObj.mediaInfo.track[0].BitRate)
+
+// access global variable:
+console.log(args.userVariables.global.test)
+// access library variable:
+console.log(args.userVariables.library.test)
+
+
+
 // do something here
 
   return {