@runium/types-plugin

TypeScript type definitions for Runium plugin development.

Installation

npm install --save-dev @runium/types-plugin

or

yarn add -D @runium/types-plugin

Usage

Add to your tsconfig.json:

{
  "compilerOptions": {
    "types": [
      "@runium/types-plugin"
    ]
  }
}

Then use the types in your plugin:

const plugin: Runium.Plugin = {
    name: 'my-plugin',

    project: {
        macros: {
            MY_MACRO: 'value'
        },
        tasks: {},
        triggers: {},
        actions: {}
    },

    hooks: {
        app: {
            async afterInit({profilePath}) {
                runium.output.info('Plugin initialized');
            }
        }
    }
};

export default plugin;

License

MIT