[go: nahoru, domu]

Skip to content

Green-Software-Foundation/if-core

Repository files navigation

if-core

Here you can find all the necessary utilities for plugin development.

Installing

Run the command below in your project root:

npm install @grnsft/if-core

Usage

Note: For proper error handling, you have to use error classes from @grnsft/if-core/utils.

Here you can see usage example for plugin development:

import {ERRORS} from '@grnsft/if-core/utils';
import {PluginParams, CustomConfig} from '@grnsft/if-core/types';

const {ConfigError, MissingInputDataError} = ERRORS;

const CustomPlugin = (config: CustomConfig) => {
  // plugin related stuff here
  const validateConfig = () => {
    if (!config) {
      throw new ConfigError('My message here');
    }
  };

  const execute = (inputs: PluginParams[]) => {
    validateConfig();
    // plugin logic here
  };

  return {
    execute,
  };
};